ibm.ds8000.ds8000_volume (1.1.0) — module

Install collection

Install with ansible-galaxy collection install ibm.ds8000:==1.1.0

Add to requirements.yml

  collections:
    - name: ibm.ds8000
      version: 1.1.0

Description

Manage DS8000 volumes.

Requirements

• pyds8k >= 1.5.0
• python >= 3.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure that a volume exists in the storage
  ibm.ds8000.ds8000_volume:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"
    name: volume_name_test
    state: present
    pool: P1
    capacity: "1"
  register: volume

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- debug:
  var: volume.id

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Ensure that a volume does not exist in the storage
  ibm.ds8000.ds8000_volume:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"
    id: "FFFF"
    state: absent

Inputs

    
id:
    aliases:
    - volume_id
    description:
    - The volume IDs of the DS8000 volume to work with.
    - Required when I(state=absent)
    - Only one element is allowed when I(alias=yes)
    elements: str
    type: list

lss:
    description:
    - The logical subsystem (lss) that the volume will be created on.
    type: str

name:
    description:
    - The name of the DS8000 volume to work with.
    - Required when I(state=present)
    type: str

pool:
    description:
    - The pool id that the volume will be created on.
    - Required when I(state=present)
    type: str

port:
    default: 8452
    description:
    - The port number of the DS8000 storage system HMC.
    type: int

alias:
    description:
    - Boolean specifying if the id is an alias
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Specify the state the DS8000 volume should be in.
    type: str

capacity:
    description:
    - The size of the volume.
    - Required when I(state=present)
    type: str

hostname:
    description:
    - The hostname or IP address of the DS8000 storage system HMC.
    required: true
    type: str

password:
    description:
    - The password for the DS8000 storage system I(username).
    required: true
    type: str

quantity:
    default: 1
    description:
    - The number of volumes that will be created.
    type: int

username:
    description:
    - The username for the DS8000 storage system.
    required: true
    type: str

alias_order:
    choices:
    - decrement
    - increment
    default: decrement
    description:
    - The order in which alias volume IDs are assigned.
    type: str

volume_type:
    choices:
    - fb
    - ckd
    default: fb
    description:
    - The volume type that will be created.
    - Valid value is fixed block C(fb) or count key data C(ckd).
    type: str

ckd_base_ids:
    description:
    - List of existing base CKD volume IDs to create aliases for.
    elements: str
    type: list

capacity_type:
    choices:
    - gib
    - bytes
    - cyl
    - mod1
    default: gib
    description:
    - The units of measurement of the size of the volume.
    type: str

validate_certs:
    default: true
    description:
    - Controls validation of SSL chain of trust.
    - Set to C(no) to allow connection when SSL certificates are not trusted.
    type: bool

storage_allocation_method:
    choices:
    - none
    - ese
    - tse
    default: none
    description:
    - Choose the storage allocation method that the DS8000 will use in creating your volume.
    - Valid value is C(none), extent space-efficient C(ese), track space-efficient C(tse).
    type: str

Outputs

volumes:
  contains:
    id:
      description: Volume ID.
      sample: '1000'
      type: str
    name:
      description: Volume name.
      sample: ansible
      type: str
  description: A list of dictionaries describing the volumes.
  elements: dict
  returned: I(state=present) changed
  sample: "[\n  {\n    \"id\": \"3001\",\n    \"name\": \"ansible\"\n  }\n]\n"
  type: list