Veritas Infoscale Installation, Upgrade, and Configuration Using Ansible - Linux
Veritas Infoscale Installation, Upgrade, and Configuration Using Ansible - Linux
Veritas Infoscale Installation, Upgrade, and Configuration Using Ansible - Linux
Legal Notice
Copyright © 2019 Veritas Technologies LLC. All rights reserved.
Veritas and the Veritas Logo are trademarks or registered trademarks of Veritas Technologies
LLC or its affiliates in the U.S. and other countries. Other names may be trademarks of their
respective owners.
This product may contain third-party software for which Veritas is required to provide attribution
to the third-party (“Third-Party Programs”). Some of the Third-Party Programs are available
under open source or free software licenses. The License Agreement accompanying the
Software does not alter any rights or obligations you may have under those open source or
free software licenses. Refer to the third-party legal notices document accompanying this
Veritas product or available at:
https://www.veritas.com/about/legal/license-agreements
The product described in this document is distributed under licenses restricting its use, copying,
distribution, and decompilation/reverse engineering. No part of this document may be
reproduced in any form by any means without prior written authorization of Veritas Technologies
LLC and its licensors, if any.
The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, et seq.
"Commercial Computer Software and Commercial Computer Software Documentation," as
applicable, and any successor regulations, whether delivered by Veritas as on premises or
hosted services. Any use, modification, reproduction release, performance, display or disclosure
of the Licensed Software and Documentation by the U.S. Government shall be solely in
accordance with the terms of this Agreement.
http://www.veritas.com
Technical Support
Technical Support maintains support centers globally. All support services will be delivered
in accordance with your support agreement and the then-current enterprise technical support
policies. For information about our support offerings and how to contact Technical Support,
visit our website:
https://www.veritas.com/support
You can manage your Veritas account information at the following URL:
https://my.veritas.com
If you have questions regarding an existing support agreement, please email the support
agreement administration team for your region as follows:
Japan [email protected]
Documentation
Make sure that you have the current version of the documentation. Each document displays
the date of the last update on page 2. The latest documentation is available on the Veritas
website:
https://sort.veritas.com/documents
Documentation feedback
Your feedback is important to us. Suggest improvements or report errors or omissions to the
documentation. Include the document title, document version, chapter title, and section title
of the text on which you are reporting. Send feedback to:
You can also see documentation information or ask a question on the Veritas community site:
http://www.veritas.com/community/
https://sort.veritas.com/data/support/SORT_Data_Sheet.pdf
Contents
■ Inroduction to Ansible
Inroduction to Ansible
Ansible is a popular configuration management tool that automates various
configuration and deployment operations in your environment. Ansible playbooks
are files written in the YAML format, which contains human-readable code. Ansible
playbooks can be used to define operations in your environment.
Veritas now provides Ansible modules that can be used in Ansible playbooks to
install or upgrade Veritas InfoScale products, deploy clusters, and configure features
such as File System (FS), Cluster File System (CFS), and Disk Group Volume.
Preparing to use Ansible in InfoScale 6
Downloading Ansible modules for InfoScale
Supported platforms
You can use Ansible to deploy and configure Veritas InfoScale on all Linux platforms
supported by InfoScale.
Note: The user can use the pl utility to set up the SSH and RSH connections
automatically.
Preparing to use Ansible in InfoScale 7
Using site_facters module
■ Ensure that Python 2.x is installed and configured on all machines in the
environment.
yum
The yum module is used to install or uninstall InfoScale products using yum. Use
the following keywords while referencing the module in your playbook.
repository_name: Name of the yum repository used to install InfoScale rpms. Mandatory, if the base
URL is not provided (If
Example:
the Base URL is
repo-InfoScale741 provided the system
will create a repository
name, optional for
install.)
Installing using Ansible 11
List of pre-defined keywords
repository_baseurl: Specifies the URL to the directory where the repodata of a repository Optional (This
is located. keyword is not
required if you are
Example:
using a yum repository
http://xx.xxx.xxx.xx/rpms/ already configured on
the system, and are
providing the
repository name.)
gpgcheck: Specify whether to check the integrity of the yum packages by using Optional
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.
gpgkey: Specifies the location of the gpgkey (typically located in the rpms Mandatory, if
directory of the installation media). gpgcheck is 1
Example:
http://xx.xxx.xxx.xx/rpms/
RPM-GPG-KEY-veritas-infoscale7
product: Specifies the name of the product you want to install. Mandatory
state: Specifies what state the package should be after the task is completed. Optional
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.
licensing
The licensing module is used to apply licenses in InfoScale. Use the following
keywords while referencing the module in your playbook.
state: Specifies what state the package should be after the task is completed. Optional
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.
Installing using Ansible 12
List of pre-defined keywords
product_version: Specifies the version of the product that you want to install or upgrade. Mandatory
Example: http://xx.xxx.xxx.xx/rpms/
license: Specifies the path to the slf license file to be registered on the system. Mandatory
Ensure that the license file is accessible store on the same server
where the installer is saved.
Examples:
■ /license_key/Unix/perpetual/
xxxxxxxxxxxxxxxxx.slf
■ ENTERPRISE
■ AVAILABILITY
Chapter 3
Configuring InfoScale
product components
This chapter includes the following topics:
Component ■ site_facters
configuration ■ config_component
Configuring InfoScale product components 15
Ansible modules for configuring InfoScale
Configuring sfcfsha
---
- hosts: cpicluster11
gather_facts: false
any_errors_fatal: true
tasks:
- name: Facters
veritas_infoscale:
module: site_facters
register: facts
- name: Configure Enterprise
veritas_infoscale:
module: sfha_config
cluster_name: clust_cpi9
systems: [objstorer820-1-vm16,objstorer820-1-vm17]
cluster_uuid: c7c2d65e-058f-11e8-a32c-c094107f3b61
component: sfcfsha
product_version: '7.4.1'
method: ethernet
state: present
private_link: eth1,eth2
low_priority_link: eth0
vcs_clusterid: 23838
facters: "{{ groups['all'] |map('extract',
hostvars, ['facts','infoscale_facts'])| select()|list }}"
Configuring sfha
---
- hosts: cpicluster11
gather_facts: true
any_errors_fatal: true
tasks:
- name: Facters
veritas_infoscale:
module: site_facters
register: facts
- name: Configure Enterprise
veritas_infoscale:
module: sfha_config
cluster_name: clust_cpi9
systems: [objstorer820-1-vm16,objstorer820-1-vm17]
Configuring InfoScale product components 16
Ansible modules for configuring InfoScale
cluster_uuid: c7c2d65e-058f-11e8-a32c-c094107f3b61
component: sfha
product_version: '7.4.1'
method: ethernet
state: present
private_link: eth1,eth2
low_priority_link: eth0
vcs_clusterid: 23838
facters: "{{ groups['all'] |map('extract',
hostvars, ['facts','infoscale_facts'])| select()|list }}"
Configuring sf
---
- hosts: cpicluster11
gather_facts: true
any_errors_fatal: true
tasks:
- name: Facters
veritas_infoscale:
module: site_facters
register: facts
- name: Configure Enterprise
veritas_infoscale:
module: sfha_config
cluster_name: clust_cpi9
systems: [dl380g10-12-kvm-04,dl380g10-12-kvm-03]
cluster_uuid: c7c2d65e-058f-11e8-a32c-c094107f3b61
component: sfha
product_version: '7.4.1'
method: ethernet
state: present
private_link: eth1,eth2
low_priority_link: eth0
vcs_clusterid: 23838
Configuring InfoScale product components 17
Ansible modules for configuring InfoScale
sfcfsha_config
The sfcfsha_config module is used configure the component in InfoScale . Use the
following keywords while referencing the module in your playbook.
cluster_name: Define a name for the cluster that you want to deploy. Mandatory
Example: Cluster1
cluster_uuid: Define a unique alphanumeric ID to assign to the cluster you want to Mandatory
deploy.
Example: c7c2d65e-057f-11e8-a32c-c094107f3b61
component: Specify which components you want to configure in your product. Note Mandatory
that the product license acquired must support the required
components.
method: Specify the communication protocol that you want to deploy in the Mandatory
cluster.
state: Specifies what state the package should be after the task is completed. Optional
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.
private_link: Lists the name or the address (IPv4 or IPv6) that each heartbeat link Mandatory
uses on each of the nodes in the cluster.
low_priority_link: Lists the name or the address (IPv4 or IPv6) that each low priority Optional
heartbeat link uses on each of the nodes in the cluster.
process
The process module is used to start and stop component processes. Use the
following keywords while referencing the module in your playbook.
component: Specify which components you want to configure in your product. Note Mandatory
that the product license acquired must support the required
components.
product: Specifies the name of the product you want to install. Mandatory
product_version: Specifies the version of the product that you want to install or upgrade. Mandatory
Example: http://xx.xxx.xxx.xx/rpms/
Chapter 4
Upgrading InfoScale using
Ansible
This chapter includes the following topics:
---
- hosts: cpicluster11
gather_facts: False
any_errors_fatal: true
tasks:
- name: Facters
veritas_infoscale:
module: site_facters
register: facts
- hosts: cpicluster11
gather_facts: False
any_errors_fatal: true
serial: 1
tasks:
- name: Rolling Upgrade(phase1) Infoscale to 7.4.1
veritas_infoscale:
module: ru_phase1
repository_name: RepositoryName
product_version: 7.4.1
repository_baseurl: RepositoryBaseURL
gpgcheck: 1
gpgkey: http://xx.xxx.xxx.xx/rpms/
RPM-GPG-KEY-veritas-infoscale7
product: enterprise
license: ENTERPRISE
component: sfcfsha
start_process: 'yes'
edgeserver_port: '443'
edgeserver_hostname: 'telemetry.veritas.com'
seednode: objstorer820-1-vm16
state: present
facters: "{{ groups['all'] |map('extract',
hostvars, ['facts','infoscale_facts'])| select()|list }}"
- hosts: cpicluster11
gather_facts: False
any_errors_fatal: true
tasks:
- name: Rolling Upgrade(phase2) Infoscale to 7.4.1 phase2
veritas_infoscale:
module: ru_phase2
Upgrading InfoScale using Ansible 24
List of pre-defined keywords
repository_name: RepositoryName
product_version: 7.4.1
repository_baseurl: RepositoryBaseURL
gpgcheck: 1
gpgkey: http://xx.xxx.xxx.xx/
Infoscale/7.4.1/rpms/RPM-GPG-KEY-veritas-infoscale7
product: enterprise
license: ENTERPRISE
component: sfcfsha
start_process: 'yes'
seednode: objstorer820-1-vm16
edgeserver_hostname: telemetry.veritas.com
edgeserver_port: 443
state: present
facters: "{{ groups['all'] |map('extract',
hostvars, ['facts','infoscale_facts'])| select()|list }}"
upgrade
The upgrade module is used to perform a full upgrade in infoScale. Use the following
keywords while referencing the module in your playbook.
product_version: Specifies the version of the product that you want to install or upgrade. Mandatory
Example: http://xx.xxx.xxx.xx/rpms/
gpg_check: Specify whether to check the integrity of the yum packages by using Optional
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.
Upgrading InfoScale using Ansible 25
List of pre-defined keywords
gpg_key: Specifies the location of the gpgkey (typically located in the rpms Mandatory, if
directory of the installation media). gpgcheck is 1
Example:
http://xx.xxx.xxx.xx/rpms/
RPM-GPG-KEY-veritas-infoscale7
product: Specifies the name of the product you want to install. Mandatory
state: Specifies what state the package should be after the task is completed. Optional
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.
license: Specifies the path to the slf license file to be registered on the system. Mandatory
Ensure that the license file is accessible store on the same server
where the installer is saved.
Examples:
■ /license_key/Unix/perpetual/
xxxxxxxxxxxxx.slf
■ ENTERPRISE
■ AVAILABILITY
component: Specify which components you want to configure in your product. Note Mandatory
that the product license acquired must support the required
components.
start_process: Specifies to start InfoScale processes if value is set to yes. By default Optional
this option is set to no.
Upgrading InfoScale using Ansible 26
List of pre-defined keywords
edgeserver_hostname Use this parameter to enter the server host name to which installation, Mandatory
deployment, and usage data is sent as part of the Product Improvement
Program. The Product Improvement Program allows the product
installer to collect installation, deployment, and usage data and submit
it anonymously to Veritas. The collected information helps identify how
customers deploy and use the product.
edgeserver_port Use this parameter to enter the port number of the edge server to Mandatory
which data is sent as part of the Product Improvement Program. The
Product Improvement Program allows the product installer to collect
installation, deployment, and usage data and submit it anonymously
to Veritas. The collected information helps identify how customers
deploy and use the product.
Enter 443 if you are using the Veritas Cloud Receiver as an edge
server for your environment.
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.
product_version: Specifies the version of the product that you want to install or upgrade. Mandatory
Example: http://xx.xxx.xxx.xx/rpms/
gpgcheck: Specify whether to check the integrity of the yum packages by using Optional
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.
Upgrading InfoScale using Ansible 27
List of pre-defined keywords
gpgkey: Specifies the location of the gpgkey (typically located in the rpms Mandatory. if
directory of the installation media). gpgcheck is 1
Example:
http://xx.xxx.xxx.xx/sde2/7.4.1/
dvd1-redhatlinux/rhel7_x86_64/rpms/
RPM-GPG-KEY-veritas-infoscale7
product: Specifies the name of the product you want to install. Mandatory
state: Specifies what state the package should be after the task is completed. Optional
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.
license: Specifies the path to the slf license file to be registered on the system. Mandatory
Ensure that the license file is accessible store on the same server
where the installer is saved.
Examples:
■ /license_key/Unix/perpetual/
xxxxxxxxxxxxxxxxxxx.slf
■ ENTERPRISE
■ AVAILABILITY
component: Specify which components you want to configure in your product. Note Mandatory
that the product license acquired must support the required
components.
start_process Specifies to start InfoScale processes if value is set to yes. By default Optional
this option is set to no.
seednode: Select any node from the cluster that will be used to run commands Mandatory
related to the operations of that cluster.
Ensure that you enter the host name as provided in the in the
/etc/ansible/hosts file.
Upgrading InfoScale using Ansible 28
List of pre-defined keywords
edgeserver_hostname Use this parameter to enter the server host name to which installation, Mandatory
deployment, and usage data is sent as part of the Product Improvement
Program. The Product Improvement Program allows the product
installer to collect installation, deployment, and usage data and submit
it anonymously to Veritas. The collected information helps identify how
customers deploy and use the product.
edgeserver_port Use this parameter to enter the port number of the edge server to Mandatory
which data is sent as part of the Product Improvement Program. The
Product Improvement Program allows the product installer to collect
installation, deployment, and usage data and submit it anonymously
to Veritas. The collected information helps identify how customers
deploy and use the product.
Enter 443 if you are using the Veritas Cloud Receiver as an edge
server for your environment.
Table 4-4
Name Description Mandatory/optional
product_version: Specifies the version of the product that you want to install or upgrade. Mandatory
Example: http://xx.xxx.xxx.xx/rpms/
gpgcheck: Specify whether to check the integrity of the yum packages by using Optional
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.
gpgkey: Specifies the location of the gpgkey (typically located in the rpms Mandatory if gpgcheck
directory of the installation media). is 1
Example:
http://xx.xxx.xxx.xx/rpms/
RPM-GPG-KEY-veritas-infoscale7
Upgrading InfoScale using Ansible 29
List of pre-defined keywords
product: Specifies the name of the product you want to install. Mandatory
state: Specifies what state the package should be after the task is completed. Optional
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.
license: Specifies the path to the slf license file to be registered on the system. Mandatory
Ensure that the license file is accessible store on the same server
where the installer is saved.
Examples:
■ /license_key/Unix/perpetual/
xxxxxxxxxxxxxxxxxxxxxx.slf
■ ENTERPRISE
■ AVAILABILITY
component: Specify which components you want to configure in your product. Note Mandatory
that the product license acquired must support the required
components.
Example: SF, VCS, or SFCHA
start_process Specifies to start InfoScale processes if value is set to yes. By default Optional
this option is set to no.
seednode: Select any node from the cluster that will be used to run commands Mandatory
related to the operations of that cluster.
Ensure that you enter the host name as provided in the in the
/etc/ansible/hosts file.
Upgrading InfoScale using Ansible 30
List of pre-defined keywords
edgeserver_hostname Use this parameter to enter the server host name to which installation, Mandatory
deployment, and usage data is sent as part of the Product Improvement
Program. The Product Improvement Program allows the product
installer to collect installation, deployment, and usage data and submit
it anonymously to Veritas. The collected information helps identify how
customers deploy and use the product.
edgeserver_port Use this parameter to enter the port number of the edge server to Mandatory
which data is sent as part of the Product Improvement Program. The
Product Improvement Program allows the product installer to collect
installation, deployment, and usage data and submit it anonymously
to Veritas. The collected information helps identify how customers
deploy and use the product.
Enter 443 if you are using the Veritas Cloud Receiver as an edge
server for your environment.
Chapter 5
Configuring InfoScale
features
This chapter includes the following topics:
cfsresource
The cfsresource module is used to create cluster file systems in InfoScale. Use the
following keywords while referencing the module in your playbook.
Configuring InfoScale features 35
List of pre-defined keywords
state: Specifies what state the package should be after the task is completed. Optional
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.
sgname: Name of the service group where you are creating the cluster file Mandatory
system.
dgname: Name of the service group where you are creating the cluster file Mandatory
system.
volname: Name of the volume where you are creating the cluster file system. Mandatory
mnt: Mount point of the volume where you are creating the cluster file Mandatory
system.
systems: Specify the list of host names that are part of the cluster. Mandatory
Ensure that you enter the host names as provided in the in the
/etc/ansible/hosts file.
Example:[hostname1,hostname2,hostname3]
facters: Enter the following value to collect system-related data from the cluster Mandatory
servers.
vxvm_dgvolfs
The vxvm_dgvolfs module is used to create disk group volumes and file systems
in InfoScale. Use the following keywords while referencing the module in your
playbook.
state: Specifies what state the package should be after the task is completed. Optional
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.
Configuring InfoScale features 36
List of pre-defined keywords
fss: Specifies whether the disk is part of a Flexible Storage Sharing (FSS) Optional
environment.
The value for this keyword can be either yes or no. By default, this
keyword is set to no.
dgtype: Enter shared if you want to configure a shared type of disk group or Optional
leave the keyword empty.
disks: Specifies the list of disks that you want to add in the disk group. Use Mandatory
the following format to enter the disk names:
Syntax:
[<disk_name_1>,
<disk_name_2>
,...<disk_name_n>]
Example:
[disk1,disk2,disk3]
[[<volume_name_1>,<volume_size_1>],
[<volume_name_2>,<volume_size_n>],
...[<volume_name_n>,<volume_size_n>]]
Example:
[[testvol1,200m],[testvol2,300m]]
seednode: Select any node from the cluster that will be used to run commands Mandatory
related to the operations of that cluster.
Ensure that you enter the host name as provided in the in the
/etc/ansible/hosts file.
Configuring InfoScale features 37
List of pre-defined keywords
facters: Enter the following value to collect system-related data from the cluster Mandatory
servers.
fsresource
The fsresource module is used to create file systems in InfoScale. Use the following
keywords while referencing the module in your playbook.
state: Specifies what state the package should be after the task is completed. Optional
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.
sgname: Name of the service group where you are creating the file system. Mandatory
sgtype: Specify the type of service group. This value can either be Parallel or Mandatory
Failover.
dgname: Name of the service group where you are creating the file system. Mandatory
volname: Name of the volume where you are creating the cluster file system. Mandatory
mnt: Mount point of the volume where you are creating the file system. Mandatory
systems: Specify the list of host names that are part of the cluster. Mandatory
Ensure that you enter the host names as provided in the in the
/etc/ansible/hosts file.
Example:[hostname1,hostname2,hostname3]
Configuring InfoScale features 38
List of pre-defined keywords
facters: Enter the following value to collect system-related data from the cluster Mandatory
servers.