hetzner.hcloud.location_info 模块 – 收集关于您的 Hetzner Cloud 位置的信息。

注意

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

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

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

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

概要

  • 收集关于您的 Hetzner Cloud 位置的信息。

别名:hcloud_location_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 无效,则模块将失败。

name

字符串

您要获取的位置的名称。

另请参见

另请参见

Hetzner Cloud API 文档

Hetzner Cloud API 的完整参考。

示例

- name: Gather hcloud location infos
  hetzner.hcloud.location_info:
  register: output

- name: Print the gathered infos
  debug:
    var: output

返回值

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

描述

hcloud_location_info

复杂类型

位置信息列表

返回:始终

city

字符串

位置的城市

返回:始终

示例: "Falkenstein"

country

字符串

位置的国家代码

返回:始终

示例: "DE"

description

字符串

位置的详细描述

返回:始终

示例: "Falkenstein DC Park 1"

id

整数

位置的数字标识符

返回:始终

示例: 1937415

name

字符串

位置的名称

返回:始终

示例: "fsn1"

作者

  • Lukas Kaemmerling (@LKaemmerling)