Модуль community.proxmox.proxmox_zone_info — получение сведений о зоне Proxmox.

Примечание

Этот модуль входит в коллекцию community.proxmox (версия 1.6.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: community.proxmox.proxmox_zone_info.

Добавлено в community.proxmox 1.4.0

Краткое описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Выводит список всех доступных зон.

Требования

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

proxmoxer >= 2.0
requests

Параметры

Параметр	Комментарии
api_host string / обязательный	Укажите целевой узел кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_HOST`.
api_password string	Укажите пароль для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_PASSWORD`.
api_port integer	Укажите целевой порт кластера Proxmox VE. Если параметр не указан, используется переменная окружения `PROXMOX_PORT`.
api_timeout integer	Ограничение времени для запросов к API Proxmox VE. По умолчанию: `5`
api_token_id string	Укажите идентификатор токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret string	Укажите секрет токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user string / обязательный	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
type string	Фильтрация зон по типу. Варианты: `"evpn"` `"faucet"` `"qinq"` `"simple"` `"vlan"` `"vxlan"`
validate_certs boolean	Проверка сертификатов TLS, используемых для подключения к API Proxmox VE. В настоящее время значение по умолчанию — `false`; в community.proxmox 2.0.0 оно изменится на `true`. Если параметр не указан, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Варианты: `false` `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.proxmox.proxmox	Используйте `group/community.proxmox.proxmox` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: full Это действие не изменяет состояние.	Может выполняться в `check_mode` и возвращать прогноз статуса изменений без внесения изменений в целевой объект.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	В режиме diff будут возвращены сведения об изменениях (или о том, какие изменения, возможно, требуется внести в `check_mode`).

Примеры

- name: Get all zones
  community.proxmox.proxmox_zone_info:
    api_user: "root@pam"
    api_password: "{{ vault.proxmox.root_password }}"
    api_host: "{{ pc.proxmox.api_host }}"
    validate_certs: false

- name: Get all simple zones
  community.proxmox.proxmox_zone_info:
    api_user: "root@pam"
    api_password: "{{ vault.proxmox.root_password }}"
    api_host: "{{ pc.proxmox.api_host }}"
    validate_certs: false
    type: simple
  register: zones

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

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

Ключ	Описание
zones list / elements=dictionary	Список зон. Если указан type, список будет отфильтрован по типу. Возвращается: при успешном выполнении Пример: [{"digest": "e29dea494461aa699ab3bfb7264d95631c8d0e0d", "type": "simple", "zone": "ans1"}, {"bridge": "vmbr0", "digest": "e29dea494461aa699ab3bfb7264d95631c8d0e0d", "mtu": 1200, "type": "vlan", "zone": "ansible"}, {"bridge": "vmbr100", "digest": "e29dea494461aa699ab3bfb7264d95631c8d0e0d", "ipam": "pve", "type": "vlan", "zone": "lab"}, {"dhcp": "dnsmasq", "digest": "e29dea494461aa699ab3bfb7264d95631c8d0e0d", "ipam": "pve", "type": "simple", "zone": "test1"}, {"digest": "e29dea494461aa699ab3bfb7264d95631c8d0e0d", "ipam": "pve", "type": "simple", "zone": "tsjsfv"}]

Ключ

Описание

zones

list / elements=dictionary

Список зон.

Если указан type, список будет отфильтрован по типу.

Возвращается: при успешном выполнении

Пример: [{"digest": "e29dea494461aa699ab3bfb7264d95631c8d0e0d", "type": "simple", "zone": "ans1"}, {"bridge": "vmbr0", "digest": "e29dea494461aa699ab3bfb7264d95631c8d0e0d", "mtu": 1200, "type": "vlan", "zone": "ansible"}, {"bridge": "vmbr100", "digest": "e29dea494461aa699ab3bfb7264d95631c8d0e0d", "ipam": "pve", "type": "vlan", "zone": "lab"}, {"dhcp": "dnsmasq", "digest": "e29dea494461aa699ab3bfb7264d95631c8d0e0d", "ipam": "pve", "type": "simple", "zone": "test1"}, {"digest": "e29dea494461aa699ab3bfb7264d95631c8d0e0d", "ipam": "pve", "type": "simple", "zone": "tsjsfv"}]

Авторы

Jana Hoch

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

© 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/community/proxmox/proxmox_zone_info_module.html