Spec-Zone.ru › Ansible

Модуль community.proxmox.proxmox_ipam_info — получение сведений об IPAM.

Примечание

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

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

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

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

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

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

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

  • Получение всех IP-адресов в IPAM с возможностью фильтрации по IP-адресу или IPAM.

Требования

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

  • 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.

ipam

string

Ограничить результаты одним IPAM.

validate_certs

boolean

Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE.

В настоящее время значение по умолчанию — false; в community.proxmox 2.0.0 значение по умолчанию изменится на true.

Если параметр не указан, используется переменная среды PROXMOX_VALIDATE_CERTS.

Допустимые значения:

  • false
  • true

vmid

integer

Получить IP-адрес виртуальной машины в IPAM.

Атрибуты

Атрибут

Поддержка

Описание

action_group

Группа действий: community.proxmox.proxmox

Используйте group/community.proxmox.proxmox в module_defaults, чтобы задать значения по умолчанию для этого модуля.

check_mode

Поддержка: полная

Это действие не изменяет состояние.

Может выполняться в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: Не применимо

Это действие не изменяет состояние.

В режиме diff будут возвращены сведения об изменениях (или о возможных изменениях в check_mode).

Примеры

- name: Get all IPs under all IPAM
  community.proxmox.proxmox_ipam_info:
    api_user: "{{ pc.proxmox.api_user }}"
    api_token_id: "{{ pc.proxmox.api_token_id }}"
    api_token_secret: "{{ vault.proxmox.api_token_secret }}"
    api_host: "{{ pc.proxmox.api_host }}"
    validate_certs: false

- name: Get all IPs under pve IPAM
  community.proxmox.proxmox_ipam_info:
    api_user: "{{ pc.proxmox.api_user }}"
    api_token_id: "{{ pc.proxmox.api_token_id }}"
    api_token_secret: "{{ vault.proxmox.api_token_secret }}"
    api_host: "{{ pc.proxmox.api_host }}"
    validate_certs: false
    ipam: pve

- name: Get IP under IPAM of vmid 102
  community.proxmox.proxmox_ipam_info:
    api_user: "{{ pc.proxmox.api_user }}"
    api_token_id: "{{ pc.proxmox.api_token_id }}"
    api_token_secret: "{{ vault.proxmox.api_token_secret }}"
    api_host: "{{ pc.proxmox.api_host }}"
    validate_certs: false
    vmid: 102

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

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

Ключ

Описание

ipams

dictionary

Список всех IPAM и IP-адресов в них.

Возвращается: при успехе

Пример: {"pve": [{"gateway": 1, "ip": "10.10.1.0", "subnet": "10.10.1.0/24", "vnet": "test2", "zone": "test1"}, {"hostname": "ns3.proxmox.pc.test3", "ip": "10.10.0.6", "mac": "BC:24:11:0E:72:04", "subnet": "10.10.0.0/24", "vmid": 102, "vnet": "test2", "zone": "test1"}, {"hostname": "ns4.proxmox.pc", "ip": "10.10.0.7", "mac": "BC:24:11:D5:CD:82", "subnet": "10.10.0.0/24", "vmid": 103, "vnet": "test2", "zone": "test1"}, {"gateway": 1, "ip": "10.10.0.1", "subnet": "10.10.0.0/24", "vnet": "test2", "zone": "test1"}, {"hostname": "ns2.proxmox.pc.test3", "ip": "10.10.0.5", "mac": "BC:24:11:86:77:56", "subnet": "10.10.0.0/24", "vmid": 101, "vnet": "test2", "zone": "test1"}]}

ips

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

Фильтрация по vmid

Возвращается: при успехе

Пример: [{"hostname": "ns3.proxmox.pc", "ip": "10.10.5.5", "mac": "BC:24:11:0E:72:04", "subnet": "10.10.5.0/24", "vmid": 102, "vnet": "test", "zone": "ans1"}, {"hostname": "ns3.proxmox.pc", "ip": "10.10.0.8", "mac": "BC:24:11:F3:B1:81", "subnet": "10.10.0.0/24", "vmid": 102, "vnet": "test2", "zone": "test1"}]

Авторы

  • 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_ipam_info_module.html

Spec-Zone.ru

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