ibm.storage_virtualize.ibm_svc_manage_ip (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 'mkip' and 'rmip' commands.

This module can run on all IBM Storage Virtualize systems running on 8.4.2.0 or later.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create IP provisioning
  ibm.storage_virtualize.ibm_svc_manage_ip:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   log_path: /tmp/playbook.debug
   node: node1
   port: 1
   portset: portset0
   ip_address: x.x.x.x
   subnet_prefix: 20
   gateway: x.x.x.x
   vlan: 1
   shareip: true
   state: present

Scanned by Steampunk Spotter

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

- name: Remove IP provisioning
  ibm.storage_virtualize.ibm_svc_manage_ip:
   clustername: "{{cluster}}"
   username: "{{username}}"
   password: "{{password}}"
   log_path: /tmp/playbook.debug
   node: node1
   port: 1
   portset: portset0
   ip_address: x.x.x.x
   state: absent

Inputs

    
node:
    description:
    - Specifies the name of the node.
    required: true
    type: str

port:
    description:
    - Specifies a port ranging from 1 - 16 to which IP shall be assigned.
    required: true
    type: int

vlan:
    description:
    - Specifies a vlan id ranging from 1 - 4096.
    - Applies when I(state=present).
    type: int

state:
    choices:
    - present
    - absent
    description:
    - Creates (C(present)) or removes (C(absent)) an IP address.
    required: true
    type: str

token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - To generate a token, use the 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

gateway:
    description:
    - Specifies the gateway address.
    - Applies when I(state=present).
    type: str

portset:
    description:
    - Specifies the name of the portset object.
    type: str

shareip:
    description:
    - Specifies the flag when IP is shared between multiple portsets.
    - Applies when I(state=present).
    type: bool

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

ip_address:
    description:
    - Specifies a valid ipv4/ipv6 address.
    required: true
    type: str

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

subnet_prefix:
    description:
    - Specifies the prefix of subnet mask.
    - Applies when I(state=present).
    type: int

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