Модуль hetzner.hcloud.primary_ip_info – Сбор информации о первичных IP-адресах Hetzner Cloud.

Примечание

Этот модуль является частью коллекции hetzner.hcloud (версия 3.1.1).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install hetzner.hcloud. Для использования этого модуля потребуются дополнительные зависимости. Подробности см. в разделе Требования.

Для использования в книге задач укажите: hetzner.hcloud.primary_ip_info.

Описание
Требования
Параметры
См. также
Примеры
Возвращаемые значения

Описание

Сбор фактов о первичных IP-адресах Hetzner Cloud.

Псевдонимы: hcloud_primary_ip_info

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python-dateutil >= 2.7.5
requests >=2.20

Параметры

Параметр	Комментарии
api_endpoint псевдонимы: endpoint строка	API-точку входа для Hetzner Cloud. Этот параметр также можно задать, используя переменную окружения `HCLOUD_ENDPOINT`. Значение по умолчанию: `"https://api.hetzner.cloud/v1"`
api_token строка / обязательно	API-токен для Hetzner Cloud. Этот параметр также можно задать, используя переменную окружения `HCLOUD_TOKEN`.
id целое число	Идентификатор первичного IP-адреса, который требуется получить. Модуль завершится ошибкой, если предоставленный идентификатор недействителен.
label_selector строка	Селектор меток для первичного IP-адреса, который требуется получить.
name строка	Имя первичного IP-адреса, который требуется получить.

См. также

Документация API Hetzner Cloud: Полная справка по API Hetzner Cloud.

Примеры

- 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

END_OF_DOCUMENT_MARKER

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
hcloud_primary_ip_info сложный	Информация о основном IP-адресе в виде списка Возвращается: всегда
assignee_id целое число	Числовой идентификатор ресурса, к которому назначен основной IP-адрес. Возвращается: всегда Пример: `19584637`
assignee_type строка	Имя типа, к которому назначен основной IP-адрес. Возвращается: всегда Пример: `"server"`
auto_delete логическое значение	Удалить основной IP-адрес при удалении ресурса, к которому он назначен. Возвращается: всегда Пример: `false`
delete_protection логическое значение	Истина, если основной IP-адрес защищен от удаления Возвращается: всегда
dns_ptr строка	Отображает запись DNS PTR для основного IP-адреса. Возвращается: всегда Пример: `"srv01.example.com"`
home_location строка	Расположение с дата-центром, в котором был создан основной IP-адрес Возвращается: всегда Пример: `"fsn1-dc1"`
id целое число	Числовой идентификатор основного IP-адреса Возвращается: всегда Пример: `1937415`
ip строка	IP-адрес основного IP-адреса Возвращается: всегда Пример: `"131.232.99.1"`
labels словарь	Пользовательские метки (пары ключ-значение) Возвращается: всегда
name строка	Имя основного IP-адреса Возвращается: всегда Пример: `"my-primary-ip"`
type строка	Тип основного IP-адреса Возвращается: всегда Пример: `"ipv4"`

Авторы

Lukas Kaemmerling (@LKaemmerling)
Kevin Castner (@kcastner)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/primary_ip_info_module.html