Модуль community.proxmox.proxmox_node – управление узлами Proxmox VE

Примечание

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

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

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

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

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

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

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

Управление самими узлами 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`.
certificates dictionary	Управление сертификатами x509 узла.
cert string	Файл публичного сертификата (включая цепочку) в формате PEM.
force boolean	Перезаписать существующие пользовательские файлы сертификатов. Варианты: `false` ← (по умолчанию) `true`
key string	Файл закрытого ключа в формате PEM.
restart boolean	Перезапустить pveproxy, чтобы обновить хеши новых сертификатов. Варианты: `false` ← (по умолчанию) `true`
state string	Определяет действия с сертификатом. Варианты: `"present"` `"absent"`
dns dictionary	Управление параметрами DNS-распознавания узла.
dns1 string	IP-адрес первого DNS-резолвера.
dns2 string	IP-адрес второго DNS-резолвера.
dns3 string	IP-адрес третьего DNS-резолвера.
search string / обязательный	Домен поиска по умолчанию.
node_name string / обязательный	Целевой узел, над которым выполняются действия.
power_state string	Управление состоянием питания узла. Варианты: `"online"` `"offline"`
subscription dictionary	Управление подпиской на лицензию узла.
key string	Лицензионный ключ подписки.
state string	Определяет действия с файлом подписки. Варианты: `"present"` `"absent"`
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: Start a Proxmox VE Node
  community.proxmox.node:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    validate_certs: false
    node_name: de-cgn01-virt01
    power_state: online
- name: Update SSL certificates on a Proxmox VE Node
  community.proxmox.node:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    validate_certs: false
    node_name: de-cgn01-virt01
    certificates:
        key: /opt/ansible/key.pem
        cert: /opt/ansible/cert.pem
        state: present
        force: false
- name: Place a subscription license on a Proxmox VE Node
  community.proxmox.node:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: password123
    validate_certs: false
    node_name: de-cgn01-virt01
    subscription:
        state: present
        key: ABCD-EFGH-IJKL-MNOP-QRST-UVWX-YZ0123456789

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

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

Ключ	Описание
certificates string	Сообщение о состоянии сертификата на узле. Возвращается: success Пример: `"Certificate for node 'dev-virt01' is already present."`
changed boolean	Указывает, были ли внесены изменения. Возвращается: success Пример: `true`
dns string	Сообщение о состоянии конфигурации DNS на узле. Возвращается: success Пример: `"DNS configuration for node 'dev-virt01' has been updated."`
power_state string	Сообщение о состоянии питания узла. Возвращается: success Пример: `"Node 'dev-virt01' is already online."`

Авторы

Florian Paul Azim Hoberg (@gyptazy)
Peter Tselios (@itcultus)

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

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