dellemc.unity.storagepool (2.0.0) — module

Manage storage pool on Unity

| "added in version" 1.1.0 of dellemc.unity"

Authors: Ambuj Dubey (@AmbujDube) <ansible.team@dell.com>

Install collection

Install with ansible-galaxy collection install dellemc.unity:==2.0.0


Add to requirements.yml

  collections:
    - name: dellemc.unity
      version: 2.0.0

Description

Managing storage pool on Unity storage system contains the operations Get details of storage pool, Create a storage pool, Modify storage pool.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get Storage pool details using pool_name
  dellemc.unity.storagepool:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    pool_name: "{{pool_name}}"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get Storage pool details using pool_id
  dellemc.unity.storagepool:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    pool_id: "{{pool_id}}"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify Storage pool attributes using pool_name
  dellemc.unity.storagepool:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    pool_name: "{{pool_name}}"
    new_pool_name: "{{new_pool_name}}"
    pool_description: "{{pool_description}}"
    fast_cache: "{{fast_cache_enabled}}"
    fast_vp: "{{fast_vp_enabled}}"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify Storage pool attributes using pool_id
  dellemc.unity.storagepool:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    pool_id: "{{pool_id}}"
    new_pool_name: "{{new_pool_name}}"
    pool_description: "{{pool_description}}"
    fast_cache: "{{fast_cache_enabled}}"
    fast_vp: "{{fast_vp_enabled}}"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a StoragePool
  dellemc.unity.storagepool:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    pool_name: "Test"
    pool_description: "test pool"
    raid_groups:
      disk_group_id: "dg_16"
      disk_num: 2
      raid_type: "RAID10"
      stripe_width: "BEST_FIT"
    alert_threshold: 50
    is_harvest_enabled: true
    pool_harvest_high_threshold: 60
    pool_harvest_low_threshold: 40
    is_snap_harvest_enabled: true
    snap_harvest_high_threshold: 70
    snap_harvest_low_threshold: 50
    fast_vp: "enabled"
    fast_cache: "enabled"
    pool_type: "DYNAMIC"
    state: "present"

Inputs

    
port:
    default: 443
    description:
    - Port number through which communication happens with Unity management server.
    type: int

state:
    choices:
    - absent
    - present
    description:
    - Define whether the storage pool should exist or not.
    - C(Present) - indicates that the storage pool should exist on the system.
    - C(Absent) - indicates that the storage pool should not exist on the system.
    required: true
    type: str

fast_vp:
    choices:
    - enabled
    - disabled
    description:
    - Indicates whether to enable scheduled data relocations for the pool.
    - C(Enabled) - Enabled scheduled data relocations for the pool.
    - C(Disabled) - Disabled scheduled data relocations for the pool.
    type: str

pool_id:
    description:
    - Unique identifier of the pool instance.
    type: str

password:
    description:
    - The password of the Unity management server.
    required: true
    type: str

username:
    description:
    - The username of the Unity management server.
    required: true
    type: str

pool_name:
    description:
    - Name of the storage pool, unique in the storage system.
    type: str

pool_type:
    choices:
    - TRADITIONAL
    - DYNAMIC
    description:
    - Indicates storage pool type.
    type: str

fast_cache:
    choices:
    - enabled
    - disabled
    description:
    - Indicates whether the fast cache is enabled for the storage pool.
    - C(Enabled) - FAST Cache is enabled for the pool.
    - C(Disabled) - FAST Cache is disabled for the pool.
    type: str

raid_groups:
    description:
    - Parameters to create RAID group from the disks and add it to the pool.
    suboptions:
      disk_group_id:
        description:
        - Id of the disk group.
        type: str
      disk_num:
        description:
        - Number of disks.
        type: int
      raid_type:
        choices:
        - None
        - RAID5
        - RAID0
        - RAID1
        - RAID3
        - RAID10
        - RAID6
        - Mixed
        - Automatic
        description:
        - RAID group types or RAID levels.
        type: str
      stripe_width:
        choices:
        - BEST_FIT
        - '2'
        - '4'
        - '5'
        - '6'
        - '8'
        - '9'
        - '10'
        - '12'
        - '13'
        - '14'
        - '16'
        description:
        - RAID group stripe widths, including parity or mirror disks.
        type: str
    type: dict

