hetzner.hcloud.floating_ip 模块 – 在 Hetzner Cloud 上创建和管理云浮动 IP。

注意

此模块是 hetzner.hcloud 集合 (版本 4.2.2) 的一部分。

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

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

要在 playbook 中使用它，请指定：hetzner.hcloud.floating_ip。

hetzner.hcloud 0.1.0 中的新增功能

概要 

在 Hetzner Cloud 上创建、更新和管理云浮动 IP。

别名：hcloud_floating_ip

要求 

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

python-dateutil >= 2.7.5
requests >=2.20

参数 

参数	注释
api_endpoint 别名：endpoint 字符串	Hetzner Cloud 的 API 端点。您也可以使用 `HCLOUD_ENDPOINT` 环境变量设置此选项。默认值： `"https://api.hetzner.cloud/v1"`
api_token 字符串 / 必需	Hetzner Cloud 的 API 令牌。您也可以使用 `HCLOUD_TOKEN` 环境变量设置此选项。
delete_protection 布尔值	保护浮动 IP 免于删除。选项 `false` `true`
description 字符串	Hetzner Cloud 浮动 IP 的描述。
force 布尔值	强制分配或删除浮动 IP。选项 `false` `true`
home_location 字符串	Hetzner Cloud 浮动 IP 的主位置。如果未给出 _server_ 且浮动 IP 不存在，则为必填项。
id 整数	要管理的 Hetzner Cloud 浮动 IP 的 ID。如果未给出浮动 IP _name_，则为必填项。
labels 字典	用户定义的标签（键值对）。
name 字符串	要管理的 Hetzner Cloud 浮动 IP 的名称。如果未给出浮动 IP _id_ 或浮动 IP 不存在，则为必填项。
server 字符串	应将浮动 IP 分配到的服务器名称。如果未给出 _home_location_ 且浮动 IP 不存在，则为必填项。
state 字符串	浮动 IP 的状态。选项 `"absent"` `"present"` ← (默认)
type 字符串	浮动 IP 的类型。如果浮动 IP 不存在，则为必填项选项 `"ipv4"` `"ipv6"`

另请参阅 

另请参阅

Hetzner Cloud API 文档: Hetzner Cloud API 的完整参考。

示例 

- name: Create a basic IPv4 Floating IP
  hetzner.hcloud.floating_ip:
    name: my-floating-ip
    home_location: fsn1
    type: ipv4
    state: present
- name: Create a basic IPv6 Floating IP
  hetzner.hcloud.floating_ip:
    name: my-floating-ip
    home_location: fsn1
    type: ipv6
    state: present
- name: Assign a Floating IP to a server
  hetzner.hcloud.floating_ip:
    name: my-floating-ip
    server: 1234
    state: present
- name: Assign a Floating IP to another server
  hetzner.hcloud.floating_ip:
    name: my-floating-ip
    server: 1234
    force: true
    state: present
- name: Floating IP should be absent
  hetzner.hcloud.floating_ip:
    name: my-floating-ip
    state: absent

返回值 

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

键	描述
hcloud_floating_ip 复杂类型	浮动 IP 实例返回：始终返回
delete_protection 布尔值在 hetzner.hcloud 0.1.0 中添加	如果浮动 IP 受保护以防止删除，则返回 True 返回：始终返回示例： `false`
description 字符串	浮动 IP 的描述返回：始终返回示例： `"my-floating-ip"`
home_location 字符串	浮动 IP 的主位置名称返回：始终返回示例： `"fsn1"`
id 整数	浮动 IP 的 ID 返回：始终返回示例： `12345`
ip 字符串	浮动 IP 的 IP 地址返回：始终返回示例： `"116.203.104.109"`
labels 字典	用户定义的标签（键值对）返回：始终返回示例： `{"key": "value", "mylabel": 123}`
name 字符串	浮动 IP 的名称返回：始终返回示例： `"my-floating-ip"`
server 字符串	分配浮动 IP 的服务器的名称。返回：始终返回示例： `"my-server"`
type 字符串	浮动 IP 的类型返回：始终返回示例： `"ipv4"`

作者

Lukas Kaemmerling (@lkaemmerling)