dellemc.openmanage.idrac_redfish_storage_controller модуль — Настройка физических дисков, виртуальных дисков и параметров контроллера хранения

Примечание

Этот модуль входит в коллекцию dellemc.openmanage (версия 9.7.0).

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

Для установки используйте: ansible-galaxy collection install dellemc.openmanage. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в плейбуке укажите: dellemc.openmanage.idrac_redfish_storage_controller.

Добавлен в dellemc.openmanage 2.1.0

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

Описание

Этот модуль позволяет пользователям настраивать параметры физических дисков, виртуальных дисков и контроллера хранения.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 3.9.6

Параметры

Параметр	Комментарии
apply_time строка	Время применения атрибутов. Применимо только к атрибутам. `Immediate` Позволяет пользователю немедленно перезагрузить хост и применить изменения. Применимо job_wait. `OnReset` Позволяет пользователю применить изменения при следующей перезагрузке сервера. `AtMaintenanceWindowStart` Позволяет пользователю применить изменения в начале запланированного окна технического обслуживания, как указано в maintenance_window. `InMaintenanceWindowOnReset` Позволяет применить изменения после ручного сброса, но в рамках окна технического обслуживания, как указано в maintenance_window. Варианты: `"Immediate"` ← (по умолчанию) `"OnReset"` `"AtMaintenanceWindowStart"` `"InMaintenanceWindowOnReset"`
attributes словарь	Словарь пар «атрибут-значение» контроллера. Эта функция поддерживается только для iDRAC9 с версией микропрограммы 6.00.00.00 и выше Для этой операции требуется controller_id. apply_time и maintenance_window применимы для attributes. attributes несовместим с command. Используйте https://I(idrac_ip/redfish/v1/Schemas/DellOemStorageController.json) для просмотра атрибутов.
baseuri строка / обязательный	IP-адрес целевого контроллера вне полосы пропускания. Например, <ipaddress>:<port>.
ca_path путь добавлен в dellemc.openmanage 5.0.0	Файл с сертификатом CA в формате PEM, используемый для проверки.
command строка	Эти действия могут потребовать перезагрузки системы в зависимости от возможностей контроллера. `ResetConfig` - Удаляет все виртуальные диски и отключает все горячие резервы на физических дисках. Требуется controller_id. `AssignSpare` - Назначает физический диск в качестве выделенного или глобального горячего резерва для виртуального диска. Требуется target. `SetControllerKey` - Устанавливает ключ на контроллерах, который используется для шифрования дисков в Local Key Management (LKM). Требуются controller_id, key и key_id. `RemoveControllerKey` - Удаляет ключ шифрования на контроллере. Требуется controller_id. `ReKey` - Сбрасывает ключ на контроллере, и он всегда сообщает об обнаруженных изменениях при включенном режиме проверки. Требуются controller_id, old_key, key_id и key. `UnassignSpare` - Отменить назначение глобального или выделенного горячего резерва. Требуется target. `EnableControllerEncryption` - Включить Local Key Management (LKM) или Secure Enterprise Key Manager (SEKM) на контроллерах, поддерживающих шифрование дисков. Требуются controller_id, key и key_id. `BlinkTarget` - Мигает целевым виртуальным диском или физическим диском, и он всегда сообщает об обнаруженных изменениях при включенном режиме проверки. Требуется target или volume_id. `UnBlinkTarget` - Отключить мигание целевого виртуального диска или физического диска, и он всегда сообщает об обнаруженных изменениях при включенном режиме проверки. Требуется target или volume_id. `ConvertToRAID` - Преобразовать диск из не-RAID в RAID. Требуется target. `ConvertToNonRAID` - Преобразовать диск из RAID в не-RAID. Требуется target. `ChangePDStateToOnline` - Установить статус диска в «online». Требуется target. `ChangePDStateToOffline` - Установить статус диска в «offline». Требуется target. `LockVirtualDisk` - Зашифровать виртуальный диск. Требуется volume_id. `OnlineCapacityExpansion` - Увеличить размер виртуального диска. Требуются volume_id, и target или size. `SecureErase` - Безопасное удаление всех данных с физического диска. Этот параметр доступен для самошифрующихся дисков (SED), дисков Instant Scramble Erase (ISE) и устройств PCIe SSD (диски и карты). Диски должны быть в состоянии готовности. Требуются controller_id и target, target должен быть идентификатором одного физического диска. Если для безопасного стирания требуется перезагрузка, задача будет запланирована и будет ожидать указанного в job_wait_time количества секунд. Чтобы уменьшить время ожидания, либо задайте меньшее значение job_wait_time, либо установите job_wait в значение false. Варианты: `"ResetConfig"` `"AssignSpare"` `"SetControllerKey"` `"RemoveControllerKey"` `"ReKey"` `"UnassignSpare"` `"EnableControllerEncryption"` `"BlinkTarget"` `"UnBlinkTarget"` `"ConvertToRAID"` `"ConvertToNonRAID"` `"ChangePDStateToOnline"` `"ChangePDStateToOffline"` `"LockVirtualDisk"` `"OnlineCapacityExpansion"` `"SecureErase"`
controller_id строка	Полное описание устройства (FQDD) контроллера хранилища. Например, ‘RAID.Slot.1-1’. Этот параметр обязателен, когда command равен `ResetConfig`, `SetControllerKey`, `RemoveControllerKey`, `ReKey`, или `EnableControllerEncryption`. Этот параметр обязателен для attributes.
job_wait булево	Предоставляет возможность ожидания завершения задачи модулем. Применимо для attributes, когда apply_time равен `Immediate` и когда command равен `SecureErase`. Варианты: `false` ← (по умолчанию) `true`
job_wait_timeout целое число	Максимальное время ожидания завершения задачи в секундах до остановки отслеживания задачи. Этот параметр применим, когда job_wait равен `true`. Примечание: когда command равен `SecureErase`, если для безопасного стирания требуется перезагрузка, задача будет запланирована и будет ожидать указанного в job_wait_time количества секунд. Чтобы уменьшить время ожидания, либо задайте меньшее значение job_wait_time, либо установите job_wait в значение false. По умолчанию: `120`
key строка	Новый пароль ключа безопасности, который использует контроллер, способный к шифрованию, для создания ключа шифрования. Контроллер использует ключ шифрования для блокировки или разблокировки доступа к самошифрующемуся диску (SED). Для каждого контроллера может быть создан только один ключ шифрования. Обязательный параметр, когда command равен `SetControllerKey`, `ReKey`, или `EnableControllerEncryption` и когда mode равен `LKM`. Длина ключа может составлять максимум 32 символа, где расширенная форма специального символа учитывается как один символ. Ключ должен содержать по крайней мере один символ из каждой категории символов: заглавные буквы, строчные буквы, цифры и специальные символы.

