community.hrobot.failover_ip_info 模块 – 获取 Hetzner 故障转移 IP 信息

注意

此模块是 community.hrobot 集合 (版本 2.0.2) 的一部分。

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

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

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

概要 

检索 Hetzner 故障转移 IP 的信息。

参数 

参数	注释
failover_ip 字符串 / 必需	故障转移 IP 地址。
hetzner_password 字符串 / 必需	Robot Web 服务用户的密码。
hetzner_user 字符串 / 必需	Robot Web 服务用户的用户名。

属性 

属性	支持	描述
action_group	动作组： community.hrobot.robot 在 community.hrobot 1.6.0 中添加	在 `module_defaults` 中使用 `group/community.hrobot.robot` 为此模块设置默认值。
check_mode	支持：完全支持此操作不会修改状态。	可以在 `check_mode` 中运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持： N/A 此操作不会修改状态。	在差异模式下，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

另请参阅 

另请参阅

故障转移 IP 文档: Hetzner 关于故障转移 IP 的文档。
community.hrobot.failover_ip: 管理故障转移 IP。

示例 

- name: Get value of failover IP 1.2.3.4
  community.hrobot.failover_ip_info:
    hetzner_user: foo
    hetzner_password: bar
    failover_ip: 1.2.3.4
    value: 5.6.7.8
  register: result

- name: Print value of failover IP 1.2.3.4 in case it is routed
  ansible.builtin.debug:
    msg: "1.2.3.4 routes to {{ result.value }}"
  when: result.state == 'routed'

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
failover_ip 字符串	故障转移 IP。返回：成功示例：`"1.2.3.4"`
failover_netmask 字符串	故障转移 IP 的网络掩码。返回：成功示例：`"255.255.255.255"`
server_ip 字符串	此故障转移 IP 关联到的服务器的主 IP。这不是故障转移 IP 路由到的服务器。返回：成功
server_number 整数	此故障转移 IP 关联到的服务器的编号。这不是故障转移 IP 路由到的服务器。返回：成功
state 字符串	将是 `routed` 或 `unrouted`。返回：成功
value 字符串	故障转移 IP 的值。如果 IP 未路由，则为 `none`。返回：成功

作者

Felix Fontein (@felixfontein)