ibm.storage_virtualize.ibm_svc_initial_setup (2.3.1) — module

This module allows users to manage the initial setup configuration on IBM Storage Virtualize family systems

| "added in version" 1.7.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

Ansible interface to perform various initial system configuration

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Initial configuration on FlashSystem 9200
  ibm.storage_virtualize.ibm_svc_initial_setup:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    system_name: cluster_test_0
    time: 101009142021
    timezone: 200
    remote: 50
    virtualization: 50
    flash: 50
    license_key:
      - 0123-4567-89AB-CDEF
      - 8921-4567-89AB-GHIJ
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Add DNS servers
  ibm.storage_virtualize.ibm_svc_initial_setup:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    system_name: cluster_test_
    dnsname:
      - dns_01
      - dns_02
    dnsip:
      - '1.1.1.1'
      - '2.2.2.2'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete dns_02 server
  ibm.storage_virtualize.ibm_svc_initial_setup:
    clustername: "{{clustername}}"
    domain: "{{domain}}"
    username: "{{username}}"
    password: "{{password}}"
    log_path: /tmp/playbook.debug
    system_name: cluster_test_
    dnsname:
      - dns_01
    dnsip:
      - '1.1.1.1'

Inputs

    
time:
    description:
    - Specifies the time to which the system must be set.
    - This value must be in the following format MMDDHHmmYYYY (where M is month, D is
      day, H is hour, m is minute, and Y is year).
    type: str

cloud:
    description:
    - Specifies the number of enclosures for the transparent cloud tiering function.
    type: int

dnsip:
    description:
    - Specifies the DNS server Internet Protocol (IP) address.
    elements: str
    type: list

flash:
    description:
    - Changes system licensing for the FlashCopy function.
    - Depending on the type of system, specify a capacity value in terabytes (TB) or specify
      the total number of internal and external enclosures for the FlashCopy function.
    type: int

ntpip:
    description:
    - Specifies the IPv4 address or fully qualified domain name (FQDN) for the Network
      Time Protocol (NTP) server.
    - To remove an already configured NTP IP, user must specify 0.0.0.0.
    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

remote:
    description:
    - Changes system licensing for remote-copy functions such as Metro Mirror, Global
      Mirror, and HyperSwap.
    - Depending on the type of system, specify a capacity value in terabytes (TB) or specify
      the total number of internal and external enclosures that user has licensed on the
      system. There must be an enclosure license for all enclosures.
    type: int

dnsname:
    description:
    - Specifies a unique name for the system DNS server being created.
    - Maximum two DNS servers can be configured. User needs to provide the complete list
      of DNS servers that are required to be configured.
    elements: str
    type: list

easytier:
    description:
    - Specifies the number of enclosures on which user can run Easy Tier.
    type: int

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

timezone:
    description:
    - Specifies the time zone to set for the system.
    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

encryption:
    choices:
    - 'on'
    - 'off'
    description:
    - Specifies whether the encryption license function is enabled or disabled.
    type: str

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

compression:
    description:
    - Changes system licensing for the compression function.
    - Depending on the type of system, specify a capacity value in terabytes (TB) or specify
      the total number of storage capacity units (SCUs) that user is licensed to virtualize
      across tiers of storage on the system or specify the total number of internal and
      external enclosures that user has licensed on the system.
    type: int

license_key:
    description:
    - Provides the license key to activate a feature that contains 16 hexadecimal characters
      organized in four groups of four numbers with each group separated by a hyphen (such
      as 0123-4567-89AB-CDEF).
    elements: str
    type: list

system_name:
    description:
    - Specifies system name.
    type: str

physical_flash:
    choices:
    - 'on'
    - 'off'
    default: 'off'
    description:
    - For physical disk licensing, this parameter enables or disables the FlashCopy function.
    type: str

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

virtualization:
    description:
    - Changes system licensing for the Virtualization function.
    - Depending on the type of system, specify a capacity value in terabytes (TB) or specify
      the total number of storage capacity units (SCUs) that user is licensed to virtualize
      across tiers of storage on the system or specify the number of enclosures of external
      storage that user is authorized to use.
    type: int