ibm.storage_virtualize.ibm_sv_manage_storage_partition (2.3.1) — module

This module manages storage partition on IBM Storage Virtualize family systems

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

Authors: Shilpi Jain (@Shilpi-J)

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

This Ansible module provides the interface to manage syslog servers through 'mksyslogserver', 'chsyslogserver' and 'rmsyslogserver' Storage Virtualize commands.

The Policy based High Availability (HA) solution uses Storage Partitions. These partitions contain volumes, volume groups, host and host-to-volume mappings.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create Storage Partition
  ibm.storage_virtualize.ibm_sv_manage_storage_partition:
   clustername: '{{clustername}}'
   username: '{{username}}'
   password: '{{password}}'
   name: partition1
   state: present
   replicationpolicy: ha_policy_1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete the storage partition
  ibm.storage_virtualize.ibm_sv_manage_storage_partition:
   clustername: '{{clustername}}'
   username: '{{username}}'
   password: '{{password}}'
   name: partition1
   state: absent

Inputs

    
name:
    description:
    - Specifies the name of a storage partition.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Creates, updates (C(present)) or deletes (C(absent)) a storage partition.
    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

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

replicationpolicy:
    description:
    - Specifies the replication policy for the storage partition.
    type: str

noreplicationpolicy:
    description:
    - Unassigns the current replication policy from the volume group. This parameter,
      if used without I(deletepreferredmanagementcopy) parameter, is allowed only on active
      management system.
    type: bool

preferredmanagementsystem:
    description:
    - Changes the preferred management system for the storage partition.
    - Permitted only from the system which is the active management system.
    type: str

deletepreferredmanagementcopy:
    description:
    - This parameter is to be used along with I(noreplicationpolicy) parameter and active
      management system must NOT be the same as the preferred management system.
    type: bool

deletepreferredmanagementobjects:
    description:
    - If the storage partition has a replication policy and associated objects, such as
      volumes, volumes groups, hosts or host mappings, one of the two I(deletenonpreferredmanagementobjects)
      or I(deletepreferredmanagementobjects) parmeters is required. If the storage partition
      cannot be managed at the preferred management system then I(deletepreferredmanagementobjects)
      to be used to remove the storage partition and unassign the replication policy.
    - Applies when I(state=absent).
    type: bool

deletenonpreferredmanagementobjects:
    description:
    - If the storage partition has a replication policy and associated objects, such as
      volumes, volumes groups, hosts or host mappings, one of the two I(deletenonpreferredmanagementobjects)
      or I(deletepreferredmanagementobjects) parmeters is required. If specified, the
      command is only permitted on the active management system, and requires that the
      active management system is the same as the preferred management system.
    - Applies when I(state=absent).
    type: bool