ibm.ds8000.ds8000_resource_group_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 info on DS8000 resource groups.

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 resource groups
  ibm.ds8000.ds8000_resource_group_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 a resource group by label
  ibm.ds8000.ds8000_resource_group_info:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"
    label: my_rg

Scanned by Steampunk Spotter

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

- name: get a resource group by id
  ibm.ds8000.ds8000_resource_group_info:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"
    id: RG1

Inputs

    
id:
    description:
    - The unique identifier that is assigned to this resource group ID in the form RG\#.
    type: str

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

label:
    description:
    - The resource group label.
    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

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

resource_groups:
  contains:
    cs_global:
      description:
      - All of the Copy Services requests that establish or re-establish a relationship,
        and are subject to this resource scope including FlashCopy and PPRC relationships.
      sample: public
      type: str
    gm_masters:
      description:
      - An array of Global Mirror session IDs that are allowed to be used as a master
        session for volumes in this resource.
      - A Session ID is a hexadecimal number in the 01 - FF range.
      elements: str
      sample:
      - EA
      - F0
      type: list
    gm_sessions:
      description:
      - An array of Global Mirror session IDs that are allowed to be used for the
        volumes in this resource.
      - A Session ID is a hexadecimal number in the 01 - FF range.
      elements: str
      sample:
      - BE
      - FE
      type: list
    id:
      description: The Resource Group ID.
      sample: RG1
      type: str
    label:
      description: The Resource Group label.
      sample: ansible
      type: str
    name:
      description: The Resource Group name.
      sample: ansible
      type: str
    pass_global:
      description:
      - All of the Copy Services requests that are issued though a pass-through logical
        volume are treated as a relationship between the pass-through logical volume
        and source logical volume and are subject to this resource scope.
      sample: public
      type: str
    state:
      description: The Resource Group state.
      sample: normal
      type: str
  description: A list of dictionaries describing the resource groups.
  elements: dict
  returned: success
  sample: "[\n  {\n    \"id\": \"RG0\",\n    \"name\": \"Default_Resource_Group\"\
    ,\n    \"state\": \"normal\",\n    \"label\": \"PUBLIC\",\n    \"cs_global\":\
    \ \"PUBLIC\",\n    \"pass_global\": \"PUBLIC\",\n    \"gm_masters\": [\"00\",\
    \ \"01\", \"FE\", \"FF\"],\n    \"gm_sessions\": [\"00\", \"01\", \"FE\", \"FF\"\
    ]\n  }\n]\n"
  type: list