ibm.storage_virtualize.ibm_svc_manage_sra (2.3.1) — module

Install collection

Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1

Add to requirements.yml

  collections:
    - name: ibm.storage_virtualize
      version: 2.3.1

Description

Ansible interface to manage 'chsra' support remote assistance command.

Usage examples

Scanned by Steampunk Spotter

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

- name: Enable support remote assistance
  ibm.storage_virtualize.ibm_svc_manage_sra:
    clustername: "{{ clustername }}"
    domain: "{{ domain }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: "{{ log_path }}"
    support: remote
    state: enabled
    name:
      - proxy_1
      - proxy_2
      - proxy_3
    sra_ip:
      - '0.0.0.0'
      - '1.1.1.1'
      - '2.1.2.2'
    sra_port:
      - 8888
      - 9999
      - 8800

Scanned by Steampunk Spotter

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

- name: Disable support remote assistance
  ibm.storage_virtualize.ibm_svc_manage_sra:
    clustername: "{{ clustername }}"
    domain: "{{ domain }}"
    username: "{{ username }}"
    password: "{{ password }}"
    log_path: "{{ log_path }}"
    support: remote
    state: disabled
    name:
      - proxy_1
      - proxy_2
      - proxy_3

Inputs

    
name:
    description:
    - Specifies the list of unique names for the support center or proxy to be defined.
    - Required when I(support=remote), to enable remote support assistance.
    elements: str
    type: list

state:
    choices:
    - enabled
    - disabled
    description:
    - Enables (C(enabled)) or disables (C(disabled)) the remote support assistance.
    required: true
    type: str

token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - To generate a token, use the M(ibm.storage_virtualize.ibm_svc_auth) module.
    type: str

domain:
    description:
    - Domain for the Storage Virtualize system.
    - Valid when hostname is used for the parameter I(clustername).
    type: str

sra_ip:
    description:
    - Specifies the list of IP addresses or fully qualified domain names for the new support
      center or proxy server.
    - Required when I(support=remote) and I(state=enabled), to enable support remote assistannce.
    elements: str
    type: list

support:
    choices:
    - remote
    - onsite
    description:
    - Specifies the support assistance through C(remote) or C(onsite).
    required: true
    type: str

log_path:
    description:
    - Path of debug log file.
    type: str

password:
    description:
    - REST API password for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

sra_port:
    description:
    - Specifies the list of port numbers for the new support center or proxy server.
    - Required when I(support=remote) and I(state=enabled), to enable support remote assistannce.
    elements: str
    type: list

username:
    description:
    - REST API username for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

clustername:
    description:
    - The hostname or management IP of the Storage Virtualize system.
    required: true
    type: str

validate_certs:
    default: false
    description:
    - Validates certification.
    type: bool