ngine_io.cloudstack.instance 库存 – Apache CloudStack 实例库存源

注意

此库存插件是 ngine_io.cloudstack 集合 (版本 2.5.0) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install ngine_io.cloudstack。您需要满足其他要求才能使用此库存插件，详情请参见 要求。

要在剧本中使用它，请指定： ngine_io.cloudstack.instance。

ngine_io.cloudstack 2.1.0 中的新增功能

概要

  • 从 Apache CloudStack 获取库存主机

  • 允许过滤和分组库存主机。

  • 使用以 _cloudstack-instances.yml_ 或 _cloudstack-instances.yaml_ 结尾的 YAML 配置文件来设置参数值（另请参见示例）。

要求

以下要求是在执行此库存的本地控制器节点上所需的。

  • python >= 2.6

  • cs >= 0.9.0

参数

参数

注释

api_http_method

字符串

用于查询 API 端点的 HTTP 方法。

如果未给出，则考虑 CLOUDSTACK_METHOD 环境变量。

选项

  • "get" ← (默认)

  • "post"

配置

api_key

字符串 / 必需

CloudStack API 的 API 密钥。

如果未给出，则考虑 CLOUDSTACK_KEY 环境变量。

配置

api_secret

字符串 / 必需

CloudStack API 的密钥。

如果未设置，则考虑 CLOUDSTACK_SECRET 环境变量。

配置

api_timeout

整数

HTTP 超时（秒）。

如果未给出，则考虑 CLOUDSTACK_TIMEOUT 环境变量。

默认值： 10

配置

api_url

字符串 / 必需

CloudStack API 的 URL，例如 https://cloud.example.com/client/api。

如果未给出，则考虑 CLOUDSTACK_ENDPOINT 环境变量。

配置

api_verify_ssl_cert

字符串

验证 CA 权威证书文件。

如果未给出，则考虑 CLOUDSTACK_VERIFY 环境变量。

配置

compose

字典

从 jinja2 表达式创建变量。

默认值： {}

filter_by_domain

字符串

仅返回提供的域中的实例。

filter_by_project

字符串

仅返回提供的项目中的实例。

filter_by_vpc

字符串

仅返回提供的 VPC 中的实例。

filter_by_zone

字符串

仅返回提供的区域中的实例。

groups

字典

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

默认值： {}

hostname

字符串

匹配主机名的字段。注意 v4_main_ip 对应于实例的第一个网卡适配器的 primary ipv4address。

选项

  • "v4_default_ip" ← (默认)

  • "hostname"

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

字符串 / 必需

确保这是“instance”插件的源文件的令牌。

选项

  • "ngine_io.cloudstack.instance"

strict

布尔值

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

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

选项

  • false ← (默认)

  • true

use_extra_vars

布尔值

在 ansible-core 2.11 中添加

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

选项

  • false ← (默认)

  • true

配置

validate_certs

布尔值

在 ngine_io.cloudstack 2.4.0 中添加

如果 false，则不会验证 SSL 证书。

如果没有给出，则考虑 CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY 环境变量。

这仅应在使用自签名证书的个人控制站点上使用。

选项

  • false

  • true ← (默认)

备注

注意

  • 有关 cloudstack 模块的详细指南，请参阅 CloudStack 云指南。

  • 此模块支持检查模式。

示例

# inventory_cloudstack.yml file in YAML format
# Example command line: ansible-inventory --list -i cloudstack-instances.yml
plugin: ngine_io.cloudstack.instance

# Use the default ip as ansible_host
hostname: v4_default_ip

# Return only instances related to the VPC vpc1 and in the zone EU
filter_by_vpc: vpc1
filter_by_zone: EU

# Group instances with a disk_offering as storage
# Create a group dmz for instances connected to the dmz network
groups:
  storage: disk_offering is defined
  dmz: "'dmz' in networks"

# Group the instances by network, with net_network1 as name of the groups
# Group the instanes by custom tag sla, groups like sla_value for tag sla
keyed_groups:
  - prefix: net
    key: networks
  - prefix: sla
    key: tags.sla

作者

  • Rafael del Valle (@rvalle)

提示

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