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

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: community.general.proxmox_tasks_info.

Новая в community.general 3.8.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 строка / обязательно	Укажите пользователя для аутентификации.
node строка / обязательно	Узел, где необходимо получить задачи.
task алиасы: upid, name строка	Возвращает конкретную задачу.
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`).

Примеры

- name: List tasks on node01
  community.general.proxmox_tasks_info:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: '{{ password | default(omit) }}'
    api_token_id: '{{ token_id | default(omit) }}'
    api_token_secret: '{{ token_secret | default(omit) }}'
    node: node01
  register: result

- name: Retrieve information about specific tasks on node01
  community.general.proxmox_tasks_info:
    api_host: proxmoxhost
    api_user: root@pam
    api_password: '{{ password | default(omit) }}'
    api_token_id: '{{ token_id | default(omit) }}'
    api_token_secret: '{{ token_secret | default(omit) }}'
    task: 'UPID:node01:00003263:16167ACE:621EE230:srvreload:networking:root@pam:'
    node: node01
  register: proxmox_tasks

Значения возврата

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

Ключ	Описание
msg строка	Краткое сообщение. Возвращается: при ошибке Пример: `"Task: UPID:xyz:xyz does not exist on node: proxmoxnode"`
proxmox_tasks список / элементы=словарь	Список задач. Возвращается: при успехе
endtime целое число	Время завершения задачи. Возвращается: при успехе, может отсутствовать
failed булево	Если задача завершилась неудачно. Возвращается: когда статус определён
id строка	Идентификатор задачи. Возвращается: при успехе
node строка	Имя узла. Возвращается: при успехе
pid целое число	PID задачи. Возвращается: при успехе
pstart целое число	pastart задачи. Возвращается: при успехе
starttime целое число	Время начала задачи. Возвращается: при успехе
status строка	Статус задачи. Возвращается: при успехе, может отсутствовать
type строка	Тип задачи. Возвращается: при успехе
upid строка	UPID задачи. Возвращается: при успехе
user строка	Пользователь, владеющий задачей. Возвращается: при успехе

Авторы

Andreas Botzner (@paginabianca) <andreas at botzner dot com>

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

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