hetzner.hcloud.hcloud_route module – Create and delete cloud routes on the Hetzner Cloud.

Note

This module is part of the hetzner.hcloud collection (version 1.8.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install hetzner.hcloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hetzner.hcloud.hcloud_route.

Synopsis

  • Create, update and delete cloud routes on the Hetzner Cloud.

Requirements

The below requirements are needed on the host that executes this module.

  • hcloud-python >= 1.0.0

  • hcloud-python >= 1.3.0

Parameters

Parameter

Comments

api_token

string / required

This is the API Token for the Hetzner Cloud.

destination

string / required

Destination network or host of this route.

endpoint

string

This is the API Endpoint for the Hetzner Cloud.

Default: "https://api.hetzner.cloud/v1"

gateway

string / required

Gateway for the route.

network

string / required

The name of the Hetzner Cloud Network.

state

string

State of the route.

Choices:

  • "absent"

  • "present" ← (default)

See Also

See also

Documentation for Hetzner Cloud API

Complete reference for the Hetzner Cloud API.

Examples

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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

hcloud_route

complex

One Route of a Network

Returned: always

destination

string

Destination network or host of this route

Returned: always

Sample: "10.0.0.0/8"

gateway

string

Gateway of the route

Returned: always

Sample: "10.0.0.1"

network

string

Name of the Network

Returned: always

Sample: "my-network"

Authors

  • Lukas Kaemmerling (@lkaemmerling)