Spec-Zone.ru › Ansible

community.general.redfish_config модуль — Управление контроллерами вне полосы пропускания с использованием API Redfish

Примечание

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

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

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

Для использования в книге задач укажите: community.general.redfish_config.

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

Обзор

  • Строит URI Redfish локально и отправляет их удаленным контроллерам OOB для установки или обновления атрибута конфигурации.
  • Управление настройками BIOS.
  • Управление настройками конфигурации контроллера OOB.

Параметры

Параметр

Комментарии

auth_token

string

added in community.general 2.3.0

Маркер безопасности для аутентификации на контроллере OOB.

baseuri

string / required

Базовый URI контроллера OOB.

bios_attributes

dictionary

added in community.general 0.2.0

Словарь атрибутов BIOS для обновления.

Default: {}

boot_order

list / elements=string

added in community.general 0.2.0

Список строк BootOptionReference, указывающих BootOrder.

Default: []

category

string / required

Категория для выполнения на контроллере OOB.

ciphers

list / elements=string

added in community.general 9.2.0

Шифры SSL/TLS для использования в запросе.

Когда предоставляется список, все шифры объединяются в указанном порядке с помощью :.

См. Формат списка шифров OpenSSL для получения более подробной информации.

Доступные шифры зависят от версий Python и OpenSSL/LibreSSL.

command

list / elements=string / required

Список команд для выполнения на контроллере OOB.

hostinterface_config

dictionary

added in community.general 4.1.0

Словарь настроек HostInterface на контроллере OOB.

Default: {}

hostinterface_id

string

added in community.general 4.1.0

ID экземпляра Redfish HostInterface, если присутствует несколько HostInterfaces.

network_protocols

dictionary

added in community.general 0.2.0

Словарь настроек служб управления для обновления.

Default: {}

nic_addr

string

added in community.general 0.2.0

Строка адреса EthernetInterface на контроллере OOB.

Default: "null"

nic_config

dictionary

added in community.general 0.2.0

Словарь настроек EthernetInterface на контроллере OOB.

Default: {}

password

string

Пароль для аутентификации на контроллере OOB.

resource_id

string

added in community.general 0.2.0

ID системы, менеджера или шасси для изменения.

secure_boot_enable

boolean

added in community.general 7.5.0

Параметр для включения или отключения SecureBoot.

Варианты:

  • false
  • true ← (default)

service_id

string

added in community.general 8.4.0

ID менеджера для обновления.

sessions_config

dictionary

added in community.general 5.7.0

Словарь настроек сессий.

Default: {}

storage_none_volume_deletion

boolean

added in community.general 9.5.0

Указывает, будут ли все тома, не относящиеся к RAID, автоматически удалены перед созданием нового тома.

Варианты:

  • false ← (default)
  • true

storage_subsystem_id

string

added in community.general 7.3.0

ID подсистемы хранения, на которой будет создан том.

Default: ""

strip_etag_quotes

boolean

added in community.general 3.7.0

Удаляет окружающие кавычки из тега etag, используемого в If-Match заголовке PATCH запросов.

Используйте этот параметр только для решения проблем с реализацией поставщиков, где If-Match соответствует только строке тега etag без кавычек.

Варианты:

  • false ← (по умолчанию)
  • true

timeout

integer

Таймаут в секундах для HTTP-запросов к контроллеру OOB.

Значение по умолчанию для этого параметра изменилось с 10 на 60 в версии community.general 9.0.0.

По умолчанию: 60

username

string

Имя пользователя для аутентификации на контроллере OOB.

volume_details

dictionary

added in community.general 7.5.0

Установка словаря параметров для создаваемого тома.

Если CapacityBytes ключ не указан в этом словаре, размер тома определяется службой Redfish. Возможна ситуация, когда размер не будет максимальным доступным.

По умолчанию: {}

volume_ids

list / elements=string

added in community.general 7.3.0

Список идентификаторов томов, которые необходимо удалить.

По умолчанию: []

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: нет

Может работать в режиме check_mode и возвращать прогноз статуса изменения без модификации целевого объекта.

diff_mode

Поддержка: нет

Вернёт подробности о том, что изменилось (или, возможно, нужно изменить в check_mode) при работе в режиме diff.

Примеры

- 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 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

Сообщение с результатом действия или описанием ошибки

Возвращается: всегда

Пример: "Action was successful"

Авторы

  • Jose Delarosa (@jose-delarosa)
  • T S Kushal (@TSKushal)

Ссылки на коллекцию

  • Трекер задач
  • Репозиторий (исходники)
  • Задать вопрос
  • Отправить отчет об ошибке
  • Запросить новую функцию
  • Общение

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API