hetzner.hcloud.server_network module – Manage the relationship between Hetzner Cloud Networks and servers
Note
This module is part of the hetzner.hcloud collection (version 3.1.1).
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.server_network
.
Synopsis
Create and delete the relationship Hetzner Cloud Networks and servers
Aliases: hcloud_server_network
Requirements
The below requirements are needed on the host that executes this module.
python-dateutil >= 2.7.5
requests >=2.20
Parameters
Parameter |
Comments |
---|---|
Alias IPs the server has. |
|
The API Endpoint for the Hetzner Cloud. You can also set this option by using the Default: |
|
The API Token for the Hetzner Cloud. You can also set this option by using the |
|
The IP the server should have. |
|
Name or ID of the Hetzner Cloud Networks. |
|
Name or ID of the Hetzner Cloud server. |
|
State of the server_network. Choices:
|
See Also
See also
- Documentation for Hetzner Cloud API
Complete reference for the Hetzner Cloud API.
Examples
- name: Create a basic server network
hetzner.hcloud.server_network:
network: my-network
server: my-server
state: present
- name: Create a server network and specify the ip address
hetzner.hcloud.server_network:
network: my-network
server: my-server
ip: 10.0.0.1
state: present
- name: Create a server network and add alias ips
hetzner.hcloud.server_network:
network: my-network
server: my-server
ip: 10.0.0.1
alias_ips:
- 10.1.0.1
- 10.2.0.1
state: present
- name: Ensure the server network is absent (remove if needed)
hetzner.hcloud.server_network:
network: my-network
server: my-server
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The relationship between a server and a network Returned: always |
|
Alias IPs of the server within the Network ip range Returned: always Sample: |
|
IP of the server within the Network ip range Returned: always Sample: |
|
Name of the Network Returned: always Sample: |
|
Name of the server Returned: always Sample: |