ibm.storage_virtualize.ibm_sv_manage_fc_partnership (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 mkfcpartnership, chpartnership, and rmpartnership commands.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create an FC partnership and start the partnership
  ibm.storage_virtualize.ibm_sv_manage_fc_partnership:
    clustername: "{{clustername}}"
    username: "{{username}}"
    password: "{{password}}"
    remote_clustername: "{{remote_clustername}}"
    remote_username: "{{remote_username}}"
    remote_password: "{{remote_password}}"
    remote_system: "{{remote_system}}"
    linkbandwidthmbits: 50
    backgroundcopyrate: 50
    start: True
    state: present

Scanned by Steampunk Spotter

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

- name: Update an FC partnership and stop the partnership
  ibm.storage_virtualize.ibm_sv_manage_fc_partnership:
    clustername: "{{clustername}}"
    username: "{{username}}"
    password: "{{password}}"
    remote_clustername: "{{remote_clustername}}"
    remote_username: "{{remote_username}}"
    remote_password: "{{remote_password}}"
    remote_system: "{{remote_system}}"
    linkbandwidthmbits: 40
    backgroundcopyrate: 20
    stop: True
    state: present

Scanned by Steampunk Spotter

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

- name: Delete the FC partnership
  ibm.storage_virtualize.ibm_sv_manage_fc_partnership:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    remote_clustername: "{{remote_clustername}}"
    remote_username: "{{remote_username}}"
    remote_password: "{{remote_password}}"
    remote_system: "{{remote_system}}"
    state: absent

Inputs

    
stop:
    description:
    - Specifies to stop a partnership.
    - Valid when I(state=present) to update a partnership.
    type: bool

start:
    description:
    - Specifies to start a partnership.
    - Valid when I(state=present).
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Creates or updates (C(present)) or removes (C(absent)) a FC partnership.
    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

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

pbrinuse:
    choices:
    - 'yes'
    - 'no'
    description:
    - Specifies whether policy-based replication will be used on the partnership.
    - Valid when I(state=present) to update a partnership.
    type: str

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

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

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

remote_system:
    description:
    - Specifies the partner system ID or name.
    type: str

validate_certs:
    default: false
    description:
    - Validates certification for the local Storage Virtualize system.
    type: bool

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

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

backgroundcopyrate:
    description:
    - Specifies the maximum percentage of aggregate link bandwidth that can be used for
      background copy operations. The value must be in the range of 0 - 100. The default
      value is 50.
    - Valid when I(state=present).
    type: str

linkbandwidthmbits:
    description:
    - Specifies the aggregate bandwidth of the remote copy link between two clustered
      systems (systems) in megabits per second (Mbps). The value must be in the range
      of 1 - 100000.
    - Valid when I(state=present).
    type: str

remote_clustername:
    description:
    - The hostname or management IP of the remote Storage Virtualize system.
    type: str

remote_validate_certs:
    default: false
    description:
    - Validates certification for the remote Storage Virtualize system.
    type: bool