community.hrobot.failover_ip 模块 – 管理 Hetzner 的故障转移 IP

注意

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

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

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

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

概要 

管理 Hetzner 的故障转移 IP。

参数 

参数	注释
failover_ip 字符串 / 必需	故障转移 IP 地址。
hetzner_password 字符串 / 必需	Robot Web 服务用户的密码。
hetzner_user 字符串 / 必需	Robot Web 服务用户的用户名。
state 字符串	定义 IP 是否会被路由。如果设置为 `routed`，则必须指定 `value`。选项 `"routed"` ←（默认） `"unrouted"`
timeout 整数	路由或取消路由故障转移 IP 时使用的超时时间。请注意，当故障转移 IP 已成功路由到新地址或已成功取消路由时，API 调用会返回。默认值: `180`
value 字符串	故障转移 IP 地址的新值。当将 `state` 设置为 `routed` 时是必需的。

属性 

属性	支持	描述
action_group	动作组: community.hrobot.robot 在 community.hrobot 1.6.0 中添加	在 `module_defaults` 中使用 `group/community.hrobot.robot` 来为此模块设置默认值。
check_mode	支持: 完全	可以在 `check_mode` 中运行，并返回已更改的状态预测，而无需修改目标。
diff_mode	支持: 完全	当处于差异模式时，将返回已更改的内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

参见 

另请参阅

故障转移 IP 文档: Hetzner 关于故障转移 IP 的文档。
community.hrobot.failover_ip_info: 检索有关故障转移 IP 的信息。

示例 

- name: Set value of failover IP 1.2.3.4 to 5.6.7.8
  community.hrobot.failover_ip:
    hetzner_user: foo
    hetzner_password: bar
    failover_ip: 1.2.3.4
    value: 5.6.7.8

- name: Set value of failover IP 1.2.3.4 to unrouted
  community.hrobot.failover_ip:
    hetzner_user: foo
    hetzner_password: bar
    failover_ip: 1.2.3.4
    state: unrouted

返回值 

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

键	描述
state 字符串	将为 `routed` 或 `unrouted`。返回: 成功
value 字符串	故障转移 IP 的值。如果 IP 未路由，则将为 `none`。返回: 成功

作者

Felix Fontein (@felixfontein)