dellemc.openmanage.redfish_storage_volume module – Manages the storage volume configuration
Note
This module is part of the dellemc.openmanage collection (version 8.5.0).
To install it, use: ansible-galaxy collection install dellemc.openmanage
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.redfish_storage_volume
.
New in dellemc.openmanage 2.1.0
Synopsis
This module allows to create, modify, initialize, or delete a single storage volume.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
Apply time of the Volume configuration.
apply_time has a default value based on the different types of the controller. For example, BOSS-S1 and BOSS-N1 controllers have a default value of apply_time as Choices:
|
|
IP address of the target out-of-band controller. For example- <ipaddress>:<port>. |
|
Block size in bytes.Only applicable when state is |
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Volume size in bytes. Only applicable when state is |
|
Choices:
|
|
Fully Qualified Device Descriptor (FQDD) of the storage controller. For example- RAID.Slot.1-1. This option is mandatory when state is |
|
FQDD of the Physical disks. For example- Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1. Only applicable when state is |
|
Indicates whether volume is currently utilizing encryption or not. Only applicable when state is Choices:
|
|
The following encryption types can be selected.
Only applicable when state is Choices:
|
|
Reboot the server forcefully to apply the changes when the normal reboot fails. force_reboot is applicable only when reboot_server is Choices:
|
|
Initialization type of existing volume. Only applicable when command is Choices:
|
|
This parameter provides the option to wait for the job completion. This is applicable when apply_time is This is applicable when apply_time is Choices:
|
|
This parameter is the maximum wait time of job_wait in seconds. This option is applicable when job_wait is Default: |
|
Name of the volume to be created. Only applicable when state is |
|
Includes OEM extended payloads. Only applicable when state is present. |
|
Stripe size value must be in multiples of 64 * 1024. Only applicable when state is |
|
Password of the target out-of-band controller. |
|
raid_type is mutually exclusive with volume_type. Choices:
|
|
Reboot the server to apply the changes. reboot_server is applicable only when apply_timeout is Choices:
|
|
Choices:
|
|
The socket level timeout in seconds. Default: |
|
Username of the target out-of-band controller. |
|
If Configure Prior to collection version Choices:
|
|
FQDD of existing volume. For example- Disk.Virtual.4:RAID.Slot.1-1. This option is mandatory in the following scenarios, state is state is command is |
|
One of the following volume types must be selected to create a volume.
volume_type is mutually exclusive with raid_type. Choices:
|
Notes
Note
Run this module from a system that has direct access to Redfish APIs.
This module supports
check_mode
.This module always reports changes when name and volume_id are not specified. Either name or volume_id is required to support
check_mode
.This module supports IPv4 and IPv6 addresses.
Examples
---
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Details of a http error. Returned: on http error Sample: |
|
Overall status of the storage configuration operation. Returned: always Sample: |
|
Returns ID and URI of the created task. Returned: success Sample: |