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

Manage 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: Ensure that a resource exists in the storage
  ibm.ds8000.ds8000_resource_group:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"
    label: my_rg
    state: present
    cs_global: "00"
    pass_global: "00"
    gm_masters: ["01", "02"]
    gm_sessions: ["01", "02"]

Scanned by Steampunk Spotter

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

- name: Ensure that a resource group does not exist in the storage
  ibm.ds8000.ds8000_resource_group:
    hostname: "{{ ds8000_host }}"
    username: "{{ ds8000_username }}"
    password: "{{ ds8000_password }}"
    label: my_rg
    state: absent

Inputs

    
id:
    description:
    - Unique identifier that is assigned to this resource group ID in the form RG
    - If not specified, one will be chosen.
    - Resource Group 0 is predefined and cannot be created, deleted, or modified. By default,
      all resources belong to this group unless otherwise specified.
    type: str

name:
    description:
    - The nickname that you assigned for this resource group object.
    type: str

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

label:
    description:
    - The resource group label is 1 to 32 characters and is limited to upper and lower
      case alphabetic and numeric characters, and the special characters (-), (_), and
      (.).
    - Required when I(state=present)
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Specify the state the DS8000 resource group should be in.
    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

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.
    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
    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
    type: list

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.
    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:
    id:
      description: The Resource Group ID.
      sample: RG1
      type: str
  description: A list of dictionaries describing the resource groups.
  elements: dict
  returned: I(state=present) changed
  sample: "[\n  {\n    \"id\": \"RG0\"\n  }\n]\n"
  type: list