END_OF_DOCUMENT_MARKER

key_id string	Это текстовая метка, введённая пользователем, связанная с парольной фразой. Это обязательно, когда command равно `SetControllerKey`, `ReKey`, или `EnableControllerEncryption`, и когда mode равно `LKM`. Длина key_id может составлять не более 32 символов и не должна содержать пробелов.
maintenance_window dictionary	Опция для планирования окна технического обслуживания. Это требуется, когда apply_time равно `AtMaintenanceWindowStart` или `InMaintenanceWindowOnReset`.
duration integer	Продолжительность окна технического обслуживания в секундах. По умолчанию: `900`
start_time string / обязательно	Время начала планируемого окна технического обслуживания. Формат: ГГГГ-ММ-ДДТчч:мм:сс<смещение> <смещение> — смещение от UTC, заданное текущим часовым поясом iDRAC в формате: +05:30 для IST.
mode string	Режим шифрования для контроллера, поддерживающего шифрование. Эта опция применима только когда command равно `ReKey` или `EnableControllerEncryption`. `SEKM` требует лицензии secure enterprise key manager на iDRAC. `LKM` для выбора режима локального ключа. Варианты: `"LKM"` ← (по умолчанию) `"SEKM"`
old_key string	Парольная фраза для ключа безопасности, используемого контроллером, поддерживающим шифрование. Эта опция обязательна, когда command равно `ReKey` и mode равно `LKM`.
password string	Пароль целевого контроллера вне полосы. Если пароль не указан, используется переменная окружения `IDRAC_PASSWORD`. Пример: export IDRAC_PASSWORD=password
size integer	Ёмкость виртуального диска, подлежащего расширению, в МБ. Режим проверки и идемпотентность для size не поддерживаются. Минимальный размер расширения онлайн-ёмкости должен быть больше 100 МБ текущего размера. Когда command равно `OnlineCapacityExpansion`, size взаимоисключает target.
target псевдонимы: drive_id список / элементы=строка	Полное квалифицированное описание устройства (FQDD) целевого физического диска. Это обязательно, когда command равно `AssignSpare`, `UnassisgnSpare`, `ChangePDStateToOnline`, `ChangePDStateToOffline`, `ConvertToRAID`, или `ConvertToNonRAID`. Если volume_id не указан или пустой, этот физический диск будет назначен в качестве глобальной горячей замены, когда command равно `AssignSpare`. Когда command равно `OnlineCapacityExpansion`, target взаимоисключает size. Примечания: Глобальную или выделенную горячую замену можно назначить только один раз для физического диска, переназначение невозможно, когда command равно `AssignSpare`.
timeout целое число добавлено в dellemc.openmanage 5.0.0	Таймаут уровня сокета в секундах. По умолчанию: `30`
username строка	Имя пользователя целевого контроллера вне полосы. Если имя пользователя не указано, используется переменная среды `IDRAC_USERNAME`. Пример: export IDRAC_USERNAME=username
validate_certs логическое значение добавлено в dellemc.openmanage 5.0.0	Если `false`, сертификаты SSL не будут проверены. Настраивать `false` следует только на контролируемых вами сайтах, где используются собственноручно подписанные сертификаты. До версии сборки `5.0.0`, validate_certs по умолчанию `false`. Варианты: `false` `true` ← (по умолчанию)
volume_id список / элементы=строка	Полное квалифицированное описание устройства (FQDD) тома. Применимо, если command равно `AssignSpare`, `BlinkTarget`, `UnBlinkTarget` или `LockVirtualDisk`. volume_id или target требуются, когда command равно `BlinkTarget` или `UnBlinkTarget`, если оба указаны, то учитывается target. Для получения информации о количестве томов, к которым можно назначить горячую замену, обратитесь к документации по API iDRAC Redfish.
x_auth_token строка добавлено в dellemc.openmanage 9.3.0	Токен аутентификации. Если x_auth_token не указан, используется переменная среды `IDRAC_X_AUTH_TOKEN`. Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

