модуль community.general.ocapi_command — управление автономными контроллерами с помощью 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_command.

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

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

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

Локально формирует URI OCAPI и отправляет их удалённым контроллерам OOB для выполнения действия.
Управляет контроллерами OOB, например индикатором LED, перезагрузкой, режимом питания и обновлением прошивки.

Параметры

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

Атрибуты

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

Примеры

- name: Set the power state to low
  community.general.ocapi_command:
    category: Chassis
    command: PowerModeLow
    baseuri: "{{ baseuri }}"
    username: "{{ username }}"
    password: "{{ password }}"

- name: Set the power state to normal
  community.general.ocapi_command:
    category: Chassis
    command: PowerModeNormal
    baseuri: "{{ baseuri }}"
    username: "{{ username }}"
    password: "{{ password }}"
- name: Set chassis indicator LED to on
  community.general.ocapi_command:
    category: Chassis
    command: IndicatorLedOn
    baseuri: "{{ baseuri }}"
    proxy_slot_number: 2
    username: "{{ username }}"
    password: "{{ password }}"
- name: Set chassis indicator LED to off
  community.general.ocapi_command:
    category: Chassis
    command: IndicatorLedOff
    baseuri: "{{ baseuri }}"
    proxy_slot_number: 2
    username: "{{ username }}"
    password: "{{ password }}"
- name: Reset Enclosure
  community.general.ocapi_command:
    category: Systems
    command: PowerGracefulRestart
    baseuri: "{{ baseuri }}"
    proxy_slot_number: 2
    username: "{{ username }}"
    password: "{{ password }}"
- name: Firmware Upload
  community.general.ocapi_command:
    category: Update
    command: FWUpload
    baseuri: "iom1.wdc.com"
    proxy_slot_number: 2
    username: "{{ username }}"
    password: "{{ password }}"
    update_image_path: "/path/to/firmware.tar.gz"
- name: Firmware Update
  community.general.ocapi_command:
    category: Update
    command: FWUpdate
    baseuri: "iom1.wdc.com"
    proxy_slot_number: 2
    username: "{{ username }}"
    password: "{{ password }}"
- name: Firmware Activate
  community.general.ocapi_command:
    category: Update
    command: FWActivate
    baseuri: "iom1.wdc.com"
    proxy_slot_number: 2
    username: "{{ username }}"
    password: "{{ password }}"
- name: Delete Job
  community.general.ocapi_command:
    category: Jobs
    command: DeleteJob
    job_name: FirmwareUpdate
    baseuri: "{{ baseuri }}"
    proxy_slot_number: 2
    username: "{{ username }}"
    password: "{{ password }}"

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

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

Ключ	Описание
jobUri string	URI для отслеживания состояния операции. Возвращается для асинхронных команд, таких как обновление и активация прошивки. Возвращается: если поддерживается Пример: `"https://ioma.wdc.com/Storage/Devices/openflex-data24-usalp03020qb0003/Jobs/FirmwareUpdate/"`
msg string	Сообщение с результатом действия или описанием ошибки. Возвращается: всегда Пример: `"Action was successful"`
operationStatusId integer	Идентификатор состояния OCAPI (возможные значения см. в документации OCAPI). Возвращается: если поддерживается Пример: `2`

Авторы

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_command_module.html