ibm.storage_virtualize.ibm_sv_manage_ip_partnership (2.3.1) — module

This module manages IP partnerships on IBM Storage Virtualize family systems

| "added in version" 1.9.0 of ibm.storage_virtualize"

Authors: Sreshtant Bohidar(@Sreshtant-Bohidar)

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 'mkippartnership', 'rmpartnership', and 'chpartnership' commands on local and remote systems.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create an IP partnership
  ibm.storage_virtualize.ibm_sv_manage_ip_partnership:
    clustername: "{{ clustername }}"
    domain: "{{ domain }}"
    username: "{{ username }}"
    password: "{{ password }}"
    remote_clustername: "{{ remote_clustername }}"
    remote_domain: "{{ remote_domain }}"
    remote_username: "{{ remote_username }}"
    remote_password: "{{ remote_password }}"
    log_path: "/tmp/debug.log"
    remote_clusterip: "{{ partner_ip }}"
    type: "ipv4"
    linkbandwidthmbits: 100
    backgroundcopyrate: 50
    compressed: yes
    link1: "{{ portsetname }}"
    remote_link1: "{{ remote_portsetname}}"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update an IP partnership
  ibm.storage_virtualize.ibm_sv_manage_ip_partnership:
    clustername: "{{ clustername }}"
    domain: "{{ domain }}"
    username: "{{ username }}"
    password: "{{ password }}"
    remote_clustername: "{{ remote_clustername }}"
    remote_domain: "{{ remote_domain }}"
    remote_username: "{{ remote_username }}"
    remote_password: "{{ remote_password }}"
    log_path: "/tmp/debug.log"
    remote_cluster_id: "{{ cluster_id }}"
    linkbandwidthmbits: 110
    backgroundcopyrate: 60
    compressed: no
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove an IP partnership
  ibm.storage_virtualize.ibm_sv_manage_ip_partnership:
    clustername: "{{ clustername }}"
    username: "{{ username }}"
    password: "{{ password }}"
    remote_clustername: "{{ remote_clustername }}"
    remote_username: "{{ remote_username }}"
    remote_password: "{{ remote_password }}"
    log_path: "/tmp/debug.log"
    remote_cluster_id: "{{ cluster_id }}"
    state: "absent"

Inputs

    
type:
    choices:
    - ipv4
    - ipv6
    description:
    - Specifies the Internet Protocol (IP) address format for the partnership.
    - Valid when I(state=present).
    type: str

link1:
    description:
    - Specifies the portset name to be used for WAN link 1 of the Storage Virtualize system.
    - Valid when I(state=present), to create an IP partnership.
    type: str

link2:
    description:
    - Specifies the portset name to be used for WAN link 2 of the Storage Virtualize system.
    - Valid when I(state=present), to create an IP partnership.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Creates or updates (C(present)) or removes (C(absent)) an IP 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

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

compressed:
    choices:
    - 'yes'
    - 'no'
    description:
    - Specifies whether compression is enabled for this partnership.
    - Valid when I(state=present).
    type: str

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

remote_link1:
    description:
    - Specifies the portset name to be used for WAN link 1 of the remote Storage Virtualize
      system.
    - Valid when I(state=present), to create an IP partnership.
    type: str

remote_link2:
    description:
    - Specifies the portset name to be used for WAN link 2 of the remote Storage Virtualize
      system.
    - Valid when I(state=present), to create an IP partnership.
    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

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

remote_clusterip:
    description:
    - Specifies the partner system IP address, either IPv4 or IPv6.
    - Required when I(state=present), to create an IP partnership.
    type: str

remote_cluster_id:
    description:
    - Specifies the partnership ID of the partner system.
    - Required when I(state=present), to modify an existing IP partnership.
    - Required when I(state=absent), to remove an existing IP partnership.
    type: str

backgroundcopyrate:
    description:
    - Specifies the maximum percentage of aggregate link bandwidth that can be used for
      background copy operations. This is a numeric value from 0 through 100. The default
      value is 50.
    - Valid when I(state=present).
    type: int

linkbandwidthmbits:
    description:
    - Specifies the aggregate bandwidth of the RC link between two clustered systems (systems)
      in megabits per second (Mbps). This is a numeric value from 1 through 100000.
    - Valid when I(state=present).
    type: int

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

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