dellemc.openmanage.redfish_storage_volume role – Role to manage the storage volume configuration

Note

This role is part of the dellemc.openmanage collection (version 9.8.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.redfish_storage_volume.

Entry point main – Role to manage the storage volume configuration

New in dellemc.openmanage 7.5.0

Synopsis

  • Role to create, modify, initialize, or delete a single storage volume.

Parameters

Parameter

Comments

apply_time

string

added in dellemc.openmanage 8.5.0

Apply time of the Volume configuration.

Immediate allows you to apply the volume configuration on the host server immediately and apply the changes. This is applicable for job_wait.

OnReset allows you to apply the changes on the next reboot of the host server.

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 OnReset.

PERC controllers have a default value of apply_time as Immediate.

Choices:

  • "Immediate"

  • "OnReset"

block_size_bytes

integer

Block size in bytes.Only applicable when state is present.

ca_path

path

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

capacity_bytes

string

Volume size in bytes.

Only applicable when state is present.

command

string

initialize initializes an existing storage volume for a specified volume_id.

Choices:

  • "initialize"

controller_id

string

Fully Qualified Device Descriptor (FQDD) of the storage controller.

For example- RAID.Slot.1-1.

This option is mandatory when state is present while creating a volume.

drives

list / elements=string

FQDD of the Physical disks.

For example- Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1.

Only applicable when state is present when creating a new volume.

encrypted

boolean

Indicates whether volume is currently utilizing encryption or not.

Only applicable when state is present.

Choices:

  • false

  • true

encryption_types

string

The following encryption types can be selected.

ControllerAssisted The volume is encrypted by the storage controller entity.

NativeDriveEncryption The volume utilizes the native drive encryption capabilities of the drive hardware.

SoftwareAssisted The volume is encrypted by the software running on the system or the operating system.

Only applicable when state is present.

Choices:

  • "NativeDriveEncryption"

  • "ControllerAssisted"

  • "SoftwareAssisted"

force_reboot

boolean

added in dellemc.openmanage 8.5.0

Reboot the server forcefully to apply the changes when the normal reboot fails.

force_reboot is applicable only when reboot_server is true.

Choices:

  • false ← (default)

  • true

hostname

string / required

iDRAC IP Address or hostname.

https_port

integer

iDRAC port.

Default: 443

https_timeout

integer

The HTTPS socket level timeout in seconds.

Default: 30

initialize_type

string

Initialization type of existing volume.

Only applicable when command is initialize.

Choices:

  • "Fast" ← (default)

  • "Slow"

job_wait

boolean

Determines whether to wait for the job completion or not.

Choices:

  • false

  • true ← (default)

job_wait_timeout

integer

The maximum wait time of job_wait in seconds. The job is tracked only for this duration.

This option is applicable when job_wait is True.

Default: 1200

name

string

Name of the volume to be created.

Only applicable when state is present.

This will be deprecated. Please use volume_name for specifying the volume name.

oem

dictionary

Includes OEM extended payloads.

Only applicable when state is present.

optimum_io_size_bytes

integer

Stripe size value must be in multiples of 64 * 1024.

Only applicable when state is present.

password

string

iDRAC user password.

raid_type

string

One of the following raid types must be selected to create a volume for firmware version 4.40 and above.

RAID0 to create a RAID0 type volume.

RAID1 to create a RAID1 type volume.

RAID5 to create a RAID5 type volume.

RAID6 to create a RAID6 type volume.

RAID10 to create a RAID10 type volume.

RAID50 to create a RAID50 type volume.

RAID60 to create a RAID60 type volume.

Choices:

  • "RAID0"

  • "RAID1"

  • "RAID5"

  • "RAID6"

  • "RAID10"

  • "RAID50"

  • "RAID60"

reboot_server

boolean

added in dellemc.openmanage 8.5.0

Reboot the server to apply the changes.

reboot_server is applicable only when apply_timeout is OnReset or when the default value for the apply time of the controller is OnReset.

Choices:

  • false ← (default)

  • true

state

string

present creates a storage volume for the specified I (controller_id), or modifies the storage volume for the specified I (volume_id). “Note: Modification of an existing volume properties depends on drive and controller capabilities”.

absent deletes the volume for the specified volume_id.

Choices:

  • "present"

  • "absent"

username

string

iDRAC username with admin privilages.

validate_certs

boolean

If false, the SSL certificates will not be validated.

Configure false only on personally controlled sites where self-signed certificates are used.

Choices:

  • false

  • true ← (default)

volume_id

string

FQDD of existing volume.

For example- Disk.Virtual.4:RAID.Slot.1-1.

This option is mandatory in the following scenarios,

state is present, when updating a volume.

state is absent, when deleting a volume.

command is initialize, when initializing a volume.

volume_name

string

Name of the volume to be created.

Only applicable when state is present.