Veritas InfoScale™ Installation, Upgrade, and Configuration Using Ansible - Linux

Last Published:
Product(s): InfoScale & Storage Foundation (8.0.2, 8.0, 7.4.3, 7.4.2, 7.4.1)
Platform: Linux

List of pre-defined keywords

Refer to the following tables for a list of the keywords that are used with each of the upgrade-related modules.

upgrade

The upgrade module is used to perform a full upgrade in InfoScale. Use the following keywords while referencing the module in your playbook.

Table: Upgrade module keywords

Name

Description

Mandatory/optional

product_version:

Specifies the version of the product that you want to install or upgrade.

Example: http://xx.xxx.xxx.xx/rpms/

Mandatory

gpg_check:

Specify whether to check the integrity of the yum packages by using the gpgkey provided with the InfoScale installation media. This is a boolean variable and must be specified using 0 or 1. By default the value is set to 0.

Optional

gpg_key:

Specifies the location of the gpgkey (typically located in the rpms directory of the installation media).

Example: 

http://xx.xxx.xxx.xx/rpms/
RPM-GPG-KEY-veritas-infoscale7

Mandatory, if gpgcheck is 1

state:

Specifies what state the package should be after the task is completed. The value for this keyword can be either present or absent. If you do not give any value for this parameter, by default, the state of the package is set to present, and the package will be installed.

Optional

license:

Specifies the path to the slf license file to be registered on the system. Ensure that the license file is accessible store on the same server where the installer is saved.

Perpetual key is not applicable for InfoScale 8.0.2 onwards.

If you are performing a keyless installation or upgrade you can simply enter the product name.

Examples: 

  • /license_key/Unix/perpetual/
xxxxxxxxxxxxx.slf

  • ENTERPRISE

  • AVAILABILITY

Optional

seednode

Select any node from the cluster that will be used to run commands related to the operations of that cluster.

Seednode can be set as FQDN, IP Address, and short hostname. Examples:

seednode: objstorer820-1-vm17.veritas.com

seednode: xx.xxx.xxx.xxx

seednode:  objstorer820-1-vm17

Ensure that you enter the host name as provided in the /etc/ansible/hosts file.

Mandatory

ignore_patchid _check

Specifies whether patch ID of the patch should be verified with that of the respective InfoScale version. The value of this keyword can be either 0 or 1.

Optional

patch_repo_list

Specifies the list of repositories which provide the patch paths or repository names.

  • If patch repositories are created and already exists on the hosts then this list should contain the name of those repositories.

  • If patch repositories are not created then this list should contain patch paths.

  • A combination of both - patch paths and repository names are also accepted in this list.

For example:

