ibm.ds8000.ds8000_lss_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 lsses.

If the optional parameters are not set, information on all lsses 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 lsses
  ibm.ds8000.ds8000_lss_info:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"

Scanned by Steampunk Spotter

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

- name: get all the ckd lsses
  ibm.ds8000.ds8000_lss_info:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"
    lss_type: ckd

Scanned by Steampunk Spotter

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

- name: get lss 00
  ibm.ds8000.ds8000_lss_info:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"
    id: '00'

Inputs

    
id:
    aliases:
    - lss
    description:
    - The logical subsystem (lss) ID to be queried.
    - An lss ID is two hexadecimal characters 00 - FE.
    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

lss_type:
    choices:
    - fb
    - ckd
    default: ckd
    description:
    - The lss type to query
    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

lss:
  contains:
    addrgrp:
      description: The address group object the lss is a member of.
      sample: 0
      type: int
    cc_session_timeout:
      description: The assigned concurrent copy session timeout value.
      sample: 300
      type: int
    ckd_base_cu_type:
      description: The lss type you designated for the lcu.
      sample: 3990-6
      type: str
    configvols:
      description:
      - The number of volumes or the logical devices assigned to the lss.
      - This number includes base count key data (ckd) volumes and alias ckd volumes.
      sample: '256'
      type: str
    critical_mode:
      description: Indicates whether the critical heavy mode for Remote Mirror and
        Copy operations is in effect.
      sample: disabled
      type: str
    extended_long_busy_time:
      description: The assigned extended long busy timeout value.
      sample: 120
      type: int
    group:
      description:
      - The server that manages the lcu group.
      - The displayed values are 0 or 1.
      sample: 0
      type: int
    id:
      description:
      - The unique identifier assigned to the logical subsystem (lss) or logical control
        unit object (lcu).
      - It includes the storage image ID and the 2 digit lss ID 00 - FE.
      sample: '00'
      type: str
    pprc_consistency_group:
      description: The assigned PPRC consistency group state setting.
      sample: disabled
      type: str
    sub_system_identifier:
      description:
      - The subsystem ID that you assigned to this lcu.
      - The range of values that you selected from is 0001 - FFFF.
      sample: 0D58
      type: str
    type:
      description:
      - The type of storage volumes contained by this lss.
      - The value displayed is fb (fixed block) or ckd (count key data)
      sample: ckd
      type: str
    xrc_session_timeout:
      description: The assigned XRC session timeout value.
      sample: 300
      type: int
  description: A list of dictionaries describing the lsses.
  elements: dict
  returned: success
  sample: "[\n    {\n        \"addrgrp\": \"0\",\n        \"cc_session_timeout\":\
    \ \"300\",\n        \"ckd_base_cu_type\": \"3990-6\",\n        \"configvols\"\
    : \"256\",\n        \"critical_mode\": \"disabled\",\n        \"extended_long_busy_time\"\
    : \"120\",\n        \"group\": \"0\",\n        \"id\": \"00\",\n        \"pprc_consistency_group\"\
    : \"disabled\",\n        \"sub_system_identifier\": \"5031\",\n        \"type\"\
    : \"ckd\",\n        \"xrc_session_timeout\": \"300\"\n    }\n]\n"
  type: list