community.general.stackpath_compute 库存 – StackPath 边缘计算库存源

注意

此库存插件是 community.general 集合（版本 10.1.0）的一部分。

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

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

要在 playbook 中使用它，请指定：community.general.stackpath_compute。

community.general 1.2.0 中的新功能

概要

  • 从 StackPath 边缘计算获取库存主机。

  • 使用以 stackpath_compute.(yml|yaml) 结尾的 YAML 配置文件。

参数

参数

注释

缓存

布尔值

切换以启用/禁用库存源数据的缓存，需要设置缓存插件才能工作。

选项

  • false ← （默认）

  • true

配置

cache_connection

字符串

缓存连接数据或路径，请阅读缓存插件文档以了解具体信息。

配置

cache_plugin

字符串

用于库存源数据的缓存插件。

默认： "memory"

配置

cache_prefix

字符串

用于缓存插件文件/表的前缀。

默认： "ansible_inventory_"

配置

cache_timeout

整数

缓存持续时间（以秒为单位）。

默认： 3600

配置

client_id

字符串 / 必需

从 StackPath 客户门户的 API 管理部分生成的 OAuth 客户端 ID https://control.stackpath.net/api-management。

client_secret

字符串 / 必需

从 StackPath 客户门户的 API 管理部分生成的 OAuth 客户端密钥 https://control.stackpath.net/api-management。

compose

字典

从 jinja2 表达式创建变量。

默认： {}

groups

字典

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

默认： {}

keyed_groups

列表 / 元素=字典

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

默认： []

default_value

字符串

在 ansible-core 2.12 中添加

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

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

key

字符串

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

parent_group

字符串

键控组的父组。

prefix

字符串

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

默认值： ""

分隔符

字符串

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

默认值： "_"

尾部分隔符

布尔值

在 ansible-core 2.12 中添加

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

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

选项

  • false

  • true ← (默认)

前导分隔符

布尔值

在 ansible-core 2.11 中添加

与 keyed_groups 结合使用。

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

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

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

如果组名称是从映射派生的，则仍然使用分隔符连接项目。

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

选项

  • false

  • true ← (默认)

插件

字符串 / 必需

一个令牌，用于确保这是插件的源文件。

选项

  • "community.general.stackpath_compute"

堆栈别名

列表 / 元素=字符串

要查询实例的堆栈别名列表。 如果没有条目，则获取帐户上所有堆栈中的实例。

严格模式

布尔值

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

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

选项

  • false ← （默认）

  • true

使用额外变量

布尔值

在 ansible-core 2.11 中添加

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

选项

  • false ← （默认）

  • true

配置

使用内部IP

布尔值

是否使用内部 IP 地址。如果为 false，则使用外部 IP 地址，否则使用内部 IP 地址。

如果实例没有外部 IP，则当此选项设置为 false 时，将不会返回该实例。

选项

  • false

  • true

示例

# Example using credentials to fetch all workload instances in a stack.
---
plugin: community.general.stackpath_compute
client_id: my_client_id
client_secret: my_client_secret
stack_slugs:
- my_first_stack_slug
- my_other_stack_slug
use_internal_ip: false

作者

  • 未知 (@shayrybak)

提示

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