ansible.builtin.ucs_disk_group_policy (v2.9.0) — module

Configures disk group policies on Cisco UCS Manager

| "added in version" 2.8 of ansible.builtin"

Authors: Sindhu Sudhir (@sisudhir), David Soper (@dsoper2), CiscoUcs (@CiscoUcs), Brett Johnson (@sdbrett)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.0

Description

Configures disk group policies on Cisco UCS Manager.

Examples can be used with the L(UCS Platform Emulator,https://communities.cisco.com/ucspe).


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure Disk Group Policy
  ucs_disk_group_policy:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: DEE-DG
    raid_level: mirror
    configuration_mode: manual
    manual_disks:
    - slot_num: '1'
      role: normal
    - slot_num: '2'
      role: normal
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove Disk Group Policy
  ucs_disk_group_policy:
    name: DEE-DG
    hostname: 172.16.143.150
    username: admin
    password: password
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove Disk from Policy
  ucs_disk_group_policy:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: DEE-DG
    description: Testing Ansible
    raid_level: stripe
    configuration_mode: manual
    manual_disks:
    - slot_num: '1'
      role: normal
    - slot_num: '2'
      role: normal
      state: absent
    virtual_drive:
      access_policy: platform-default
      io_policy: direct
      strip_size: 64KB

Inputs

    
name:
    description:
    - The name of the disk group policy. This name can be between 1 and 16 alphanumeric
      characters.
    - 'You cannot use spaces or any special characters other than - (hyphen), "_" (underscore),
      : (colon), and . (period).'
    - You cannot change this name after the policy is created.
    required: true

port:
    description:
    - Port number to be used during connection (by default uses 443 for https and 80 for
      http connection).
    type: int

proxy:
    description:
    - If use_proxy is no, specfies proxy to be used for connection. e.g. 'http://proxy.xy.z:8080'
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Desired state of the disk group policy.
    - If C(present), will verify that the disk group policy is present and will create
      if needed.
    - If C(absent), will verify that the disk group policy is absent and will delete if
      needed.

org_dn:
    default: org-root
    description:
    - The distinguished name (dn) of the organization where the resource is assigned.

use_ssl:
    default: true
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection.
    type: bool

hostname:
    description:
    - IP address or hostname of Cisco UCS Manager.
    - Modules can be used with the UCS Platform Emulator U(https://cs.co/ucspe)
    required: true
    type: str

password:
    description:
    - Password for Cisco UCS Manager authentication.
    required: true
    type: str

username:
    default: admin
    description:
    - Username for Cisco UCS Manager authentication.
    type: str

use_proxy:
    default: true
    description:
    - If C(no), will not use the proxy as defined by system environment variable.
    type: bool

drive_type:
    choices:
    - unspecified
    - HDD
    - SSD
    default: unspecified
    description:
    - Specify the drive type to use in the drive group.
    - 'This can be one of the following:'
    - "unspecified \u2014 Selects the first available drive type, and applies that to\
      \ all drives in the group."
    - "HDD \u2014 Hard disk drive"
    - "SSD \u2014 Solid state drive"
    - Option only applies when configuration mode is automatic.

num_drives:
    default: 1
    description:
    - Specify the number of drives for the disk group.
    - This can be from 0 to 24.
    - Option only applies when configuration mode is automatic.

raid_level:
    choices:
    - stripe
    - mirror
    - mirror-stripe
    - stripe-parity
    - stripe-dual-parity
    - stripe-parity-stripe
    - stripe-dual-parity-stripe
    default: stripe
    description:
    - 'The RAID level for the disk group policy. This can be one of the following:'
    - stripe - UCS Manager shows RAID 0 Striped
    - mirror - RAID 1 Mirrored
    - mirror-stripe - RAID 10 Mirrored and Striped
    - stripe-parity - RAID 5 Striped Parity
    - stripe-dual-parity - RAID 6 Striped Dual Parity
    - stripe-parity-stripe - RAID 50 Striped Parity and Striped
    - stripe-dual-parity-stripe - RAID 60 Striped Dual Parity and Striped

description:
    aliases:
    - descr
    description:
    - The user-defined description of the storage profile. Enter up to 256 characters.
      "You can use any characters or spaces except the following:" "` (accent mark), \
      (backslash), ^ (carat), \" (double quote), = (equal sign), > (greater than), < (less
      than), or ' (single quote)."

manual_disks:
    description:
    - List of manually configured disks.
    - Options are only used when you choose manual configuration_mode.
    suboptions:
      name:
        description:
        - The name of the local LUN.
        required: true
      role:
        description:
        - 'The role of the disk. This can be one of the following:'
        - normal - Normal
        - ded-hot-spare - Dedicated Hot Spare
        - glob-hot-spare - Glob Hot Spare
      slot_num:
        description:
        - The slot number of the specific disk.
      span_id:
        default: unspecified
        description:
        - The Span ID of the specific disk.
      state:
        choices:
        - present
        - absent
        default: present
        description:
        - If C(present), will verify disk slot is configured within policy. If C(absent),
          will verify disk slot is absent from policy.

virtual_drive:
    description:
    - Configuration of virtual drive options.
    suboptions:
      access_policy:
        choices:
        - blocked
        - hidden
        - platform-default
        - read-only
        - read-write
        - transport-ready
        default: platform-default
        description:
        - Configure access policy to virtual drive.
      drive_cache:
        choices:
        - disable
        - enable
        - no-change
        - platform-default
        default: platform-default
        description:
        - Configure drive caching.
      io_policy:
        choices:
        - cached
        - direct
        - platform-default
        default: platform-default
        description:
        - Direct or Cached IO path.
      read_policy:
        choices:
        - normal
        - platform-default
        - read-ahead
        default: platform-default
        description:
        - Read access policy to virtual drive.
      strip_size:
        choices:
        - present
        - absent
        default: platform-default
        description:
        - Virtual drive strip size.
      write_cache_policy:
        choices:
        - always-write-back
        - platform-default
        - write-back-good-bbu
        - write-through
        default: platform-default
        description:
        - Write back cache policy.

min_drive_size:
    default: unspecified
    description:
    - Specify the minimum drive size or unspecified to allow all drive sizes.
    - This can be from 0 to 10240 GB.
    - Option only applies when configuration mode is automatic.

configuration_mode:
    choices:
    - automatic
    - manual
    default: automatic
    description:
    - 'Disk group configuration mode. Choose one of the following:'
    - automatic - Automatically configures the disks in the disk group.
    - manual - Enables you to manually configure the disks in the disk group.

num_ded_hot_spares:
    default: unspecified
    description:
    - Specify the number of hot spares for the disk group.
    - This can be from 0 to 24.
    - Option only applies when configuration mode is automatic.

num_glob_hot_spares:
    default: unspecified
    description:
    - Specify the number of global hot spares for the disk group.
    - This can be from 0 to 24.
    - Option only applies when configuration mode is automatic.

use_remaining_disks:
    choices:
    - 'yes'
    - 'no'
    default: 'no'
    description:
    - Specifies whether you can use all the remaining disks in the disk group or not.
    - Option only applies when configuration mode is automatic.