patch_repo_list:["ansible_patch_repo1", "ansible_patch_repo2",

patch_repo_list:["file:///mnt/linux/7.4.2/patch_central/P/ infoscale/rhel7_x86_64/7.4.2.1200/rpms/"]

patch_repo_list:["ansible_patch_repo1", "file:///mnt/linux/7.4.2/patch_central/P/ infoscale/rhel7_x86_64/7.4.2.1200/rpms/"]

Optional

gendeploy_path

Specifies the absolute path of the gendeploy script from the local node to register InfoScale hosts to the VIOM Management Server.

It is supported on InfoScale 8.0.2 and later.

Example:

gendeploy_path: '/root/script_path.pl'

Optional

ru_phase1

The ru_phase1 module is used to perform the first phase of a rolling upgrade on all systems sequentially (kernel packages). Use the following keywords while referencing the module in your playbook.

Table: Ru_phase1 module keywords

Name

Description

Mandatory/optional

product_version:

Specifies the version of the product that you want to install or upgrade.

Example: http://xx.xxx.xxx.xx/rpms/

Mandatory

gpgcheck:

Specify whether to check the integrity of the yum packages by using the gpgkey provided with the InfoScale installation media. This is a boolean variable and must be specified using 0 or 1. By default the value is set to 0.

Optional

gpgkey:

Specifies the location of the gpgkey (typically located in the rpms directory of the installation media).

Example: 

http://xx.xxx.xxx.xx/sde2/7.4.2/
dvd1-redhatlinux/rhel7_x86_64/rpms/
RPM-GPG-KEY-veritas-infoscale7

Mandatory. if gpgcheck is 1

product:

Specifies the name of the product you want to install.

Examples: ENTERPRISE, AVAILABILITY, STORAGE, or FOUNDATION.

Mandatory

state:

Specifies what state the package should be after the task is completed. The value for this keyword can be either present or absent. If you do not give any value for this parameter, by default, the state of the package is set to present, and the package will be installed.

Optional

license:

Specifies the path to the slf license file to be registered on the system. Ensure that the license file is accessible store on the same server where the installer is saved.

Perpetual key is not applicable for InfoScale 8.0.2 onwards.

If you are performing a keyless installation or upgrade you can simply enter the product name.

Examples: 

  • /license_key/Unix/perpetual/
xxxxxxxxxxxxxxxxxxx.slf

  • ENTERPRISE

  • AVAILABILITY

Optional

component:

Specify which components you want to configure in your product. Note that the product license acquired must support the required components.

Example: SF, VCS, or SFCHA

Mandatory

start_process

Specifies to start InfoScale processes if value is set to yes. By default this option is set to no.

Optional

seednode:

Select any node from the cluster that will be used to run commands related to the operations of that cluster.

Seednode can be set as FQDN, IP Address, and short hostname. Examples:

seednode: objstorer820-1-vm17.veritas.com

seednode: xx.xxx.xxx.xxx

seednode:  objstorer820-1-vm17

Ensure that you enter the host name as provided in the /etc/ansible/hosts file.

Mandatory

ignore_patchid _check

Specifies whether patch ID of the patch should be verified with that of the respective InfoScale version. The value of this keyword can be either 0 or 1.

Optional

patch_repo_list

Specifies the list of repositories which provide the patch paths or repository names.

  • If patch repositories are created and already exists on the hosts then this list should contain the name of those repositories.

  • If patch repositories are not created then this list should contain patch paths.

  • A combination of both - patch paths and repository names are also accepted in this list.

For example:

patch_repo_list:["ansible_patch_repo1", "ansible_patch_repo2",

patch_repo_list:["file:///mnt/linux/7.4.2/patch_central/P/ infoscale/rhel7_x86_64/7.4.2.1200/rpms/"]

patch_repo_list:["ansible_patch_repo1", "file:///mnt/linux/7.4.2/patch_central/P/ infoscale/rhel7_x86_64/7.4.2.1200/rpms/"]

Optional

ru_phase2 module keywords

The yum module is used to perform second phase of rolling upgrade on all systems simultaneously (non-kernel packages). Use the following keywords while referencing the module in your playbook.

Table: ru_phase2 module keyword

Name

Description

Mandatory/optional

product_version:

Specifies the version of the product that you want to install or upgrade.

Example: http://xx.xxx.xxx.xx/rpms/

Mandatory

gpgcheck:

Specify whether to check the integrity of the yum packages by using the gpgkey provided with the InfoScale installation media. This is a boolean variable and must be specified using 0 or 1. By default the value is set to 0.

Optional

gpgkey:

Specifies the location of the gpgkey (typically located in the rpms directory of the installation media).

Example: 

http://xx.xxx.xxx.xx/rpms/
RPM-GPG-KEY-veritas-infoscale7

Mandatory if gpgcheck is 1

product:

Specifies the name of the product you want to install.

Examples: ENTERPRISE, AVAILABILITY, STORAGE, or FOUNDATION.

Mandatory

state:

Specifies what state the package should be after the task is completed. The value for this keyword can be either present or absent. If you do not give any value for this parameter, by default, the state of the package is set to present, and the package will be installed.

Optional

license:

Specifies the path to the slf license file to be registered on the system. Ensure that the license file is accessible store on the same server where the installer is saved.

Perpetual key is not applicable for InfoScale 8.0.2 onwards.

If you are performing a keyless installation or upgrade you can simply enter the product name.

Examples: 

  • /license_key/Unix/perpetual/
xxxxxxxxxxxxxxxxxxxxxx.slf

  • ENTERPRISE

  • AVAILABILITY

Optional

component:

Specify which components you want to configure in your product. Note that the product license acquired must support the required components.

Example: SF, VCS, or SFCHA

Mandatory

start_process

Specifies to start InfoScale processes if value is set to yes. By default this option is set to no.

Optional

seednode:

Select any node from the cluster that will be used to run commands related to the operations of that cluster.

Seednode can be set as FQDN, IP Address, and short hostname Examples:

seednode: objstorer820-1-vm17.veritas.com

seednode: xx.xxx.xxx.xxx

seednode:  objstorer820-1-vm17

Ensure that you enter the host name as provided in the /etc/ansible/hosts file.

Mandatory

patch_repo_list

Specifies the list of repositories which provide the patch paths or repository names.

  • If patch repositories are created and already exists on the hosts then this list should contain the name of those repositories.

  • If patch repositories are not created then this list should contain patch paths.

  • A combination of both - patch paths and repository names are also accepted in this list.

For example:

patch_repo_list:["ansible_patch_repo1", "ansible_patch_repo2",

patch_repo_list:["file:///mnt/linux/7.4.2/patch_central/P/ infoscale/rhel7_x86_64/7.4.2.1200/rpms/"]

patch_repo_list:["ansible_patch_repo1", "file:///mnt/linux/7.4.2/patch_central/P/ infoscale/rhel7_x86_64/7.4.2.1200/rpms/"]

Optional

gendeploy_path

Specifies the absolute path of the gendeploy script from the local node to register InfoScale hosts to the VIOM Management Server.

It is supported on InfoScale 8.0.2 and later.

Example:

gendeploy_path: '/root/script_path.pl'

Optional

patchupgrade module keywords

The patchupgrade module upgrades patch versions for the provided InfoScale version accordingly. A patchupgrade can be performed while installing InfoScale or even post configuration of InfoScale components on the hosts. It upgrades the patches to the highest supported patch versions for the provided InfoScale version.

Table: patchupgrade module keywords

Names

Description

Mandatory/Optional

ignore_patchid_check

Specifies whether patch ID of the patch should be verified with that of the respective InfoScale version. The value of this keyword can be either 0 or 1.

Optional

patch_repo_list

Specifies the list of repositories which provide the patch paths or repository names.

  • If patch repositories are created and already exists on the hosts then this list should contain the name of those repositories.

  • If patch repositories are not created, then this list should contain patch paths.

  • A combination of both - patch paths and repository names are also accepted in this list.

Examples

patch_repo_list: ["ansible_patch_repo1", 
"ansible_patch_repo2",]

patch_repo_list: 
["file:///mnt/linux/7.4.2/patch_central/P/
infoscale/rhel7_x86_64/7.4.2.1200/rpms/"]

patch_repo_list: ["ansible_patch_repo1", 
"file:///mnt/linux/7.4.2/patch_central/P/
infoscale/rhel7_x86_64/7.4.2.1200/rpms/"]

Mandatory

state

Specifies what state the package should be after the task is completed. The value for this keyword can be either present or absent. Default value is 'present'.

Mandatory

facters

Enter the following value to collect system-related data from the cluster servers. 

"{{ ansible_play_hosts_all |map('extract', 
hostvars, ['facts','infoscale_facts'])
| select()|list }}"

Mandatory

gendeploy_path

Specifies the absolute path of the gendeploy script from the local node to register InfoScale hosts to the VIOM Management Server.

It is supported on InfoScale 8.0.2 and later.

Example:

gendeploy_path: '/root/script_path.pl'

Optional