community.general.stackpath_compute清单 – StackPath边缘计算清单源

注意

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

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

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

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

community.general 1.2.0中的新增功能

概要

  • 从StackPath边缘计算获取清单主机。

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

参数

参数

注释

cache

布尔值

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

选项

  • 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

字符串

键控组名将以此前缀开头

默认值： ""

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

字符串 / 必需

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

选项

  • "community.general.stackpath_compute"

stack_slugs

列表 / 元素=字符串

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

strict

布尔值

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

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

选项

  • false ← (默认)

  • true

use_extra_vars

布尔值

在 ansible-core 2.11 中添加

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

选项

  • false ← (默认)

  • true

配置

use_internal_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

作者

  • UNKNOWN (@shayrybak)

提示

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