new_pool_name:
    description:
    - New name of the storage pool, unique in the storage system.
    type: str

unispherehost:
    description:
    - IP or FQDN of the Unity management server.
    required: true
    type: str

validate_certs:
    aliases:
    - verifycert
    default: true
    description:
    - Boolean variable to specify whether or not to validate SSL certificate.
    - C(true) - Indicates that the SSL certificate should be verified.
    - C(false) - Indicates that the SSL certificate should not be verified.
    type: bool

alert_threshold:
    description:
    - Threshold at which the system will generate alerts about the free space in the pool,
      specified as a percentage.
    - Minimum threshold limit is 50.
    - Maximum threshold limit is 84.
    type: int

pool_description:
    description:
    - The description of the storage pool.
    type: str

is_harvest_enabled:
    description:
    - Enable/Disable automatic deletion of snapshots based on pool space usage.
    type: bool

is_snap_harvest_enabled:
    description:
    - Enable/Disable automatic deletion of snapshots based on pool space usage.
    type: bool

pool_harvest_low_threshold:
    description:
    - Min threshold for space used in pool below which the system automatically stops
      deletion of snapshots in the pool.
    - Applies when the automatic deletion of snapshots based on pool space usage is enabled
      for the system and pool.
    - Minimum pool harvest low threshold value is 0.
    - Maximum pool harvest low threshold value is 98.
    type: float

snap_harvest_low_threshold:
    description:
    - Min threshold for space used in snapshot below which the system will stop automatically
      deleting snapshots in the pool.
    - Applies when the automatic deletion of snapshots based on pool space usage is enabled
      for the pool.
    - Minimum snap harvest low threshold value is 0.
    - Maximum snap harvest low threshold value is 98.
    type: float

pool_harvest_high_threshold:
    description:
    - Max threshold for space used in pool beyond which the system automatically starts
      deleting snapshots in the pool.
    - Applies when the automatic deletion of snapshots based on pool space usage is enabled
      for the system and pool.
    - Minimum pool harvest high threshold value is 1.
    - Maximum pool harvest high threshold value is 99.
    type: float

snap_harvest_high_threshold:
    description:
    - Max threshold for space used in snapshot beyond which the system automatically starts
      deleting snapshots in the pool.
    - Applies when the automatic deletion of snapshots based on pool space usage is enabled
      for the pool.
    - Minimum snap harvest high threshold value is 1.
    - Maximum snap harvest high threshold value is 99.
    type: float

Outputs

changed:
  description: Whether or not the storage pool has changed.
  returned: always
  sample: true
  type: bool
