ibm.ds8000.ds8000_host_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 hosts.

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

Scanned by Steampunk Spotter

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

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

Inputs

    
name:
    description: The host name.
    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

hosts:
  contains:
    addrdiscovery:
      description: The LUN address discovery method used by the host system and host
        system port.
      sample: lunpolling
      type: str
    addrmode:
      description:
      - The method used by the host to discover the LUNs that are available to its
        host ports.
      - For example, scsimask, scsimap256, os400mask.
      sample: scsimap256
      type: str
    host_ports_briefs:
      contains:
        wwpn:
          description: The host port WWPN.
          sample: 10000090FA8E52DF
          type: str
      description: A dictionary describing the host ports assigned to the host.
      elements: dict
      type: list
    hosttype:
      description: The name of the host type as defined by the operating system.
      sample: Linux
      type: str
    lbs:
      description:
      - Logical block size of the volumes that the host can access.
      - Block size is determined by the host type.
      sample: '512'
      type: str
    login_ports:
      contains:
        id:
          description: The IO port ID.
          sample: I0000
          type: str
        state:
          description: The IO port state.
          sample: offline
          type: str
        wwpn:
          description: The IO port WWPN.
          sample: 500507630801054F
          type: str
      description: A list of dictionaries describing IO ports with logins.
      elements: dict
      type: list
    mappings_briefs:
      contains:
        lunid:
          description: The LUN ID.
          sample: 40B04000
          type: str
        volume_id:
          description: The volume ID.
          sample: B000
          type: str
      description: A dictionary describing the volumes mapped to the host.
      elements: dict
      type: list
    name:
      description: The host name.
      sample: ansible
      type: str
    state:
      description:
      - Specifies one of the states of the specified host.
      - If at least one host port is in the logged in state, the state displays as
        online.
      - If no host ports were added to the specified host, or if all of the added
        host ports are logged out, the state displays as offline.
      sample: online
      type: str
  description: A list of dictionaries describing the hosts.
  elements: dict
  returned: success
  sample: "[\n    {\n        \"addrdiscovery\": \"reportlun\",\n        \"addrmode\"\
    : \"SCSI mask\",\n        \"host_id\": \"H5\",\n        \"host_ports_briefs\"\
    : [\n            {\n                \"wwpn\": \"10000090FA8E52DF\"\n         \
    \   },\n            {\n                \"wwpn\": \"10000090FA8E52DE\"\n      \
    \      },\n            {\n                \"wwpn\": \"10000090FA8E52EB\"\n   \
    \         },\n            {\n                \"wwpn\": \"10000090FA8E52EA\"\n\
    \            }\n        ],\n        \"hosttype\": \"pSeries\",\n        \"lbs\"\
    : \"512\",\n        \"login_ports\": [\n            {\n                \"id\"\
    : \"I0010\",\n                \"state\": \"online\",\n                \"wwpn\"\
    : \"500507630801054C\"\n            },\n            {\n                \"id\"\
    : \"I0130\",\n                \"state\": \"online\",\n                \"wwpn\"\
    : \"50050763080B054C\"\n            }\n        ],\n        \"mappings_briefs\"\
    : [\n            {\n                \"lunid\": \"40B04000\",\n               \
    \ \"volume_id\": \"B000\"\n            },\n            {\n                \"lunid\"\
    : \"40B04001\",\n                \"volume_id\": \"B001\"\n            },\n   \
    \         {\n                \"lunid\": \"40B14000\",\n                \"volume_id\"\
    : \"B100\"\n            },\n            {\n                \"lunid\": \"40B14001\"\
    ,\n                \"volume_id\": \"B101\"\n            }\n        ],\n      \
    \  \"name\": \"ansible\",\n        \"state\": \"online\"\n    }\n]\n"
  type: list