dellemc.openmanage.dellemc_idrac_storage_volume – Configures the RAID configuration attributes
Note
This plugin is part of the dellemc.openmanage collection (version 3.6.0).
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.
To use it in a playbook, specify: dellemc.openmanage.dellemc_idrac_storage_volume.
New in version 2.0.0: of dellemc.openmanage
Synopsis
- This module is responsible for configuring the RAID attributes.
Requirements
The below requirements are needed on the host that executes this module.
- omsdk
- python >= 2.7.5
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| capacity
float
|
Virtual disk size in GB.
|
|
| controller_id
string
|
Fully Qualified Device Descriptor (FQDD) of the storage controller, for example 'RAID.Integrated.1-1'. Controller FQDD is required for create RAID configuration.
|
|
| disk_cache_policy
string
|
|
Disk Cache Policy.
|
| idrac_ip
string / required
|
iDRAC IP Address.
|
|
| idrac_password
string / required
|
iDRAC user password.
aliases: idrac_pwd |
|
| idrac_port
integer
|
Default:
443
|
iDRAC port.
|
| idrac_user
string / required
|
iDRAC username.
|
|
| media_type
string
|
|
Media type.
|
| number_dedicated_hot_spare
integer
|
Default:
0
|
Number of Dedicated Hot Spare.
|
| protocol
string
|
|
Bus protocol.
|
| raid_init_operation
string
|
|
This option represents initialization configuration operation to be performed on the virtual disk.
|
| raid_reset_config
string
|
"no"
|
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.
|
| read_cache_policy
string
|
|
Read cache policy.
|
| span_depth
integer
|
Default:
1
|
Number of spans in the RAID configuration.
span_depth is required for create and its value depends on volume_type.
|
| span_length
integer
|
Default:
1
|
Number of disks in a span.
span_length is required for create and its value depends on volume_type.
|
| state
string
|
|
create, performs create volume operation.
delete, performs remove volume operation.
view, returns storage view.
|
| stripe_size
integer
|
Default:
65536
|
Stripe size value to be provided in multiples of 64 * 1024.
|
| volume_id
string
|
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.
|
|
| volume_type
string
|
|
Provide the the required RAID level.
|
| volumes
list / elements=dictionary
|
A list of virtual disk specific iDRAC attributes. This is applicable for
create and delete operations.
For
create operation, name and drives are applicable options, other volume options can also be specified.
The drives is a required option for
create operation and accepts either location (list of drive slot) or id (list of drive fqdd).
For
delete operation, only name option is applicable.
See the examples for more details.
|
|
| write_cache_policy
string
|
|
Write cache policy.
|
Notes
Note
- Run this module from a system that has direct access to DellEMC iDRAC.
- This module supports
check_mode.
Examples
---
- name: Create single volume
dellemc.openmanage.dellemc_idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
state: "create"
controller_id: "RAID.Slot.1-1"
volumes:
- drives:
location: [5]
- name: Create multiple volume
dellemc.openmanage.dellemc_idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
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.dellemc_idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
state: "view"
- name: View specific volume details
dellemc.openmanage.dellemc_idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
state: "view"
controller_id: "RAID.Slot.1-1"
volume_id: "Disk.Virtual.0:RAID.Slot.1-1"
- name: Delete single volume
dellemc.openmanage.dellemc_idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
state: "delete"
volumes:
- name: "volume_1"
- name: Delete multiple volume
dellemc.openmanage.dellemc_idrac_storage_volume:
idrac_ip: "192.168.0.1"
idrac_user: "username"
idrac_password: "password"
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 | Returned | Description |
|---|---|---|
| msg
string
|
always |
Overall status of the storage configuration operation.
Sample:
Successfully completed the view storage volume operation
|
| storage_status
dictionary
|
success |
Storage configuration job and progress details from the iDRAC.
Sample:
{'Id': 'JID_XXXXXXXXX', 'JobState': 'Completed', 'JobType': 'ImportConfiguration', 'Message': 'Successfully imported and applied Server Configuration Profile.', 'MessageId': 'XXX123', 'Name': 'Import Configuration', 'PercentComplete': 100, 'StartTime': 'TIME_NOW', 'Status': 'Success', 'TargetSettingsURI': None, 'retval': True}
|
Authors
- Felix Stephen (@felixs88)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/dellemc_idrac_storage_volume_module.html