ibm.ds8000.ds8000_volume_info (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

Return information pertaining to DS8000 volumes.

If the optional parameters are not set, information on all volumes on the DS8000 storage system will be returned.

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: get all the volumes under host
  ibm.ds8000.ds8000_volume_info:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"
    host: host_name_test

Scanned by Steampunk Spotter

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

- name: get all the volumes under pool
  ibm.ds8000.ds8000_volume_info:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"
    pool: pool_name_test

Scanned by Steampunk Spotter

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

- name: get all the volumes
  ibm.ds8000.ds8000_volume_info:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"

Inputs

    
id:
    aliases:
    - volume_id
    description:
    - The volume id.
    elements: str
    type: list

lss:
    description:
    - The lss id that the volumes belong to.
    type: str

host:
    description:
    - The host that the volumes are mapped to.
    type: str

pool:
    description:
    - The pool id that the volumes belong to.
    type: str

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

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

username:
    description:
    - The username for the DS8000 storage system.
    required: true
    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

Outputs

volumes:
  contains:
    MTM:
      description: The volume device type and the machine type.
      sample: 2107-900
      type: str
    VOLSER:
      description: The volume serial number. A volume serial number is 6 bytes of
        data, displayed as 6 characters.
      sample: 0X5000
      type: str
    allocmethod:
      description: The extent allocation method.
      sample: managed
      type: str
    cap:
      description: The volume capacity.
      sample: 17592186044416
      type: int
    cap_gb:
      description: The volume capcity in GB.
      sample: 16384
      type: int
    cap_gib:
      description: The volume capacity in GiB.
      sample: 17592.2
      type: float
    capalloc:
      description: The allocated real capacity number.
      sample: 4624471818240
      type: int
    datatype:
      description: The volume data type.
      sample: FB 512T
      type: str
    easytier:
      description: The state of management by Easy Tier.
      sample: managed
      type: str
    id:
      description: The volume ID.
      sample: '1000'
      type: str
    lss:
      description: The lss ID the volume belongs to.
      sample: A0
      type: str
    name:
      description: The volume name.
      sample: ansible
      type: str
    pool:
      description: The pool ID the volume belongs to.
      sample: P0
      type: str
    real_cap:
      description: The real capacity used by the volume.
      sample: 4624471818240
      type: int
    state:
      description: The volume state.
      sample: normal
      type: str
    stgtype:
      description: The storage type of the volume.
      sample: fb
      type: str
    tieralloc:
      contains:
        allocated:
          description: The capacity allocated to the tier.
          sample: 4944866312192
          type: int
        tier:
          description: The tier type.
          sample: SSD
          type: str
      description: A list describing the tier allocation.
      elements: dict
      type: list
    tp:
      description: The thin provisioning method.
      sample: ese
      type: str
    virtual_cap:
      description: The virtual capacity allocated to the volume.
      sample: 17592186044416
      type: int
  description: A list of dictionaries describing the volumes.
  elements: dict
  returned: success
  sample: "[\n    {\n        \"MTM\": \"2107-900\",\n        \"VOLSER\": \"\",\n \
    \       \"allocmethod\": \"managed\",\n        \"cap\": \"17592186044416\",\n\
    \        \"cap_gb\": \"16384\",\n        \"cap_gib\": \"17592.2\",\n        \"\
    capalloc\": \"4632323555328\",\n        \"datatype\": \"FB 512T\",\n        \"\
    easytier\": \"none\",\n        \"id\": \"A000\",\n        \"lss\": \"A0\",\n \
    \       \"name\": \"ansible\",\n        \"pool\": \"P0\",\n        \"real_cap\"\
    : \"4632323555328\",\n        \"state\": \"normal\",\n        \"stgtype\": \"\
    fb\",\n        \"tieralloc\": [\n            {\n                \"allocated\"\
    : \"4549091786752\",\n                \"tier\": \"SSD\"\n            },\n    \
    \        {\n                \"allocated\": \"5234491392\",\n                \"\
    tier\": \"\"\n            }\n        ],\n        \"tp\": \"ese\",\n        \"\
    virtual_cap\": \"17592186044416\"\n    }\n]\n"
  type: list