Запускайте этот модуль с системы, имеющей прямой доступ к Dell iDRAC.
Этот модуль поддерживается на iDRAC9.
Этот модуль поддерживает IPv4 и IPv6 адреса.
Этот модуль всегда сообщает об изменениях, когда command равно ReKey, BlinkTarget, и UnBlinkTarget.
Этот модуль поддерживает check_mode.

Примеры

---
- name: Assign dedicated hot spare
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    volume_id:
      - "Disk.Virtual.0:RAID.Slot.1-1"
    target: "Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1"
  tags:
    - assign_dedicated_hot_spare

- name: Assign global hot spare
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    target: "Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1"
  tags:
    - assign_global_hot_spare

- name: Unassign hot spare
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    target: "Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1"
    command: UnassignSpare
  tags:
    - un-assign-hot-spare

- name: Set controller encryption key
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "SetControllerKey"
    controller_id: "RAID.Slot.1-1"
    key: "PassPhrase@123"
    key_id: "mykeyid123"
  tags:
    - set_controller_key

- name: Rekey in LKM mode
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "ReKey"
    controller_id: "RAID.Slot.1-1"
    key: "NewPassPhrase@123"
    key_id: "newkeyid123"
    old_key: "OldPassPhrase@123"
  tags:
    - rekey_lkm

- name: Rekey in SEKM mode
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "ReKey"
    controller_id: "RAID.Slot.1-1"
    mode: "SEKM"
  tags:
    - rekey_sekm

- name: Remove controller key
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "RemoveControllerKey"
    controller_id: "RAID.Slot.1-1"
  tags:
    - remove_controller_key

- name: Reset controller configuration
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "ResetConfig"
    controller_id: "RAID.Slot.1-1"
  tags:
    - reset_config

- name: Enable controller encryption
  idrac_redfish_storage_controller:
    baseuri: "{{ baseuri }}"
    username: "{{ username }}"
    password: "{{ password }}"
    ca_path: "/path/to/ca_cert.pem"
    command: "EnableControllerEncryption"
    controller_id: "RAID.Slot.1-1"
    mode: "LKM"
    key: "your_Key@123"
    key_id: "your_Keyid@123"
  tags:
    - enable-encrypt

- name: Blink physical disk.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: BlinkTarget
    target: "Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1"
  tags:
    - blink-target

- name: Blink virtual drive.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: BlinkTarget
    volume_id: "Disk.Virtual.0:RAID.Slot.1-1"
  tags:
    - blink-volume

