hetzner.hcloud.floating_ip_info 模块 – 收集关于 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_info

概要

  • 收集关于您的 Hetzner Cloud 浮动 IP 的信息。

别名:hcloud_floating_ip_info

要求

以下要求需要在执行此模块的主机上满足。

  • 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 环境变量设置此选项。

id

整数

您要获取的浮动 IP 的 ID。

如果提供的 ID 无效,模块将失败。

label_selector

字符串

您要获取的浮动 IP 的标签选择器。

name

字符串

您要获取的浮动 IP 的名称。

另请参阅

另请参阅

Hetzner Cloud API 的文档

Hetzner Cloud API 的完整参考。

示例

- name: Gather hcloud Floating ip infos
  hetzner.hcloud.floating_ip_info:
  register: output
- name: Print the gathered infos
  debug:
    var: output

返回值

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

描述

hcloud_floating_ip_info

复杂

作为列表的浮动 IP 信息

返回:始终

delete_protection

布尔值

在 hetzner.hcloud 0.1.0 中添加

如果浮动 IP 受保护以防止删除,则为 True

返回:始终

description

字符串

浮动 IP 的描述

返回:始终

示例: "Falkenstein DC 8"

home_location

字符串

浮动 IP 创建的位置

返回:始终

示例: "fsn1"

id

整数

浮动 IP 的数字标识符

返回:始终

示例: 1937415

ip

字符串

浮动 IP 的 IP 地址

返回:始终

示例: "131.232.99.1"

labels

字典

用户定义的标签(键值对)

返回:始终

name

字符串

在 hetzner.hcloud 0.1.0 中添加

浮动 IP 的名称

返回:始终

示例: "my-floating-ip"

server

字符串

浮动 IP 分配到的服务器的名称。

返回:始终

示例: "my-server"

type

字符串

浮动 IP 的类型

返回:始终

示例: "ipv4"

作者

  • Lukas Kaemmerling (@LKaemmerling)