dellemc.openmanage.idrac_storage_volume module – Configures the RAID configuration attributes
Note
This module is part of the dellemc.openmanage collection (version 9.12.3).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
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.idrac_storage_volume.
New in dellemc.openmanage 9.1.0
Synopsis
This module is responsible for configuring the RAID attributes.
Aliases: dellemc_idrac_storage_volume
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Virtual disk size in GB. |
|
Fully Qualified Device Descriptor (FQDD) of the storage controller, for example ‘RAID.Integrated.1-1’. Controller FQDD is required for |
|
Disk Cache Policy. Choices:
|
|
iDRAC IP Address. |
|
iDRAC user password. If the password is not provided, then the environment variable Example: export IDRAC_PASSWORD=password |
|
iDRAC port. Default: |
|
iDRAC username. If the username is not provided, then the environment variable Example: export IDRAC_USERNAME=username |
|
This parameter provides the option to wait for the job completion. This is applicable when state is Choices:
|
|
This parameter is the maximum wait time of job_wait in seconds. This option is applicable when job_wait is Default: |
|
Media type. Choices:
|
|
Number of Dedicated Hot Spare. Default: |
|
Bus protocol. Choices:
|
|
This option represents initialization configuration operation to be performed on the virtual disk. Choices:
|
|
This option represents whether a reset config operation needs to be performed on the RAID controller. Reset Config operation deletes all the virtual disks present on the RAID controller. Choices:
|
|
Read cache policy. Choices:
|
|
Number of spans in the RAID configuration. span_depth is required for Default: |
|
Number of disks in a span. span_length is required for Default: |
|
Choices:
|
|
Stripe size value to be provided in multiples of 64 * 1024. Default: |
|
The maximum wait time before shutdown in seconds for the Server Configuration Profile (SCP) import operation. This option is applicable when state is Default: |
|
The socket level timeout in seconds. Default: |
|
If Configure Prior to collection version Choices:
|
|
Fully Qualified Device Descriptor (FQDD) of the virtual disk, for example ‘Disk.virtual.0:RAID.Slot.1-1’. This option is used to get the virtual disk information. |
|
Provide the the required RAID level. Choices:
|
|
A list of virtual disk specific iDRAC attributes. This is applicable for For The drives is a required option for In iDRAC8, there is no pre-validation for the state of drives. The disk ID or slot number of the drive provided may or may not be in Ready state. Enter the disk ID or slot number of the drive that is already in Ready state. For See the examples for more details. |
|
Write cache policy. Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export IDRAC_X_AUTH_TOKEN=x_auth_token |
Notes
Note
Run this module from a system that has direct access to Integrated Dell Remote Access Controller.
This module supports both IPv4 and IPv6 address for idrac_ip.
This module supports
check_mode.This module does not display the controller battery details for the
viewoperation of the storage in iDRAC8.
Examples
---
- name: Create single volume
dellemc.openmanage.idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
ca_path: "/path/to/ca_cert.pem"
state: "create"
controller_id: "RAID.Slot.1-1"
volumes:
- drives:
location: [5]
- name: Create multiple volume
dellemc.openmanage.idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
ca_path: "/path/to/ca_cert.pem"
raid_reset_config: "True"
state: "create"
controller_id: "RAID.Slot.1-1"
volume_type: "RAID 1"
span_depth: 1
span_length: 2
number_dedicated_hot_spare: 1
disk_cache_policy: "Enabled"
write_cache_policy: "WriteBackForce"
read_cache_policy: "ReadAhead"
stripe_size: 65536
capacity: 100
raid_init_operation: "Fast"
volumes:
- name: "volume_1"
drives:
id: ["Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1", "Disk.Bay.2:Enclosure.Internal.0-1:RAID.Slot.1-1"]
- name: "volume_2"
volume_type: "RAID 5"
span_length: 3
span_depth: 1
drives:
location: [7, 3, 5]
disk_cache_policy: "Disabled"
write_cache_policy: "WriteBack"
read_cache_policy: "NoReadAhead"
stripe_size: 131072
capacity: "200"
raid_init_operation: "None"
- name: View all volume details
dellemc.openmanage.idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
ca_path: "/path/to/ca_cert.pem"
state: "view"
- name: View specific volume details
dellemc.openmanage.idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
ca_path: "/path/to/ca_cert.pem"
state: "view"
controller_id: "RAID.Slot.1-1"
volume_id: "Disk.Virtual.0:RAID.Slot.1-1"
- name: Delete single volume
dellemc.openmanage.idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
ca_path: "/path/to/ca_cert.pem"
state: "delete"
volumes:
- name: "volume_1"
- name: Delete multiple volume
dellemc.openmanage.idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
ca_path: "/path/to/ca_cert.pem"
state: "delete"
volumes:
- name: "volume_1"
- name: "volume_2"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Overall status of the storage configuration operation. Returned: always Sample: |
|
Storage configuration job and progress details from the iDRAC. Returned: success Sample: |