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

Новое в community.general 6.3.0

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

Описание

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

Параметры

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

Атрибуты

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

Примеры

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

Авторы

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