ovirt_job – Модуль для управления задачами в oVirt/RHV
Новый в версии 2.9.
Обзор
- Этот модуль управляет задачами в oVirt/RHV. Он также может управлять этапами задачи.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth словарь / обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS соединения с oVirt: | ||
| ca_file строка | Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр ca_file не задан, используется системное хранилище сертификатов CA.Значение по умолчанию задается переменной среды OVIRT_CAFILE. | ||
| headers словарь | Словарь HTTP-заголовков, которые нужно добавить к каждому API-запросу. | ||
| hostname строка | Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задается переменной среды OVIRT_HOSTNAME.Требуется либо url, либо hostname. | ||
| insecure булево |
| Флаг булевого типа, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста. | |
| kerberos булево |
| Флаг булевого типа, указывающий, нужно ли использовать аутентификацию Kerberos вместо стандартной аутентификации. | |
| password строка / обязательно | Пароль пользователя. Значение по умолчанию задается переменной среды OVIRT_PASSWORD. | ||
| token строка | Токен, который будет использоваться вместо входа с именем пользователя/паролем. Значение по умолчанию задается переменной среды OVIRT_TOKEN. | ||
| url строка | Строка, содержащая API-URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной среды OVIRT_URL.Требуется либо url, либо hostname. | ||
| username строка / обязательно | Имя пользователя, например admin@internal. Значение по умолчанию задается переменной среды OVIRT_USERNAME. | ||
| description - / обязательно | Описание задачи. Если задача с таким же описанием уже завершена, и вы перезапустите задачу, будет создана новая задача. | ||
| fetch_nested булево |
| Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков, снимков и т.д. виртуальных машин. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| nested_attributes список | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только если fetch_nested равен true. | ||
| poll_interval целое число | Значение по умолчанию: 3 | Количество секунд, в течение которых модуль ожидает, прежде чем отправить еще один запрос на проверку состояния сущности. | |
| state - |
| Нужно ли установить задачу в состояние present/absent/failed.started является псевдонимом для present. finished является псевдонимом для absent. То же самое относится к этапам.Обратите внимание, что при finished/failed он завершит/остановит все этапы. | |
| steps список | Этапы задачи. | ||
| description - / обязательно | Описание этапа. | ||
| state - |
| Нужно ли установить этап в состояние present/absent/failed. Обратите внимание, что при сбое одного этапа вся задача завершится неудачно. Обратите внимание, что при завершении всех этапов задача также будет завершена. | |
| timeout целое число | Значение по умолчанию: 180 | Время в секундах, которое модуль должен ожидать, пока экземпляр не перейдет в нужное состояние. | |
| wait булево |
| yes если модуль должен ожидать, пока сущность перейдет в нужное состояние. | |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.3.0
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
- name: Create job with two steps
ovirt_job:
description: job_name
steps:
- description: step_name_A
- description: step_name_B
- name: Finish one step
ovirt_job:
description: job_name
steps:
- description: step_name_A
state: finished
- name: When you fail one step whole job will stop
ovirt_job:
description: job_name
steps:
- description: step_name_B
state: failed
- name: Finish all steps
ovirt_job:
description: job_name
state: finished
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | При успехе, если задача найдена. | Идентификатор управляемой задачи Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| job словарь | При успехе, если задача найдена. | Словарь всех атрибутов задачи. Атрибуты задачи можно найти на вашей oVirt/RHV-инстанции по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/job. |
Статус
- Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Martin Necas (@mnecas)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/ovirt_job_module.html
