redfish_command – Управляет контроллерами вне полосы используя Redfish API
Новая версия 2.7.
Описание
- Создаёт Redfish URI локально и отправляет их удалённым контроллерам OOB для выполнения действия.
- Управляет контроллером OOB, например, перезагрузкой, управлением журналами.
- Управляет пользователями контроллера OOB, например, добавлением, удалением, обновлением.
- Управляет питанием системы, например, включением, выключением, плановой и принудительной перезагрузкой.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| baseuri строка / обязательно | Базовый URI контроллера OOB | |
| boot_next строка добавлено в 2.9 | Целевой BootNext при bootdevice "UefiBootNext" | |
| bootdevice строка | bootdevice при настройке конфигурации загрузки | |
| category строка / обязательно | Категория для выполнения на контроллере OOB | |
| command список / обязательно | Список команд для выполнения на контроллере OOB | |
| id строка добавлено в 2.8 | ID пользователя для добавления/удаления/изменения | |
| new_password строка добавлено в 2.8 | Пароль для добавления/удаления/изменения пользователя | |
| new_username строка добавлено в 2.8 | Имя пользователя для добавления/удаления/изменения | |
| password строка / обязательно | Пароль для аутентификации с контроллером OOB | |
| roleid строка добавлено в 2.8 | Роль пользователя для добавления/удаления/изменения | |
| timeout целое число добавлено в 2.8 | По умолчанию: 10 | Таймаут в секундах для запросов URL к контроллеру OOB |
| uefi_target строка добавлено в 2.9 | Целевой UEFI при bootdevice "UefiTarget" | |
| username строка / обязательно добавлено в 2.8 | Имя пользователя для аутентификации с контроллером OOB |
Примеры
- name: Restart system power gracefully
redfish_command:
category: Systems
command: PowerGracefulRestart
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Set one-time boot device to {{ bootdevice }}
redfish_command:
category: Systems
command: SetOneTimeBoot
bootdevice: "{{ bootdevice }}"
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Set one-time boot device to UefiTarget of "/0x31/0x33/0x01/0x01"
redfish_command:
category: Systems
command: SetOneTimeBoot
bootdevice: "UefiTarget"
uefi_target: "/0x31/0x33/0x01/0x01"
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Set one-time boot device to BootNext target of "Boot0001"
redfish_command:
category: Systems
command: SetOneTimeBoot
bootdevice: "UefiBootNext"
boot_next: "Boot0001"
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Set chassis indicator LED to blink
redfish_command:
category: Chassis
command: IndicatorLedBlink
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Add and enable user
redfish_command:
category: Accounts
command: AddUser,EnableUser
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
id: "{{ id }}"
new_username: "{{ new_username }}"
new_password: "{{ new_password }}"
roleid: "{{ roleid }}"
- name: Disable and delete user
redfish_command:
category: Accounts
command: ["DisableUser", "DeleteUser"]
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
id: "{{ id }}"
- name: Update user password
redfish_command:
category: Accounts
command: UpdateUserPassword
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
id: "{{ id }}"
new_password: "{{ new_password }}"
- name: Clear Manager Logs with a timeout of 20 seconds
redfish_command:
category: Manager
command: ClearLogs
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
timeout: 20
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращённое | Описание |
|---|---|---|
| msg строка | всегда | Сообщение с результатом действия или описанием ошибки Пример: Действие выполнено успешно |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Jose Delarosa (@jose-delarosa)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/redfish_command_module.html