ibm.storage_virtualize.ibm_svc_initial_setup module – This module allows users to manage the initial setup configuration on IBM Storage Virtualize family systems
Note
This module is part of the ibm.storage_virtualize collection (version 2.7.3).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ibm.storage_virtualize.
To use it in a playbook, specify: ibm.storage_virtualize.ibm_svc_initial_setup.
New in ibm.storage_virtualize 1.7.0
Synopsis
Ansible interface to perform various initial system configuration
Parameters
Parameter |
Comments |
|---|---|
Specify the CHAP secret to authenticate the system using iSCSI. Required when iscsiauthmethod=chap, to modify a CHAP secret. If chapsecret is specified as an empty string (“”), it is treated as nochapsecret, which clears current chapsecret. |
|
Specifies the number of enclosures for the transparent cloud tiering function. |
|
The hostname or management IP of the Storage Virtualize system. |
|
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. |
|
Specifies the DNS server Internet Protocol (IP) address. |
|
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. |
|
Domain for the Storage Virtualize system. Valid when hostname is used for the parameter clustername. |
|
Specifies the number of enclosures on which user can run Easy Tier. |
|
Specifies whether the encryption license function is enabled or disabled. Choices:
|
|
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. |
|
Allow a user to change the FC grainsize to be one of either 64K or 256K. |
|
Specify the authentication method for iSCSI communications on the system. Choices:
|
|
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). |
|
Path of debug log file. |
|
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. |
|
REST API password for the Storage Virtualize system. The parameters username and password are required if not using token to authenticate a user. |
|
For physical disk licensing, this parameter enables or disables the FlashCopy function. Choices:
|
|
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. |
|
Indicates whether the storage insights control access for the system is enabled or disabled. Choices:
|
|
Specifies system name. |
|
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). |
|
Specifies the time zone to set for the system. |
|
The authentication token to verify a user on the Storage Virtualize system. To generate a token, use the ibm.storage_virtualize.ibm_svc_auth module. |
|
REST API username for the Storage Virtualize system. The parameters username and password are required if not using token to authenticate a user. |
|
Validates certification. Choices:
|
|
Specifies whether the volume protection is enabled or disabled. Choices:
|
|
Specifies the volume protection time (in minutes). |
|
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. |
Notes
Note
This module supports
check_mode.Error Considerations - CMMVC5708E A parameter is missing a value. - CMMVC5713E Some parameters are mutually exclusive. - CMMVC7218E The provided license key is not valid.
Examples
- 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
- 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'
- 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'
- name: Change flashcopydefaultgrainsize to 64 and storageinsightscontrolaccess to no.
ibm.storage_virtualize.ibm_svc_initial_setup:
clustername: "{{ clustername }}"
username: "{{ username }}"
password: "{{ password }}"
log_path: /tmp/playbook.debug
flashcopydefaultgrainsize: 64
storageinsightscontrolaccess: "no"
- name: Change vdiskprotectiontime to 20 and vdiskprotectionenabled to yes.
ibm.storage_virtualize.ibm_svc_initial_setup:
clustername: "{{ clustername }}"
username: "{{ username }}"
password: "{{ password }}"
log_path: /tmp/playbook.debug
vdiskprotectiontime: 20
vdiskprotectionenabled: "yes"
- name: Change iscsiauthmethod to chap and set chapsecret.
ibm.storage_virtualize.ibm_svc_initial_setup:
clustername: "{{ clustername }}"
username: "{{ username }}"
password: "{{ password }}"
log_path: /tmp/playbook.debug
iscsiauthmethod: chap
chapsecret: "test_cs"
- name: Change iscsiauthmethod to none and clear chapsecret.
ibm.storage_virtualize.ibm_svc_initial_setup:
clustername: "{{ clustername }}"
username: "{{ username }}"
password: "{{ password }}"
log_path: /tmp/playbook.debug
iscsiauthmethod: none
chapsecret: ""