Модуль community.general.redfish_config — управление контроллерами внеполосного управления с помощью API Redfish
Примечание
Этот модуль входит в коллекцию community.general (версия 12.6.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.general.
Чтобы использовать коллекцию в плейбуке, укажите: community.general.redfish_config.
Обзор
- Формирует URI Redfish локально и отправляет их удалённым контроллерам внеполосного управления для установки или обновления атрибута конфигурации.
- Управляет настройками конфигурации BIOS.
- Управляет настройками конфигурации контроллера внеполосного управления.
Параметры
Параметр | Комментарии |
|---|---|
auth_token string добавлен в community.general 2.3.0 | Токен безопасности для аутентификации на контроллере внеполосного управления. |
baseuri string / обязательный | Базовый URI контроллера внеполосного управления. |
bios_attributes dictionary добавлен в community.general 0.2.0 | Словарь атрибутов BIOS для обновления. По умолчанию: |
boot_order list / элементы=string добавлен в community.general 0.2.0 | Список строк BootOptionReference, задающих BootOrder. По умолчанию: |
ca_path path добавлен в community.general 10.6.0 | Файл в формате PEM, содержащий сертификат CA для проверки. Используется только при условии |
category string / обязательный | Категория команд для выполнения на контроллере внеполосного управления. |
ciphers list / элементы=string добавлен в community.general 9.2.0 | Шифры TLS/SSL для использования в запросе. Если указать список, все шифры будут объединены по порядку с помощью Подробнее см. в разделе Формат списка шифров OpenSSL. Доступные шифры зависят от версий Python и OpenSSL/LibreSSL. |
command list / элементы=string / обязательный | Список команд для выполнения на контроллере внеполосного управления. |
hostinterface_config dictionary добавлен в community.general 4.1.0 | Словарь настроек HostInterface на контроллере внеполосного управления. По умолчанию: |
hostinterface_id string добавлен в community.general 4.1.0 | ID экземпляра Redfish HostInterface, если существует несколько HostInterface. |
network_protocols dictionary добавлен в community.general 0.2.0 | Словарь настроек служб менеджера для обновления. По умолчанию: |
nic_addr string добавлен в community.general 0.2.0 | Строка адреса EthernetInterface на контроллере внеполосного управления. По умолчанию: |
nic_config dictionary добавлен в community.general 0.2.0 | Словарь настроек EthernetInterface на контроллере внеполосного управления. По умолчанию: |
password string | Пароль для аутентификации на контроллере внеполосного управления. |
power_restore_policy string добавлен в community.general 10.5.0 | Требуемое состояние питания системы после восстановления питания вследствие сбоя. Варианты:
|
resource_id string добавлен в community.general 0.2.0 | ID системы, менеджера или шасси для изменения. |
secure_boot_enable boolean добавлен в community.general 7.5.0 | Параметр для включения или отключения SecureBoot. Варианты:
|
service_id string добавлен в community.general 8.4.0 | ID менеджера для обновления. |
sessions_config dictionary добавлен в community.general 5.7.0 | Словарь настроек сеансов. По умолчанию: |
storage_none_volume_deletion boolean добавлен в community.general 9.5.0 | Указывает, удаляются ли автоматически все тома без RAID перед созданием нового тома. Варианты:
|
storage_subsystem_id string добавлен в community.general 7.3.0 | ID подсистемы хранения, в которой создаётся том. По умолчанию: |
strip_etag_quotes boolean добавлен в community.general 3.7.0 | Удаляет кавычки вокруг etag, используемого в заголовке Используйте этот параметр только для устранения проблем с некорректной реализацией производителя, при которой Варианты:
|
timeout integer | Тайм-аут в секундах для HTTP-запросов к контроллеру внеполосного управления. Значение этого параметра по умолчанию изменилось с По умолчанию: |
username string | Имя пользователя для аутентификации на контроллере внеполосного управления. |
validate_certs boolean добавлен в community.general 10.6.0 | Если Установите значение Варианты:
|
volume_details dictionary добавлен в community.general 7.5.0 | Словарь настроек создаваемого тома. Если в этом словаре не указан ключ По умолчанию: |
volume_ids list / элементы=string добавлен в community.general 7.3.0 | Список ID томов для удаления. По умолчанию: |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: отсутствует | Может работать в режиме |
diff_mode | Поддержка: отсутствует | В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в |
Примеры
- name: Set BootMode to UEFI
community.general.redfish_config:
category: Systems
command: SetBiosAttributes
resource_id: 437XR1138R2
bios_attributes:
BootMode: "Uefi"
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Set multiple BootMode attributes
community.general.redfish_config:
category: Systems
command: SetBiosAttributes
resource_id: 437XR1138R2
bios_attributes:
BootMode: "Bios"
OneTimeBootMode: "Enabled"
BootSeqRetry: "Enabled"
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Enable PXE Boot for NIC1
community.general.redfish_config:
category: Systems
command: SetBiosAttributes
resource_id: 437XR1138R2
bios_attributes:
PxeDev1EnDis: Enabled
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Set BIOS default settings with a timeout of 20 seconds
community.general.redfish_config:
category: Systems
command: SetBiosDefaultSettings
resource_id: 437XR1138R2
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
timeout: 20
- name: Set boot order
community.general.redfish_config:
category: Systems
command: SetBootOrder
boot_order:
- Boot0002
- Boot0001
- Boot0000
- Boot0003
- Boot0004
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Set boot order to the default
community.general.redfish_config:
category: Systems
command: SetDefaultBootOrder
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Set Manager Network Protocols
community.general.redfish_config:
category: Manager
command: SetNetworkProtocols
network_protocols:
SNMP:
ProtocolEnabled: true
Port: 161
HTTP:
ProtocolEnabled: false
Port: 8080
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Set Manager NIC
community.general.redfish_config:
category: Manager
command: SetManagerNic
nic_config:
DHCPv4:
DHCPEnabled: false
IPv4StaticAddresses:
Address: 192.168.1.3
Gateway: 192.168.1.1
SubnetMask: 255.255.255.0
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Disable Host Interface
community.general.redfish_config:
category: Manager
command: SetHostInterface
hostinterface_config:
InterfaceEnabled: false
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Enable Host Interface for HostInterface resource ID '2'
community.general.redfish_config:
category: Manager
command: SetHostInterface
hostinterface_config:
InterfaceEnabled: true
hostinterface_id: "2"
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Set SessionService Session Timeout to 30 minutes
community.general.redfish_config:
category: Sessions
command: SetSessionService
sessions_config:
SessionTimeout: 1800
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Enable SecureBoot
community.general.redfish_config:
category: Systems
command: EnableSecureBoot
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
- name: Set SecureBoot
community.general.redfish_config:
category: Systems
command: SetSecureBoot
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
secure_boot_enable: true
- name: Delete All Volumes
community.general.redfish_config:
category: Systems
command: DeleteVolumes
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
storage_subsystem_id: "DExxxxxx"
volume_ids: ["volume1", "volume2"]
- name: Create Volume
community.general.redfish_config:
category: Systems
command: CreateVolume
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
storage_subsystem_id: "DExxxxxx"
volume_details:
Name: "MR Volume"
RAIDType: "RAID0"
Drives:
- "/redfish/v1/Systems/1/Storage/DE00B000/Drives/1"
- name: Set PowerRestorePolicy
community.general.redfish_config:
category: Systems
command: SetPowerRestorePolicy
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
power_restore_policy: "AlwaysOff"
- name: Set service identification to {{ service_id }}
community.general.redfish_config:
category: Manager
command: SetServiceIdentification
service_id: "{{ service_id }}"
baseuri: "{{ baseuri }}"
username: "{{ username }}"
password: "{{ password }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
msg string | Сообщение с результатом действия или описанием ошибки. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/redfish_config_module.html