ibm.ds8000.ds8000_host_port_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 host ports.

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

    
host:
    description:
    - The name of the DS8000 host to query.
    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

host_port:
    description:
    - List of host port WWPNs to query.
    elements: str
    type: list

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

host_ports:
  contains:
    addrdiscovery:
      description: The LUN address discovery method used by the host and host port.
      sample: reportlun
      type: str
    host:
      description: The name of the host the host port is assigned to.
      sample: ansible
      type: str
    host_id:
      description: The ID of the host the host port is assigned to.
      sample: H5
      type: str
    hosttype:
      description: The name of the host type as defined by the operating system.
      sample: Linux
      type: str
    lbs:
      description:
      - The logical block size used by the designated host and host port.
      - Block size is determined by the host type.
      sample: '512'
      type: str
    logical_paths_established:
      description: The number of logical paths established.
      sample: 0
      type: int
    login_ports:
      contains:
        port:
          description: The logged in IO port ID.
          sample: I0011
          type: str
      description: A list containing the IO ports the host port is logged into.
      type: list
    login_type:
      description: The method used to login.
      sample: scsi
      type: str
    state:
      description: The login state of the host.
      sample: logged in
      type: str
    wwnn:
      description: The host port WWNN.
      sample: 10000000C9A1BAB2
      type: str
    wwpn:
      description: The host port WWPN.
      sample: 10000000C9A1BAB2
      type: str
  description: A list of dictionaries describing the host_ports.
  elements: dict
  returned: success
  sample: "[\n    {\n        \"addrdiscovery\": \"reportlun\",\n        \"host\":\
    \ \"janus\",\n        \"host_id\": \"H5\",\n        \"hosttype\": \"pSeries\"\
    ,\n        \"lbs\": \"512\",\n        \"logical_path_established\": \"0\",\n \
    \       \"login_ports\": [\n            \"I0131\"\n        ],\n        \"login_type\"\
    : \"scsi\",\n        \"state\": \"logged in\",\n        \"wwnn\": \"20000090FA8E52DE\"\
    ,\n        \"wwpn\": \"10000090FA8E52DE\"\n    }\n]\n"
  type: list