cloudscale_ch.cloud.inventory 清单 – cloudscale.ch 清单源

注意

此清单插件是 cloudscale_ch.cloud 集合（版本 2.4.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cloudscale_ch.cloud。

要在 playbook 中使用它，请指定：cloudscale_ch.cloud.inventory。

概要

  • 从 cloudscale.ch API 获取清单主机

  • 使用以 cloudscale.yml 或 cloudscale.yaml 结尾的 YAML 配置文件来设置参数值（另请参阅示例）。

别名：cloudscale

参数

参数

注释

ansible_host

字符串

要注册为 ansible_host 的 IP 地址。如果请求的值不存在或设置为 ‘none’，则不会设置 ansible_host。

选项

  • "public_v4" ← (默认)

  • "public_v6"

  • "private"

  • "none"

api_token

字符串

cloudscale.ch API 令牌。

这也可以在 CLOUDSCALE_API_TOKEN 环境变量中传递。

compose

字典

从 jinja2 表达式创建变量。

默认值： {}

groups

字典

根据 Jinja2 条件将主机添加到组。

默认值： {}

inventory_hostname

字符串

要注册为清单主机名。如果设置为 ‘uuid’，将使用服务器的 uuid，并且将为服务器名称创建一个组。如果设置为 ‘name’，将使用服务器的名称，除非有多个服务器具有相同的名称，在这种情况下将使用 ‘uuid’ 逻辑。

选项

  • "name" ← (默认)

  • "uuid"

keyed_groups

列表 / 元素=字典

根据变量的值将主机添加到组。

默认值： []

default_value

字符串

在 ansible-core 2.12 中添加

当主机变量的值为空字符串时的默认值。

此选项与 keyed_groups[].trailing_separator 互斥。

key

字符串

用于生成组的输入字典中的键。

parent_group

字符串

键控组的父组。

prefix

字符串

键控组名称将以此前缀开头。

默认值： ""

separator

字符串

用于构建键控组名称的分隔符。

默认值： "_"

trailing_separator

布尔值

在 ansible-core 2.12 中添加

将此选项设置为 false 可在值为空字符串时省略主机变量后的 keyed_groups[].separator。

此选项与 keyed_groups[].default_value 互斥。

选项

  • false

  • true ← (默认)

leading_separator

布尔值

在 ansible-core 2.11 中添加

与 keyed_groups 结合使用。

默认情况下，不提供前缀或分隔符的键控组的名称将以下划线开头。

这是因为默认前缀是 ""，默认分隔符是 "_"。

如果未提供前缀，则将此选项设置为 false 以省略前导下划线（或其他分隔符）。

如果组名称来自映射，则分隔符仍用于连接各项。

要完全不在组名称中使用分隔符，请将键控组的分隔符设置为空字符串。

选项

  • false

  • true ← (默认)

plugin

字符串 / 必需

确保这是 ‘cloudscale’ 插件的源文件的令牌。

选项

  • "cloudscale"

strict

布尔值

如果 yes，则将无效条目视为致命错误，否则跳过并继续。

由于在表达式中可以使用事实，它们可能并非总是可用，我们默认忽略这些错误。

选项

  • false ← (默认)

  • true

use_extra_vars

布尔值

在 ansible-core 2.11 中添加

将额外变量合并到用于组合的可用变量中（优先级最高）。

选项

  • false ← (默认)

  • true

配置

示例

# cloudscale.yml name ending file in YAML format
# Example command line: ansible-inventory --list -i inventory_cloudscale.yml

plugin: cloudscale_ch.cloud.inventory

# Example grouping by tag key "project"
plugin: cloudscale_ch.cloud.inventory
keyed_groups:
  - prefix: project
    key: cloudscale.tags.project

# Example grouping by key "operating_system" lowercased and prefixed with "os"
plugin: cloudscale_ch.cloud.inventory
keyed_groups:
  - prefix: os
    key: cloudscale.image.operating_system | lower

作者

  • Gaudenz Steinlin (@gaudenz)

提示

每个条目类型的配置条目具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖列表中较高的变量。