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

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

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

Чтобы использовать его в книге задач, укажите: community.general.proxmox_node_info.

Добавлен в community.general 8.2.0

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

Описание

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

Требования

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

proxmoxer
requests

Параметры

Параметр	Комментарии
api_host строка / обязательно	Укажите целевой хост кластера Proxmox VE.
api_password строка	Укажите пароль для аутентификации. Вы можете использовать переменную среды `PROXMOX_PASSWORD`.
api_port целое число добавлен в community.general 9.1.0	Укажите целевой порт кластера Proxmox VE. Используется переменная среды `PROXMOX_PORT`, если не указано.
api_token_id строка добавлен в community.general 1.3.0	Укажите идентификатор токена. Требуется `proxmoxer>=1.1.0` для работы.
api_token_secret строка добавлен в community.general 1.3.0	Укажите секрет токена. Требуется `proxmoxer>=1.1.0` для работы.
api_user строка / обязательно	Укажите пользователя для аутентификации.
validate_certs логическое	Если `false`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. Варианты: `false` ← (по умолчанию) `true`

Атрибуты

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

Примеры

- name: List existing nodes
  community.general.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	Используемая память в байтах. Возвращается: при успехе
node string	Краткое имя хоста этого узла. Возвращается: при успехе
ssl_fingerprint string	SSL отпечаток сертификата узла. Возвращается: при успехе
status string	Состояние узла. Возвращается: при успехе
type string	Тип возвращаемого объекта. Возвращается: при успехе
uptime integer	Время работы узла в секундах. Возвращается: при успехе

Авторы

John Berninger (@jwbernin)

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

© 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/community/general/proxmox_node_info_module.html