dellemc.openmanage.dellemc_idrac_storage_volume (9.1.0) — module

Configures the RAID configuration attributes

| "added in version" 9.1.0 of dellemc.openmanage"

Authors: Felix Stephen (@felixs88), Kritika Bhateja (@Kritika-Bhateja-03), Abhishek Sinha(@ABHISHEK-SINHA10)

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0


Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 9.1.0

Description

This module is responsible for configuring the RAID attributes.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- 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]
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"

Inputs

    
state:
    choices:
    - create
    - delete
    - view
    default: view
    description:
    - C(create), performs create volume operation.
    - C(delete), performs remove volume operation.
    - C(view), returns storage view.
    type: str

ca_path:
    description:
    - The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
      the validation.
    type: path
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

timeout:
    default: 30
    description: The socket level timeout in seconds.
    type: int
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

volumes:
    description:
    - A list of virtual disk specific iDRAC attributes. This is applicable for C(create)
      and C(delete) operations.
    - For C(create) operation, name and drives are applicable options, other volume options
      can also be specified.
    - The drives is a required option for C(create) operation and accepts either location
      (list of drive slot) or id (list of drive fqdd).
    - 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 C(delete) operation, only name option is applicable.
    - See the examples for more details.
    elements: dict
    type: list

capacity:
    description: Virtual disk size in GB.
    type: float

idrac_ip:
    description: iDRAC IP Address.
    required: true
    type: str

job_wait:
    default: true
    description:
    - This parameter provides the option to wait for the job completion.
    - This is applicable when I(state) is C(create) or C(delete).
    type: bool

protocol:
    choices:
    - SAS
    - SATA
    - PCIE
    description: Bus protocol.
    type: str

volume_id:
    description:
    - 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.
    type: str

idrac_port:
    default: 443
    description: iDRAC port.
    type: int

idrac_user:
    description:
    - iDRAC username.
    - If the username is not provided, then the environment variable C(IDRAC_USERNAME)
      is used.
    - 'Example: export IDRAC_USERNAME=username'
    required: true
    type: str

media_type:
    choices:
    - HDD
    - SSD
    description: Media type.
    type: str

span_depth:
    default: 1
    description:
    - Number of spans in the RAID configuration.
    - I(span_depth) is required for C(create) and its value depends on I(volume_type).
    type: int

span_length:
    default: 1
    description:
    - Number of disks in a span.
    - I(span_length) is required for C(create) and its value depends on I(volume_type).
    type: int

stripe_size:
    default: 65536
    description: Stripe size value to be provided in multiples of 64 * 1024.
    type: int

volume_type:
    choices:
    - RAID 0
    - RAID 1
    - RAID 5
    - RAID 6
    - RAID 10
    - RAID 50
    - RAID 60
    default: RAID 0
    description: Provide the the required RAID level.
    type: str

controller_id:
    description:
    - Fully Qualified Device Descriptor (FQDD) of the storage controller, for example
      'RAID.Integrated.1-1'. Controller FQDD is required for C(create) RAID configuration.
    type: str

idrac_password:
    aliases:
    - idrac_pwd
    description:
    - iDRAC user password.
    - If the password is not provided, then the environment variable C(IDRAC_PASSWORD)
      is used.
    - 'Example: export IDRAC_PASSWORD=password'
    required: true
    type: str

validate_certs:
    default: true
    description:
    - If C(false), the SSL certificates will not be validated.
    - Configure C(false) only on personally controlled sites where self-signed certificates
      are used.
    - Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
    type: bool
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

job_wait_timeout:
    default: 900
    description:
    - This parameter is the maximum wait time of I(job_wait) in seconds.
    - This option is applicable when I(job_wait) is C(true).
    type: int

disk_cache_policy:
    choices:
    - Default
    - Enabled
    - Disabled
    default: Default
    description: Disk Cache Policy.
    type: str

raid_reset_config:
    choices:
    - 'true'
    - 'false'
    default: 'false'
    description:
    - 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.
    type: str

read_cache_policy:
    choices:
    - NoReadAhead
    - ReadAhead
    - AdaptiveReadAhead
    default: NoReadAhead
    description: Read cache policy.
    type: str

write_cache_policy:
    choices:
    - WriteThrough
    - WriteBack
    - WriteBackForce
    default: WriteThrough
    description: Write cache policy.
    type: str

raid_init_operation:
    choices:
    - None
    - Fast
    description: This option represents initialization configuration operation to be performed
      on the virtual disk.
    type: str

number_dedicated_hot_spare:
    default: 0
    description: Number of Dedicated Hot Spare.
    type: int

Outputs

error_info:
  description: Details of the HTTP Error.
  returned: on HTTP error
  sample:
    error:
      '@Message.ExtendedInfo':
      - Message: Unable to process the request because an error occurred.
        MessageArgs: []
        MessageId: GEN1234
        RelatedProperties: []
        Resolution: Retry the operation. If the issue persists, contact your system
          administrator.
        Severity: Critical
      code: Base.1.0.GeneralError
      message: A general error has occurred. See ExtendedInfo for more information.
  type: dict
msg:
  description: Overall status of the storage configuration operation.
  returned: always
  sample: Successfully completed the view storage volume operation
  type: str
storage_status:
  description: Storage configuration job and progress details from the iDRAC.
  returned: success
  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
    TargetSettingsURI: null
  type: dict