Модуль community.proxmox.proxmox_node_info — получение информации об одном или нескольких узлах Proxmox VE

Примечание

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

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

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

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

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

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

Получение информации об одном или нескольких узлах Proxmox VE.

Требования

Следующие требования необходимы на узле, который выполняет этот модуль.

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`.
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	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой узел.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	В режиме diff будут возвращены сведения об изменениях (или о том, что, возможно, нужно изменить в `check_mode`).

Примеры

- name: List existing nodes
  community.proxmox.proxmox_node_info:
    api_host: proxmox1
    api_user: root@pam
    api_password: "{{ password | default(omit) }}"
    api_token_id: "{{ token_id | default(omit) }}"
    api_token_secret: "{{ token_secret | default(omit) }}"
  register: proxmox_nodes

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

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

Ключ	Описание
proxmox_nodes list / elements=dictionary	Список узлов Proxmox VE. Возвращается: всегда, но список может быть пустым
cpu float	Текущая загрузка ЦП в долях от общей доступной мощности ЦП этого узла. Возвращается: при успешном выполнении
disk integer	Текущее использование локального диска этого узла. Возвращается: при успешном выполнении
id string	Идентификатор узла. Возвращается: при успешном выполнении
level string	Уровень поддержки. Может быть пустым, если не заключён договор платной поддержки. Возвращается: при успешном выполнении
maxcpu integer	Общее количество доступных процессоров на этом узле. Возвращается: при успешном выполнении
maxdisk integer	Размер локального диска в байтах. Возвращается: при успешном выполнении
maxmem integer	Объём памяти в байтах. Возвращается: при успешном выполнении
mem integer	Используемая память в байтах. Возвращается: при успешном выполнении
network dictionary	Активные сетевые интерфейсы узла Возвращается: при успешном выполнении
node string	Короткое имя узла. Возвращается: при успешном выполнении
ssl_fingerprint string	Отпечаток SSL-сертификата узла. Возвращается: при успешном выполнении
status string	Состояние узла. Возвращается: при успешном выполнении
type string	Тип возвращаемого объекта. Возвращается: при успешном выполнении
uptime integer	Время работы узла в секундах. Возвращается: при успешном выполнении
version dictionary	Версия PVE на узле Возвращается: при успешном выполнении

Авторы

John Berninger (@jwbernin)

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

© 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_node_info_module.html