- name: Unblink physical disk.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: UnBlinkTarget
    target: "Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1"
  tags:
    - unblink-target

- name: Unblink virtual drive.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: UnBlinkTarget
    volume_id: "Disk.Virtual.0:RAID.Slot.1-1"
  tags:
    - unblink-drive

- name: Convert physical disk to RAID
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "ConvertToRAID"
    target: "Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1"
  tags:
    - convert-raid

- name: Convert physical disk to non-RAID
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "ConvertToNonRAID"
    target: "Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1"
  tags:
    - convert-non-raid

- name: Change physical disk state to online.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "ChangePDStateToOnline"
    target: "Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1"
  tags:
    - pd-state-online

- name: Change physical disk state to offline.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "ChangePDStateToOnline"
    target: "Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1"
  tags:
    - pd-state-offline

- name: Lock virtual drive
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    command: "LockVirtualDisk"
    volume_id: "Disk.Virtual.0:RAID.SL.3-1"
  tags:
    - lock

- name: Online Capacity Expansion of a volume using target
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "{{ baseuri }}"
    username: "{{ username }}"
    password: "{{ password }}"
    ca_path: "/path/to/ca_cert.pem"
    command: "OnlineCapacityExpansion"
    volume_id: "Disk.Virtual.0:RAID.Integrated.1-1"
    target:
      - "Disk.Bay.2:Enclosure.Internal.0-0:RAID.Integrated.1-1"
  tags:
    - oce_target

- name: Online Capacity Expansion of a volume using size
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "{{ baseuri }}"
    username: "{{ username }}"
    password: "{{ password }}"
    ca_path: "/path/to/ca_cert.pem"
    command: "OnlineCapacityExpansion"
    volume_id: "Disk.Virtual.0:RAID.Integrated.1-1"
    size: 362785
  tags:
    - oce_size

- name: Set controller attributes.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    controller_id: "RAID.Slot.1-1"
    attributes:
      ControllerMode: "HBA"
    apply_time: "OnReset"
  tags:
    - controller-attribute

- name: Configure controller attributes at Maintenance window
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    controller_id: "RAID.Slot.1-1"
    attributes:
      CheckConsistencyMode: Normal
      CopybackMode: "Off"
      LoadBalanceMode: Disabled
    apply_time: AtMaintenanceWindowStart
    maintenance_window:
      start_time: "2022-09-30T05:15:40-05:00"
      duration: 1200

- name: Perform Secure Erase operation on SED drive
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    ca_path: "/path/to/ca_cert.pem"
    controller_id: "RAID.Slot.1-1"
    command: "SecureErase"
    target: "Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1"

Значения возврата

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

Ключ	Описание
error_info словарь	Подробности ошибки HTTP. Возвращается: при ошибке HTTP Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to run the method because the requested HTTP method is not allowed.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "iDRAC.1.6.SYS402", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "Enter a valid HTTP method and retry the operation. For information about valid methods, see the Redfish Users Guide available on the support site.", "Severity": "Informational"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information"}}
msg строка	Общий статус операции конфигурирования контроллера хранения. Возвращается: всегда Пример: `"Successfully submitted the job that performs the AssignSpare operation"`
status словарь	Статус отправленной задачи. Возвращается: всегда Пример: `{"ActualRunningStartTime": "2022-02-09T04:42:41", "ActualRunningStopTime": "2022-02-09T04:44:00", "CompletionTime": "2022-02-09T04:44:00", "Description": "Job Instance", "EndTime": "TIME_NA", "Id": "JID_444033604418", "JobState": "Completed", "JobType": "RealTimeNoRebootConfiguration", "Message": "Job completed successfully.", "MessageArgs": [], "MessageId": "PR19", "Name": "Configure: RAID.Integrated.1-1", "PercentComplete": 100, "StartTime": "2022-02-09T04:42:40", "TargetSettingsURI": null}`
task словарь	ID и URI ресурса созданной задачи. Возвращается: успех Пример: `{"id": "JID_XXXXXXXXXXXXX", "uri": "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_XXXXXXXXXXXXX"}`

Авторы

Jagadeesh N V (@jagadeeshnv)
Felix Stephen (@felixs88)
Husniya Hameed (@husniya_hameed)
Abhishek Sinha (@ABHISHEK-SINHA10)

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

© 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/dellemc/openmanage/idrac_redfish_storage_controller_module.html