hetzner.hcloud.network_info 模块 – 收集关于您的 Hetzner Cloud 网络的信息。

注意

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

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

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

要在剧本中使用它,请指定:hetzner.hcloud.network_info

概要

  • 收集关于您的 Hetzner Cloud 网络的信息。

别名:hcloud_network_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

整数

要获取的网络的 ID。

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

label_selector

字符串

要获取的网络的标签选择器。

name

字符串

要获取的网络的名称。

另请参阅

另请参阅

Hetzner Cloud API 文档

Hetzner Cloud API 的完整参考。

示例

- name: Gather hcloud network info
  local_action:
    module: hcloud_network_info

- name: Print the gathered info
  debug:
    var: hcloud_network_info

返回值

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

描述

hcloud_network_info

复杂类型

网络信息作为列表

返回: 始终

delete_protection

布尔值

在 hetzner.hcloud 0.1.0 中添加

如果网络受保护以防止删除,则为 True

返回: 始终

expose_routes_to_vswitch

布尔值

指示是否应将此网络中的路由公开到 vSwitch 连接。

返回: 始终

示例: false

id

整数

网络的数字标识符

返回: 始终

示例: 1937415

ip_range

字符串

网络的 IP 范围

返回: 始终

示例: "10.0.0.0/16"

labels

字典

网络的标签

返回: 始终

name

字符串

网络的名称

返回: 始终

示例: "awesome-network"

routes

复杂类型

属于网络的路由

返回: 始终

gateway

字符串

此路由的网关

返回: 始终

示例: "10.0.0.1"

ip_range

字符串

此路由的目标网络或主机。

返回: 始终

示例: "10.0.0.0/16"

servers

复杂类型

连接到网络的服务器

返回: 始终

backup_window

布尔值

备份将运行的时间窗口 (UTC),如果未启用备份,则为 null

返回: 始终

示例: "22-02"

datacenter

字符串

服务器的数据中心的名称

返回: 始终

示例: "fsn1-dc14"

id

整数

服务器的数字标识符

返回: 始终

示例: 1937415

ipv4_address

字符串

服务器的公共 IPv4 地址,如果不存在则为 None

返回: 始终

示例: "116.203.104.109"

ipv6

字符串

服务器的 IPv6 网络,如果不存在则为 None

返回: 始终

示例: "2a01:4f8:1c1c:c140::/64"

labels

字典

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

返回: 始终

location

字符串

服务器所在位置的名称

返回: 始终

示例: "fsn1"

name

字符串

服务器的名称

返回: 始终

示例: "my-server"

rescue_enabled

布尔值

如果启用了救援模式,则为 True,服务器将在下次重新引导时引导到救援系统

返回: 始终

示例: false

server_type

字符串

服务器的服务器类型的名称

返回: 始终

示例: "cx22"

status

字符串

服务器的状态

返回: 始终

示例: "running"

子网

复杂类型

属于该网络的子网

返回: 始终

gateway

字符串

此子网的网关

返回: 始终

示例: "10.0.0.1"

ip_range

字符串

子网的IP范围

返回: 始终

示例: "10.0.0.0/24"

网络区域

字符串

子网所属的网络。

返回: 始终

示例: "eu-central"

类型

字符串

子网的类型。

返回: 始终

示例: "cloud"

作者

  • Christopher Schmitt (@cschmitt-hcloud)