Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_job_facts — получает сведения о заданиях системы хранения.
Примечание
Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install hitachivantara.vspone_block. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_block.sds_block.hv_sds_block_job_facts.
Добавлено в hitachivantara.vspone_block 4.1.0
Краткое описание
- Этот модуль получает сведения о заданиях.
- Он предоставляет подробную информацию о задании, например его идентификатор, состояние, статус и другие сведения.
- Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/job_facts.yml
Требования
На узле, где выполняется этот модуль, должны быть соблюдены следующие требования.
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
connection_info словарь / обязательный | Сведения, необходимые для установления соединения с системой хранения. |
|
address строка / обязательный |
IP-адрес или имя хоста системы хранения. |
|
connection_type строка |
Тип подключения к системе хранения. Варианты:
|
|
password строка / обязательный |
Пароль для аутентификации. Это обязательное поле. |
|
username строка / обязательный |
Имя пользователя для аутентификации. Это обязательное поле. |
spec словарь | Параметры получения сведений о задании. |
|
count целое число |
Количество заданий для получения. Обязателен для задачи «Получить сведения о 10 последних заданиях». |
|
id строка |
Идентификатор задания. Обязателен для задачи «Получить задание по идентификатору». |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Определяет, следует ли запускать модуль в режиме проверки. |
Примеры
- name: Retrieve information about most recent 100 jobs
hitachivantara.vspone_block.sds_block.hv_sds_block_job_facts:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
- name: Retrieve information about most recent 10 jobs
hitachivantara.vspone_block.sds_block.hv_sds_block_job_facts:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
spec:
count: 10
- name: Retrieve information about job by fault job ID
hitachivantara.vspone_block.sds_block.hv_sds_block_job_facts:
connection_info:
address: sdsb.company.com
username: "admin"
password: "password"
spec:
id: "c0b833cd-1fee-417d-bbf2-d25aac767ad4"
Возвращаемые факты
Факты, возвращаемые этим модулем, добавляются в факты узла hostvars или обновляют их; на них можно ссылаться по имени, как и на любые другие факты узла. Чтобы использовать эти факты, их не нужно регистрировать.
Ключ | Описание |
|---|---|
jobs список / элементы=словарь | Список заданий. Возвращается: успешно |
|
job_info словарь |
Сведения о задании. Возвращается: успешно |
|
affected_resources список / элементы=словарь |
Список ресурсов, затронутых заданием. Возвращается: успешно Пример: |
|
completed_time строка |
Время завершения задания. Возвращает null, если задание не завершено. Возвращается: успешно Пример: |
|
created_time строка |
Время создания задания. Возвращается: успешно Пример: |
|
error словарь |
Сведения об ошибке, если задание завершилось с ошибкой. Пустой словарь, если ошибки нет. Возвращается: успешно Пример: |
|
job_id строка |
Идентификатор задания. Возвращается: успешно Пример: |
|
request словарь |
Сведения о HTTP-запросе, инициировавшем задание. Возвращается: успешно |
|
request_body строка |
Тело запроса, запустившего задание. Возвращается: успешно Пример: |
|
request_method строка |
Метод HTTP, использованный для запроса. Возвращается: успешно Пример: |
|
request_url строка |
Путь URL запроса на устройстве. Возвращается: успешно Пример: |
|
self строка |
Путь API к ресурсу задания. Возвращается: успешно Пример: |
|
state строка |
Состояние задания. Возвращается: успешно Пример: |
|
status строка |
Ход выполнения задания. Возвращается: успешно Пример: |
|
updated_time строка |
Время обновления состояния задания. Возвращается: успешно Пример: |
|
user_id строка |
Идентификатор пользователя, инициировавшего задание. Возвращается: успешно Пример: |
Ссылки на коллекцию
© 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/hitachivantara/vspone_block/sds_block.hv_sds_block_job_facts_module.html