hetzner.hcloud.primary_ip_info module – Gather infos about the Hetzner Cloud Primary IPs.
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.primary_ip_info
.
Synopsis
Gather facts about your Hetzner Cloud Primary IPs.
Aliases: hcloud_primary_ip_info
Requirements
The below requirements are needed on the host that executes this module.
python-dateutil >= 2.7.5
requests >=2.20
Parameters
Parameter |
Comments |
---|---|
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 ID of the Primary IP you want to get. The module will fail if the provided ID is invalid. |
|
The label selector for the Primary IP you want to get. |
|
The name for the Primary IP you want to get. |
See Also
See also
- Documentation for Hetzner Cloud API
Complete reference for the Hetzner Cloud API.
Examples
- name: Gather hcloud Primary IP infos
hetzner.hcloud.primary_ip_info:
register: output
- name: Gather hcloud Primary IP infos by id
hetzner.hcloud.primary_ip_info:
id: 673954
register: output
- name: Gather hcloud Primary IP infos by name
hetzner.hcloud.primary_ip_info:
name: srv1-v4
register: output
- name: Gather hcloud Primary IP infos by label
hetzner.hcloud.primary_ip_info:
label_selector: srv03-ips
register: output
- name: Print the gathered infos
debug:
var: output
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The Primary IP infos as list Returned: always |
|
Numeric identifier of the ressource where the Primary IP is assigned to. Returned: always Sample: |
|
Name of the type where the Primary IP is assigned to. Returned: always Sample: |
|
Delete the Primary IP when the resource it is assigned to is deleted. Returned: always Sample: |
|
True if the Primary IP is protected for deletion Returned: always |
|
Shows the DNS PTR Record for Primary IP. Returned: always Sample: |
|
Location with datacenter where the Primary IP was created in Returned: always Sample: |
|
Numeric identifier of the Primary IP Returned: always Sample: |
|
IP address of the Primary IP Returned: always Sample: |
|
User-defined labels (key-value pairs) Returned: always |
|
Name of the Primary IP Returned: always Sample: |
|
Type of the Primary IP Returned: always Sample: |