Модуль community.general.ocapi_info – Управление контроллерами вне полосы пропускания с использованием Open Composable API (OCAPI)

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.general.ocapi_info.

Новая функция в community.general 6.3.0

Обзор
Параметры
Атрибуты
Примеры
Возвращаемые значения

Обзор

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

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз изменённого статуса без изменения целевого объекта.
diff_mode	Поддержка: Нет Это действие не изменяет состояние.	В режиме разницы вернёт подробности о том, что изменилось (или, возможно, нужно изменить в `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 }}"

END_OF_DOCUMENT_MARKER

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

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

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

Авторы

Mike Moerk (@mikemoerk)

Ссылки на сборку

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