dellemc.openmanage.redfish_storage_volume модуль — Управляет настройками тома хранения

Примечание

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

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

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

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

Новый в dellemc.openmanage 2.1.0

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

Описание

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

Требования

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

python >= 3.9.6

Параметры

Параметр	Комментарии
apply_time string added in dellemc.openmanage 8.5.0	Время применения конфигурации тома. `Immediate` позволяет применить конфигурацию тома на хост-сервере немедленно и применить изменения. Это применимо для job_wait. `OnReset` позволяет применить изменения при следующей перезагрузке хост-сервера. apply_time имеет значение по умолчанию в зависимости от различных типов контроллера. Например, контроллеры BOSS-S1 и BOSS-N1 имеют значение по умолчанию для apply_time как `OnReset`, а контроллеры PERC имеют значение по умолчанию для apply_time как `Immediate`. Варианты: `"Immediate"` `"OnReset"`
baseuri string / required	IP-адрес целевого внешнего контроллера. Например- <ipaddress>:<port>.
block_size_bytes integer	Размер блока в байтах. Применимо только когда state равно `present`.
ca_path path added in dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат CA, который будет использоваться для проверки.
capacity_bytes string	Размер тома в байтах. Применимо только когда state равно `present`.
command string	`initialize` инициализирует существующий том хранения для указанного volume_id. Варианты: `"initialize"`
controller_id string	Полное описание устройства (FQDD) контроллера хранения. Например- RAID.Slot.1-1. Этот параметр обязателен, когда state равно `present` при создании тома.
drives list / elements=string	FQDD физических дисков. Например- Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1. Применимо только когда state равно `present` при создании нового тома.
encrypted boolean	Указывает, использует ли том шифрование или нет. Применимо только когда state равно `present`. Варианты: `false` `true`
encryption_types string	Можно выбрать следующие типы шифрования. `ControllerAssisted` Том зашифрован сущностью контроллера хранения. `NativeDriveEncryption` Том использует возможности собственного шифрования дисков оборудования накопителя. `SoftwareAssisted` Том зашифрован программным обеспечением, работающим в системе или операционной системе. Применимо только когда state равно `present`. Варианты: `"NativeDriveEncryption"` `"ControllerAssisted"` `"SoftwareAssisted"`
force_reboot boolean added in dellemc.openmanage 8.5.0	Принудительно перезагрузить сервер, чтобы применить изменения, если обычная перезагрузка не удалась. force_reboot применим только тогда, когда reboot_server равно `true`. Варианты: `false` ← (default) `true`
initialize_type string	Тип инициализации существующего тома. Применимо только когда command равно `initialize`. Варианты: `"Fast"` ← (default) `"Slow"`
job_wait boolean added in dellemc.openmanage 8.5.0	Этот параметр предоставляет возможность ожидать завершения задания. Это применимо, когда apply_time равно `Immediate`. Это применимо, когда apply_time равно `OnReset` и reboot_server равно `true`. Варианты: `false` ← (default) `true`
job_wait_timeout integer added in dellemc.openmanage 8.5.0	Этот параметр представляет собой максимальное время ожидания job_wait в секундах. Этот параметр применим, когда job_wait равно `true`. По умолчанию: `1200`
name aliases: volume_name string	Имя создаваемого тома. Применимо только когда state равно `present`.
oem dictionary	Включает расширенные полезные данные OEM. Применимо только когда state равно present.

optimum_io_size_bytes integer	Значение размера полосы должно быть кратным 64 * 1024. Применимо только когда state равно `present`.
password string	Пароль целевого контроллера вне полосы. Если пароль не указан, используется переменная среды `IDRAC_PASSWORD`. Пример: export IDRAC_PASSWORD=пароль
raid_type string добавлено в dellemc.openmanage 8.3.0	`RAID0` для создания тома типа RAID0. `RAID1` для создания тома типа RAID1. `RAID5` для создания тома типа RAID5. `RAID6` для создания тома типа RAID6. `RAID10` для создания тома типа RAID10. `RAID50` для создания тома типа RAID50. `RAID60` для создания тома типа RAID60. raid_type взаимоисключает volume_type. Варианты: `"RAID0"` `"RAID1"` `"RAID5"` `"RAID6"` `"RAID10"` `"RAID50"` `"RAID60"`
reboot_server boolean добавлено в dellemc.openmanage 8.5.0	Перезагрузить сервер для применения изменений. reboot_server применимо только когда apply_timeout равен `OnReset` или когда значение по умолчанию для времени применения контроллера равно `OnReset`. Варианты: `false` ← (по умолчанию) `true`
state string	`present` создаёт том для указанного идентификатора контроллера (controller_id) или изменяет том для указанного идентификатора тома (volume_id). Примечание: Изменение свойств существующего тома зависит от возможностей диска и контроллера. `absent` удаляет том для указанного volume_id. Варианты: `"present"` `"absent"`
timeout integer добавлено в dellemc.openmanage 5.0.0	Таймаут на уровне сокета в секундах. По умолчанию: `30`
username string	Имя пользователя целевого контроллера вне полосы. Если имя пользователя не указано, используется переменная среды `IDRAC_USERNAME`. Пример: export IDRAC_USERNAME=имя_пользователя
validate_certs boolean добавлено в dellemc.openmanage 5.0.0	Если `false`, сертификаты SSL не будут проверены. Настраивайте `false` только на управляемых вами сайтах, где используются самозаверяющие сертификаты. До версии коллекции `5.0.0`, validate_certs был `false` по умолчанию. Варианты: `false` `true` ← (по умолчанию)
volume_id string	FQDD существующего тома. Например - Disk.Virtual.4:RAID.Slot.1-1. Этот параметр обязателен в следующих сценариях: state равен `present`, при обновлении тома. state равен `absent`, при удалении тома. command равен `initialize`, при инициализации тома.
volume_type string	Для создания тома необходимо выбрать один из следующих типов тома. `NonRedundant` Том — это устройство хранения без избыточности. `Mirrored` Том — это зеркалирующее устройство. `StripedWithParity` Том — это устройство, которое использует чётность для сохранения избыточной информации. `SpannedMirrors` Том — это объединённый набор зеркалирующих устройств. `SpannedStripesWithParity` Том — это объединённый набор устройств, которые используют чётность для сохранения избыточной информации. volume_type взаимоисключает raid_type. Варианты: `"NonRedundant"` `"Mirrored"` `"StripedWithParity"` `"SpannedMirrors"` `"SpannedStripesWithParity"`
x_auth_token string добавлено в dellemc.openmanage 9.3.0	Токен аутентификации. Если x_auth_token не указан, используется переменная среды `IDRAC_X_AUTH_TOKEN`. Пример: export IDRAC_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

