dellemc.openmanage.idrac_redfish_storage_controller (2.1.5) — module

Configures the storage controller settings.

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

Authors: Jagadeesh N V (@jagadeeshnv)

preview | supported by community

Install collection

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


Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 2.1.5

Description

This module configures the settings of the storage controller using Redfish.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- name: Assign dedicated hot spare.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    volume_id:
      - "Disk.Virtual.0:RAID.Slot.1-1"
    target: "Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1"
  tags:
    - assign_dedicated_hot_spare
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Assign global hot spare.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    target: "Disk.Bay.0:Enclosure.Internal.0-1:RAID.Slot.1-1"
  tags:
    - assign_global_hot_spare
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set controller encryption key.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    command: "SetControllerKey"
    controller_id: "RAID.Slot.1-1"
    key: "PassPhrase@123"
    key_id: "mykeyid123"
  tags:
    - set_controller_key
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Rekey in LKM mode.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    command: "ReKey"
    controller_id: "RAID.Slot.1-1"
    key: "NewPassPhrase@123"
    key_id: "newkeyid123"
    old_key: "OldPassPhrase@123"
  tags:
    - rekey_lkm
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Rekey in SEKM mode.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    command: "ReKey"
    controller_id: "RAID.Slot.1-1"
    mode: "SEKM"
  tags:
    - rekey_sekm
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove controller key.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    command: "RemoveControllerKey"
    controller_id: "RAID.Slot.1-1"
  tags:
    - remove_controller_key
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Reset controller configuration.
  dellemc.openmanage.idrac_redfish_storage_controller:
    baseuri: "192.168.0.1:443"
    username: "user_name"
    password: "user_password"
    command: "ResetConfig"
    controller_id: "RAID.Slot.1-1"
  tags:
    - reset_config

Inputs

    
key:
    description:
    - A new security key passphrase that the encryption-capable controller uses to create
      the encryption key. The controller uses the encryption key to lock or unlock access
      to the Self Encryption Disk(SED). Only one encryption key can be created for each
      controller.
    - This is mandatory when I(command) is C(SetControllerKey) or C(ReKey), and when I(mode)
      is C(LKM).
    required: false
    type: str

mode:
    choices:
    - LKM
    - SEKM
    default: LKM
    description:
    - 'Encryption mode of the encryption-capable controller: 1 - Local Key Management
      (LKM), 2 - Security Enterprise Key Manager(SEKM).'
    - This option is applicable only when I(command) is C(ReKey).
    - C(SEKM) requires secure enterprise key manager license on the iDRAC.
    required: false
    type: str

key_id:
    description:
    - This is a user supplied text label associated with the passphrase.
    - This is mandatory when I(command) is C(SetControllerKey) or C(ReKey), and when I(mode)
      is C(LKM).
    required: false
    type: str

target:
    description:
    - Fully Qualified Device Descriptor (FQDD) of the target physical drive that is assigned
      as a spare.
    - This is mandatory when I(command) is C(AssignSpare)
    - If I(volume_id) is not specified or empty, this physical drive will be assigned
      as a global hot spare.
    required: false
    type: str

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

command:
    choices:
    - ResetConfig
    - AssignSpare
    - SetControllerKey
    - RemoveControllerKey
    - ReKey
    default: AssignSpare
    description:
    - These actions may require a system reset, depending on the controller's capabilities.
    - C(ResetConfig) - Deletes all the virtual disks and unassigns all hot spares on physical
      disks.
    - C(AssignSpare) - Assigns a physical disk as a dedicated or global hot spare for
      a virtual disk.
    - C(SetControllerKey) - Sets the key on controllers, which is used to encrypt the
      drives in Local key Management(LKM).
    - C(RemoveControllerKey) - Erases the encryption key on the controller.
    - C(ReKey) - Resets the key on the controller.
    required: false
    type: str

old_key:
    description:
    - Security key passphrase used by the encryption-capable controller..
    - This option is mandatory when I(command) is C(ReKey) and I(mode) is C(LKM).
    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

volume_id:
    description:
    - FQDD of the volumes to which a hot spare is assigned.
    - Applicable if I(command) is C(AssignSpare).
    - To know the number of volumes to which a hot spare can be assigned, refer iDRAC
      Redfish API guide.
    elements: str
    required: false
    type: list

controller_id:
    description:
    - FQDD of the storage controller. For example- 'RAID.Slot.1-1'.
    - This option is mandatory when I(command) is C(ResetConfig), C(SetControllerKey),
      C(RemoveControllerKey) and C(ReKey).
    required: false
    type: str