community.general.stacki_host 模块 – 添加或删除 stacki 前端的主机

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

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

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

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

概要 

使用此模块通过 API 向 stacki 前端添加或删除主机。
有关 stacki 的信息可以在 https://github.com/StackIQ/stacki 找到。

参数 

参数	注释
appliance 字符串	用于主机创建的设备。如果 `state=present` 且主机尚不存在，则为必填项。默认值： `"backend"`
force_install 布尔值	如果节点已存在于 stacki 中，则将值设置为 `true` 以强制节点进入安装状态。选项 `false` ←（默认值） `true`
name 字符串 / 必填项	要添加到 Stacki 的主机的名称。
network 字符串	要在主机中配置的网络。当前模块未使用。默认值： `"private"`
prim_intf 字符串	主网络接口的名称。当前模块未使用。
prim_intf_ip 字符串	主网络接口的 IP 地址。当前模块未使用。
prim_intf_mac 字符串	主 PXE 引导网络接口的 MAC 地址。当前模块未使用。
rack 整数	用于主机创建的机架。如果 `state=present` 且主机尚不存在，则为必填项。默认值： `0`
rank 整数	用于主机创建的等级。在 Stacki 术语中，等级是机器在机架中的位置。如果 `state=present` 且主机尚不存在，则为必填项。默认值： `0`
stacki_endpoint 字符串 / 必填项	Stacki API 端点的 URL。
stacki_password 字符串 / 必填项	用于使用 Stacki API 进行身份验证的密码，但如果未指定，则会改为使用环境变量 `stacki_password`。
stacki_user 字符串 / 必填项	用于使用 Stacki API 进行身份验证的用户名，但如果未指定，则会改为使用环境变量 `stacki_user`。
state 字符串	将值设置为指定主机的所需状态。选项 `"absent"` `"present"` ←（默认值）

属性 

属性	支持	描述
check_mode	支持：无	可以在 `check_mode` 中运行并返回更改状态预测，而无需修改目标。
diff_mode	支持：无	在差异模式下，将返回有关已更改（或可能需要在 `check_mode` 中更改）的详细信息。

示例 

- name: Add a host named test-1
  community.general.stacki_host:
    name: test-1
    stacki_user: usr
    stacki_password: pwd
    stacki_endpoint: url
    prim_intf_mac: mac_addr
    prim_intf_ip: x.x.x.x
    prim_intf: eth0

- name: Remove a host named test-1
  community.general.stacki_host:
    name: test-1
    stacki_user: usr
    stacki_password: pwd
    stacki_endpoint: url
    state: absent

返回值 

通用返回值在此处记录此处，以下是此模块独有的字段

键	描述
changed 布尔值	响应 API 调用是否成功完成返回：始终示例： `true`
stdout 列表 / 元素=字符串	来自命令的响应集返回：始终示例： `["...", "..."]`
stdout_lines 列表 / 元素=字符串	stdout 的值拆分为列表返回：始终示例： `[["...", "..."], ["..."], ["..."]]`

作者

Hugh Ma (@bbyhuy)