community.general.ovh_ip_failover 模块 – 管理 OVH IP 故障转移地址

注意

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

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

要安装它，请使用： ansible-galaxy collection install community.general。要使用此模块，您需要其他要求，请参阅 Requirements 获取详细信息。

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

概要 

管理 OVH（法国欧洲主机提供商）IP 故障转移地址。目前，此模块只能用于在服务之间移动 IP 故障转移（或故障转移块）

需求 

执行此模块的主机需要以下需求。

ovh >= 0.4.8

参数 

参数	注释
application_key 字符串 / 必填	要使用的 applicationKey
application_secret 字符串 / 必填	要使用的应用程序密钥
consumer_key 字符串 / 必填	要使用的 consumer key
endpoint 字符串 / 必填	要使用的端点（例如 ovh-eu）
name 字符串 / 必填	要管理的 IP 地址（可以是单个 IP，例如 1.1.1.1，也可以是块，例如 1.1.1.1/28）
service 字符串 / 必填	此 IP 地址应路由到的 OVH 服务的名称
timeout 整数	用于等待任务完成的超时时间（秒）。默认为 120 秒。默认值： `120`
wait_completion 布尔值	如果为真，则模块将等待 IP 地址移动完成。如果为假，则在不等待的情况下退出。taskId 将返回到模块输出中选项 `false` `true` ← (默认)
wait_task_completion 整数	如果不为 0，则模块将等待此任务 ID 完成。如果您想等待先前使用 wait_completion=false 执行的任务完成，请使用 wait_task_completion。您可以使用 wait_completion=false 在故障转移 IP 列表上重复执行此模块（请参阅示例）默认值： `0`

属性 

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

注释 

注意

使用 python OVH API https://github.com/ovh/python-ovh。您必须按照 https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/ 中所述创建应用程序（密钥和密钥）。

示例 

# Route an IP address 1.1.1.1 to the service ns666.ovh.net
- community.general.ovh_ip_failover:
    name: 1.1.1.1
    service: ns666.ovh.net
    endpoint: ovh-eu
    application_key: yourkey
    application_secret: yoursecret
    consumer_key: yourconsumerkey
- community.general.ovh_ip_failover:
    name: 1.1.1.1
    service: ns666.ovh.net
    endpoint: ovh-eu
    wait_completion: false
    application_key: yourkey
    application_secret: yoursecret
    consumer_key: yourconsumerkey
  register: moved
- community.general.ovh_ip_failover:
    name: 1.1.1.1
    service: ns666.ovh.net
    endpoint: ovh-eu
    wait_task_completion: "{{moved.taskId}}"
    application_key: yourkey
    application_secret: yoursecret
    consumer_key: yourconsumerkey

作者

Pascal HERAUD (@pascalheraud)