Модуль hitachivantara.vspone_object.oneobject_node.hv_jobs_facts — получение информации о заданиях из VSP One Object

Примечание

Этот модуль входит в коллекцию hitachivantara.vspone_object (версия 1.1.1).

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

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

Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_object.oneobject_node.hv_jobs_facts.

Добавлено в hitachivantara.vspone_object 1.0.0

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

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

Этот модуль запрашивает сведения о заданиях в Hitachi VSP One Object.

Требования

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

python >= 3.7

Параметры

Параметр	Комментарии
connection_info dictionary / обязательный	Сведения, необходимые для подключения к системе.
cluster_name string / обязательный	Имя кластера системы.
http_request_retry_interval_seconds integer / обязательный	Интервал между повторными попытками выполнения HTTP-запроса.
http_request_retry_times integer / обязательный	Количество повторных попыток выполнения HTTP-запроса.
http_request_timeout integer / обязательный	Тайм-аут HTTP-запросов.
oneobject_node_client_id string / обязательный	Идентификатор для аутентификации.
oneobject_node_client_secret string	Секрет для аутентификации.
oneobject_node_username string / обязательный	Имя пользователя для аутентификации.
oneobject_node_userpass string / обязательный	Пароль для аутентификации.
region string / обязательный	Регион системы.
ssl dictionary	Конфигурация SSL.
ca_certs string	Путь к файлу сертификатов CA. По умолчанию: `""`
ca_path string	Путь к файлу сертификата CA. По умолчанию: `""`
check_hostname boolean	Проверять ли имя хоста. Варианты: `false` ← (по умолчанию) `true`
client_cert string	Путь к файлу сертификата клиента. По умолчанию: `""`
client_key string	Путь к файлу ключа клиента. По умолчанию: `""`
ssl_cipher string	Используемый шифр SSL. По умолчанию: `""`
ssl_version string	Используемая версия SSL. По умолчанию: `""`
validate_certs boolean / обязательный	Проверять ли сертификаты SSL. Варианты: `false` `true`
spec dictionary	Параметры запроса для получения заданий.
bucket_name string	Имя бакета.
job_id integer	UUID заданий.
page_size integer	Количество элементов, возвращаемых на одной странице.
query_type string	Определяет, нужен ли список ВСЕХ заданий или СОСТОЯНИЕ конкретного задания. Варианты: `"ALL"` `"STATUS"`
user_id integer	Идентификатор пользователя.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Определяет, должен ли модуль работать в режиме проверки.

Примеры

- name: Get all jobs
  hitachivantara.vspone_object.oneobject_node.hv_jobs_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      user_id: -468170324
      bucket_name: "testbucket"

- name: Get job status
  hitachivantara.vspone_object.oneobject_node.hv_jobs_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      job_id: -769908758
      query_type: "STATUS"

- name: Get n number of jobs
  hitachivantara.vspone_object.oneobject_node.hv_jobs_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      user_id: -468170324
      bucket_name: "testbucket"
      page_size: 5

Возвращаемые факты

Факты, возвращаемые этим модулем, добавляются в факты хоста hostvars или обновляют их; на них можно ссылаться по имени, как и на любые другие факты хоста. Для их использования не требуется регистрировать их.

Ключ	Описание
jobs list / элементы=dictionary	Список заданий с их атрибутами. Возвращается: при успешном выполнении
complete_time float	Время завершения задания. Возвращается: при успешном выполнении Пример: `1752770724.423`
job_id dictionary	Идентификатор задания. Возвращается: при успешном выполнении
id integer	Уникальный идентификатор задания. Возвращается: при успешном выполнении Пример: `-769908758`
job_state string	Текущее состояние задания. Возвращается: при успешном выполнении Пример: `"COMPLETE"`
job_stats dictionary	Статистика задания. Возвращается: при успешном выполнении
failed integer	Количество неудачных операций. Возвращается: при успешном выполнении Пример: `0`
processed integer	Количество обработанных элементов. Возвращается: при успешном выполнении Пример: `0`
job_type string	Тип задания. Возвращается: при успешном выполнении Пример: `"BATCH_REPLICATE"`
start_time float	Время начала задания. Возвращается: при успешном выполнении Пример: `1752770711.809`

Авторы

Hitachi Vantara, LTD. (@hitachi-vantara)

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

© 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_object/oneobject_node.hv_jobs_facts_module.html