модуль community.general.ocapi_info — управление контроллерами внеполосного управления с помощью Open Composable API (OCAPI)

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.ocapi_info.

Добавлено в community.general 6.3.0

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

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

Локально формирует URI OCAPI и отправляет их удалённым контроллерам внеполосного управления, чтобы получить информацию.

Параметры

Параметр	Комментарии
baseuri string / обязательный	Базовый URI контроллера внеполосного управления.
category string / обязательный	Категория для выполнения на контроллере внеполосного управления.
command string / обязательный	Команда для выполнения на контроллере внеполосного управления.
job_name string	Имя задания для получения его состояния.
password string / обязательный	Пароль для аутентификации на контроллере внеполосного управления.
proxy_slot_number integer	Для проксируемых внутриполосных запросов — номер слота IOM. Применяется, только если `baseuri` является прокси-сервером.
timeout integer	Тайм-аут в секундах для URL-запросов к контроллеру внеполосного управления. По умолчанию: `10`
username string / обязательный	Имя пользователя для аутентификации на контроллере внеполосного управления.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: не применимо Это действие не изменяет состояние.	В режиме diff возвращает сведения об изменениях (или о том, что может потребоваться изменить в `check_mode`).

Примеры

- name: Get job status
  community.general.ocapi_info:
    category: Status
    command: JobStatus
    baseuri: "http://iom1.wdc.com"
    jobName: FirmwareUpdate
    username: "{{ username }}"
    password: "{{ password }}"

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

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

Ключ	Описание
details list / элементы=string	Подробные сведения о соответствующей операции. Применяется к `command=JobStatus`. Возвращается: при поддержке
msg string	Сообщение с результатом действия или описанием ошибки. Возвращается: всегда Пример: `"Action was successful"`
operationHealth string	Состояние выполнения операции. Применяется к `command=JobStatus`. Подробности см. в документации OCAPI. Возвращается: при поддержке Пример: `"OK"`
operationHealthId string	Целочисленное значение состояния выполнения операции (соответствует `operationHealth`). Применяется к `command=JobStatus`. Подробности см. в документации OCAPI. Возвращается: при поддержке Пример: `"OK"`
operationStatus string	Состояние соответствующей операции. Применяется к `command=JobStatus`. Подробности см. в документации OCAPI. Возвращается: при поддержке Пример: `"Activate needed"`
operationStatusId integer	Целочисленное значение состояния (соответствует operationStatus). Применяется к `command=JobStatus`. Подробности см. в документации OCAPI. Возвращается: при поддержке Пример: `65540`
percentComplete integer	Процент выполнения соответствующей операции. Применяется к `command=JobStatus`. Возвращается: при поддержке Пример: `99`
status dictionary	Словарь, содержащий сведения о состоянии. Подробности см. в документации OCAPI. Возвращается: при поддержке Пример: `{"Details": ["None"], "Health": [{"ID": 5, "Name": "OK"}], "State": {"ID": 16, "Name": "In service"}}`

Авторы

Mike Moerk (@mikemoerk)

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

© 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/general/ocapi_info_module.html