hetzner.hcloud.route 模块 – 在 Hetzner Cloud 上创建和删除云路由。

注意

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

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

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

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

概要

  • 在 Hetzner Cloud 上创建、更新和删除云路由。

别名:hcloud_route

要求

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

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

destination

字符串 / 必需

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

gateway

字符串 / 必需

路由的网关。

network

字符串 / 必需

Hetzner Cloud 网络的名称或 ID。

state

字符串

路由的状态。

选项

  • "absent"

  • "present" ←(默认)

另请参阅

另请参阅

Hetzner Cloud API 的文档

Hetzner Cloud API 的完整参考。

示例

- name: Create a basic route
  hetzner.hcloud.route:
    network: my-network
    destination: 10.100.1.0/24
    gateway: 10.0.1.1
    state: present

- name: Ensure the route is absent
  hetzner.hcloud.route:
    network: my-network
    destination: 10.100.1.0/24
    gateway: 10.0.1.1
    state: absent

返回值

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

描述

hcloud_route

复杂

网络的单个路由

返回值:总是

destination

字符串

此路由的目标网络或主机

返回值:总是

示例: "10.0.0.0/8"

gateway

字符串

路由的网关

返回值:总是

示例: "10.0.0.1"

network

字符串

网络的名称

返回值:总是

示例: "my-network"

作者

  • Lukas Kaemmerling (@lkaemmerling)