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)

提示

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