storage_pool_details:
  contains:
    drives:
      contains:
        disk_technology:
          description: Indicates disk technology of the drive.
          type: str
        id:
          description: Unique identifier of the drive.
          type: str
        name:
          description: Indicates name of the drive.
          type: str
        size:
          description: Indicates size of the drive.
          type: str
        tier_type:
          description: Indicates tier type of the drive.
          type: str
      description: Indicates information about the drives associated with the storage
        pool.
      type: list
    id:
      description: Pool id, unique identifier of the pool.
      type: str
    is_fast_cache_enabled:
      description: Indicates whether the fast cache is enabled for the storage pool.
        true - FAST Cache is enabled for the pool. false - FAST Cache is disabled
        for the pool.
      type: bool
    is_fast_vp_enabled:
      description: Indicates whether to enable scheduled data relocations for the
        storage pool. true - Enabled scheduled data relocations for the pool. false
        - Disabled scheduled data relocations for the pool.
      type: bool
    name:
      description: Pool name, unique in the storage system.
      type: str
    size_free_with_unit:
      description: Indicates size_free with its appropriate unit in human readable
        form.
      type: str
    size_subscribed_with_unit:
      description: Indicates size_subscribed with its appropriate unit in human readable
        form.
      type: str
    size_total_with_unit:
      description: Indicates size_total with its appropriate unit in human readable
        form.
      type: str
    size_used_with_unit:
      description: Indicates size_used with its appropriate unit in human readable
        form.
      type: str
    snap_size_subscribed_with_unit:
      description: Indicates snap_size_subscribed with its appropriate unit in human
        readable form.
      type: str
    snap_size_used_with_unit:
      description: Indicates snap_size_used with its appropriate unit in human readable
        form.
      type: str
  description: The storage pool details.
  returned: When storage pool exists.
  sample:
    alert_threshold: 50
    creation_time: '2022-03-08 14:05:32+00:00'
    description: ''
    drives:
    - disk_technology: SAS
      id: dpe_disk_22
      name: DPE Drive 22
      size: 590860984320
      tier_type: PERFORMANCE
    - disk_technology: SAS
      id: dpe_disk_23
      name: DPE Drive 23
      size: 590860984320
      tier_type: PERFORMANCE
    - disk_technology: SAS
      id: dpe_disk_24
      name: DPE Drive 24
      size: 590860984320
      tier_type: PERFORMANCE
    existed: true
    harvest_state: UsageHarvestStateEnum.IDLE
    hash: 8744642897210
    health:
      UnityHealth:
        hash: 8744642799842
    id: pool_280
    is_all_flash: false
    is_empty: false
    is_fast_cache_enabled: false
    is_fast_vp_enabled: false
    is_harvest_enabled: true
    is_snap_harvest_enabled: true
    metadata_size_subscribed: 105763569664
    metadata_size_used: 57176752128
    name: test_pool
    object_id: 12884902146
    pool_fast_vp:
      UnityPoolFastVp:
        hash: 8744647518980
    pool_space_harvest_high_threshold: 59.0
    pool_space_harvest_low_threshold: 40.0
    pool_type: StoragePoolTypeEnum.DYNAMIC
    raid_type: RaidTypeEnum.RAID10
    rebalance_progress: null
    size_free: 470030483456
    size_free_with_unit: 437.75 GB
    size_subscribed: 447215820800
    size_subscribed_with_unit: 416.5 GB
    size_total: 574720311296
    size_total_with_unit: 535.25 GB
    size_used: 76838068224
    size_used_with_unit: 71.56 GB
    snap_size_subscribed: 128851369984
    snap_size_subscribed_with_unit: 120.0 GB
    snap_size_used: 2351104
    snap_size_used_with_unit: 2.24 MB
    snap_space_harvest_high_threshold: 80.0
    snap_space_harvest_low_threshold: 60.0
    tiers:
      UnityPoolTierList:
      - disk_count:
        - 0
        - 3
        - 0
        existed: true
        hash: 8744643017382
        name:
        - Extreme Performance
        - Performance
        - Capacity
        pool_units:
        - null
        - UnityPoolUnitList:
          - UnityPoolUnit:
              hash: 8744642786759
              id: rg_4
          - UnityPoolUnit:
              hash: 8744642786795
              id: rg_5
        - null
        raid_type:
        - RaidTypeEnum.NONE
        - RaidTypeEnum.RAID10
        - RaidTypeEnum.NONE
        size_free:
        - 0
        - 470030483456
        - 0
        size_moving_down:
        - 0
        - 0
        - 0
        size_moving_up:
        - 0
        - 0
        - 0
        size_moving_within:
        - 0
        - 0
        - 0
        size_total:
        - 0
        - 574720311296
        - 0
        size_used:
        - 0
        - 104689827840
        - 0
        stripe_width:
        - null
        - RaidStripeWidthEnum._2
        - null
        tier_type:
        - TierTypeEnum.EXTREME_PERFORMANCE
        - TierTypeEnum.PERFORMANCE
        - TierTypeEnum.CAPACITY
  type: dict