Spec-Zone.ru › Ansible

Модуль hetzner.hcloud.primary_ip_info — сбор сведений о первичных IP-адресах Hetzner Cloud.

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

string

Конечная точка API Hetzner Cloud.

Также можно задать этот параметр с помощью переменной окружения HCLOUD_ENDPOINT.

По умолчанию: "https://api.hetzner.cloud/v1"

api_endpoint_hetzner

string

Конечная точка API Hetzner.

Также можно задать этот параметр с помощью переменной окружения HETZNER_ENDPOINT.

По умолчанию: "https://api.hetzner.com/v1"

api_token

string / обязательный

Токен для API Hetzner Cloud.

Также можно задать этот параметр с помощью переменной окружения HCLOUD_TOKEN.

id

integer

Идентификатор первичного IP-адреса, сведения о котором нужно получить.

Модуль завершится с ошибкой, если указанный идентификатор недействителен.

label_selector

string

Селектор меток для первичного IP-адреса, сведения о котором нужно получить.

name

string

Имя первичного IP-адреса, сведения о котором нужно получить.

См. также

См. также

Документация по API Hetzner

Полный справочник по API Hetzner.

Примеры

- 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

Возвращаемые значения

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

Ключ

Описание

hcloud_primary_ip_info

list / элементы=string

Сведения о первичных IP-адресах в виде списка

Возвращается: всегда

assignee_id

integer

Идентификатор ресурса, которому назначен первичный IP-адрес; если адрес не назначен, значение отсутствует.

Возвращается: всегда

Пример: 19584637

assignee_type

string

Тип ресурса, которому назначен первичный IP-адрес.

Возвращается: всегда

Пример: "server"

auto_delete

boolean

Удалять ли первичный IP-адрес при удалении назначенного ему ресурса.

Возвращается: всегда

Пример: false

delete_protection

boolean

True, если первичный IP-адрес защищён от удаления

Возвращается: всегда

dns_ptr

string

Запись DNS PTR для первичного IP-адреса.

Возвращается: всегда

Пример: "srv01.example.com"

home_location

string

Центр обработки данных, в котором был создан первичный IP-адрес. Устарело: значение hcloud_primary_ip_info[].home_location объявлено устаревшим и будет удалено после 1 июля 2026 года. Вместо него используйте значение hcloud_primary_ip_info[].location. См. https://docs.hetzner.cloud/changelog#2025-12-16-phasing-out-datacenters.

Возвращается: всегда

Пример: "fsn1-dc1"

id

integer

Числовой идентификатор первичного IP-адреса

Возвращается: всегда

Пример: 1937415

ip

string

IP-адрес первичного IP-адреса

Возвращается: всегда

Пример: "131.232.99.1"

labels

dictionary

Пользовательские метки (пары «ключ — значение»)

Возвращается: всегда

location

string

Местоположение, в котором был создан первичный IP-адрес.

Возвращается: всегда

Пример: "fsn1"

name

string

Имя первичного IP-адреса

Возвращается: всегда

Пример: "my-primary-ip"

type

string

Тип первичного IP-адреса

Возвращается: всегда

Пример: "ipv4"

Авторы

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

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Справочник по API Hetzner Cloud
  • Журнал изменений API Hetzner Cloud

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API