jagadeeshnv.test.redfish_storage_volume (0.2.0) — module

Manages the storage volume configuration.

| "added in version" 2.9 of jagadeeshnv.test"

Authors: Sajna Shetty(@Sajna-Shetty)

preview | supported by community

Install collection

Install with ansible-galaxy collection install jagadeeshnv.test:==0.2.0


Add to requirements.yml

  collections:
    - name: jagadeeshnv.test
      version: 0.2.0

Description

This module allows to create, modify, initialize, or delete a single storage volume.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- name: Create a volume with supported options.
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a volume with minimum options.
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    controller_id: "RAID.Slot.1-1"
    volume_type: "NonRedundant"
    drives:
       - Disk.Bay.1:Enclosure.Internal.0-1:RAID.Slot.1-1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify a volume's encryption type settings.
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    state: "present"
    volume_id: "Disk.Virtual.5:RAID.Slot.1-1"
    encryption_types: "ControllerAssisted"
    encrypted: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete an existing volume.
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    state: "absent"
    volume_id: "Disk.Virtual.5:RAID.Slot.1-1"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Initialize an existing volume.
  dellemc.openmanage.redfish_storage_volume:
    baseuri: "192.168.0.1"
    username: "username"
    password: "password"
    command: "initialize"
    volume_id: "Disk.Virtual.6:RAID.Slot.1-1"
    initialize_type: "Slow"

Inputs

    
oem:
    description:
    - Includes OEM extended payloads.
    - Only applicable when I(state) is I(present).
    required: false
    type: dict

name:
    description:
    - Name of the volume to be created.
    - Only applicable when I(state) is C(present).
    required: false
    type: str

state:
    choices:
    - present
    - absent
    description:
    - 'C(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."'
    - C(absent) deletes the volume for the specified I(volume_id).
    required: false
    type: str

drives:
    description:
    - FQDD of the Physical disks.
    - For example- Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1.
    - Only applicable when I(state) is C(present) when creating a new volume.
    required: false
    type: list

baseuri:
    description: IP address of the target out-of-band controller. For example- <ipaddress>:<port>
    required: true
    type: str

command:
    choices:
    - initialize
    description:
    - C(initialize) initializes an existing storage volume for a specified I(volume_id).
    required: false
    type: str

password:
    description: Password of the target out-of-band controller.
    required: true
    type: str

username:
    description: Username of the target out-of-band controller.
    required: true
    type: str

encrypted:
    description:
    - Indicates whether volume is currently utilizing encryption or not.
    - Only applicable when I(state) is C(present)
    required: false
    type: bool

volume_id:
    description:
    - FQDD of existing volume.
    - For example- Disk.Virtual.4:RAID.Slot.1-1.
    - This option is mandatory in the following scenarios,
    - I(state) is C(present), when updating a volume.
    - I(state) is C(absent), when deleting a volume.
    - I(command) is C(initialize), when initializing a volume.
    required: false
    type: str

volume_type:
    choices:
    - NonRedundant
    - Mirrored
    - StripedWithParity
    - SpannedMirrors
    - SpannedStripesWithParity
    description:
    - One of the following volume types must be selected to create a volume.
    - C(Mirrored) The volume is a mirrored device.
    - C(NonRedundant) The volume is a non-redundant storage device.
    - C(SpannedMirrors) The volume is a spanned set of mirrored devices.
    - C(SpannedStripesWithParity) The volume is a spanned set of devices which uses parity
      to retain redundant information.
    - C(StripedWithParity) The volume is a device which uses parity to retain redundant
      information.
    required: false
    type: str

controller_id:
    description:
    - Fully Qualified Device Descriptor (FQDD) of the storage controller.
    - For example- RAID.Slot.1-1.
    - This option is mandatory when I(state) is C(present) while creating a volume.
    required: false
    type: str

capacity_bytes:
    description:
    - Volume size in bytes.
    - Only applicable when I(state) is C(present).
    required: false
    type: str

initialize_type:
    choices:
    - Fast
    - Slow
    default: Fast
    description:
    - Initialization type of existing volume.
    - Only applicable when I(command) is C(initialize).
    required: false
    type: str

block_size_bytes:
    description:
    - Block size in bytes.Only applicable when I(state) is C(present).
    required: false
    type: int

encryption_types:
    choices:
    - NativeDriveEncryption
    - ControllerAssisted
    - SoftwareAssisted
    description:
    - The following encryption types can be selected.
    - C(ControllerAssisted) The volume is encrypted by the storage controller entity.
    - C(NativeDriveEncryption) The volume utilizes the native drive encryption capabilities
      of the drive hardware.
    - C(SoftwareAssisted) The volume is encrypted by the software running on the system
      or the operating system.
    - Only applicable when I(state) is C(present).
    required: false
    type: str

optimum_io_size_bytes:
    description:
    - Stripe size value must be in multiples of 64 * 1024.
    - Only applicable when I(state) is C(present).
    required: false
    type: int