Запускайте этот модуль с системы, имеющей прямой доступ к Redfish API.
Этот модуль поддерживает check_mode.
Этот модуль всегда сообщает об изменениях, когда name и volume_id не указаны. Для поддержки check_mode требуется указать либо name, либо volume_id.
Этот модуль не поддерживает операцию создания томов RAID6 и RAID60 на iDRAC8
Этот модуль поддерживает IPv4 и IPv6 адреса.

Примеры

---
- name: Create a volume with supported options
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "present"
    volume_type: "Mirrored"
    name: "VD0"
    controller_id: "RAID.Slot.1-1"
    drives:
      - Disk.Bay.5:Enclosure.Internal.0-1:RAID.Slot.1-1
      - Disk.Bay.6:Enclosure.Internal.0-1:RAID.Slot.1-1
    block_size_bytes: 512
    capacity_bytes: 299439751168
    optimum_io_size_bytes: 65536
    encryption_types: NativeDriveEncryption
    encrypted: true

- name: Create a volume with minimum options
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "present"
    controller_id: "RAID.Slot.1-1"
    volume_type: "NonRedundant"
    drives:
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1

- name: Create a RAID0 on PERC controller on reset
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    controller_id: "RAID.Slot.1-1"
    raid_type: "RAID0"
    drives:
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-2
    apply_time: OnReset

- name: Create a RAID0 on BOSS controller with restart
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    controller_id: "RAID.Slot.1-1"
    raid_type: "RAID0"
    drives:
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-2
    apply_time: OnReset
    reboot_server: true

- name: Create a RAID0 on BOSS controller with force restart
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    controller_id: "RAID.Slot.1-1"
    raid_type: "RAID0"
    drives:
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-2
    reboot_server: true
    force_reboot: true

- name: Modify a volume's encryption type settings
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "present"
    volume_id: "Disk.Virtual.5:RAID.Slot.1-1"
    encryption_types: "ControllerAssisted"
    encrypted: true

- name: Delete an existing volume
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    volume_id: "Disk.Virtual.5:RAID.Slot.1-1"

- name: Initialize an existing volume
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    command: "initialize"
    volume_id: "Disk.Virtual.6:RAID.Slot.1-1"
    initialize_type: "Slow"

- name: Create a RAID6 volume
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    controller_id: "RAID.Slot.1-1"
    raid_type: "RAID6"
    drives:
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-2
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-3
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-4

- name: Create a RAID60 volume
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    controller_id: "RAID.Slot.1-1"
    raid_type: "RAID60"
    drives:
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-2
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-3
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-4
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-5
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-6
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-7
      - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-8

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

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

Ключ	Описание
error_info словарь	Подробности ошибки HTTP. Возвращается: при ошибке HTTP Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to perform configuration operations because a configuration job for the device already exists.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "IDRAC.1.6.STOR023", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "Wait for the current job for the device to complete or cancel the current job before attempting more configuration operations on the device.", "Severity": "Informational"}], "code": "Base.1.2.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information"}}
msg строка	Общий статус операции конфигурирования хранилища. Возвращается: всегда Пример: `"Successfully submitted create volume task."`
task словарь	Возвращает идентификатор и URI созданной задачи. Возвращается: при успехе Пример: `{"id": "JID_XXXXXXXXXXXXX", "uri": "/redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_XXXXXXXXXXXXX"}`

Авторы

Sajna Shetty(@Sajna-Shetty)
Kritika Bhateja(@Kritika-Bhateja-03)
Shivam Sharma(@ShivamSh3)

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

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