Veritas NetBackup™ Flex Scale Installation and Configuration Guide
- Preparing for NetBackup Flex Scale deployment
- Configuring NetBackup Flex Scale
- Upgrading NetBackup Flex Scale to 3.2
- Performing pre-upgrade tasks
- Performing post-upgrade tasks
- Upgrading NetBackup Flex Scale to 3.2.100
- Performing pre-upgrade tasks
- Performing post-upgrade tasks
- Upgrading the firmware in NetBackup Flex Scale cluster
- Managing EEBs
- Removing NetBackup Flex Scale
- Appendix A. Installing NetBackup Flex Scale 3.2 from a USB drive
- Appendix B. Installing NetBackup Flex Scale using a downloaded ISO file
- Appendix C. Upgrading a NetBackup Flex Scale node
YML configuration file
The YML-based configuration file contains the NetBackup Flex Scale cluster configuration settings as name-value pairs. When you import the configuration file, the configuration settings that you specify in the YML file are displayed in the corresponding parameters in the setup wizard.
Your Veritas Sales Engineer can generate the configuration file using the Appliance Deployment Planner (ADP) tool or you can download the default configuration template from the setup wizard and update the configuration settings as per your setup environment.
The configuration file contains the following sections:
cluster_setting
common_network_setting
nodes_setting
external_primary_server_setting (Only for media server only deployment)
The following table describes the parameters in the YML configuration file:
Settings that are common to the cluster, such as the cluster name, NetBackup primary server settings, NTP settings, user details, and AutoSupport configuration details.
Under the additional_fqdn_entries section specify the following details:
Table:
Parameter | Description |
---|---|
ip_address | IPv4 or IPv6 addresses that must be added to the |
name | Domain name |
Under the autosupport_setting section specify the following details:
Table:
Parameter | Description |
---|---|
call_home | |
enable_call_home | Specify whether you want to enable Call Home. If you enable Call Home, you can upload the appliance health information to the Veritas AutoSupport server. Set to true to enable Call Home. Set to false to disable Call home. |
enable_proxy_server | Specify if the appliance connects to the AutoSupport server through a proxy server. Set to true to enable proxy server. Set to false if a proxy server is not used. |
enable_proxy_tunel | Specify if the proxy server supports SSL tunneling. Set to true to enable secure communication. Set to false if the proxy server does not support secure communication. |
password | Password to authenticate the user name that is used to log in to the proxy server. |
port | Port number to use for communicating with the proxy server. |
server | Name of the proxy server.(Required if you enable the proxy server) . |
username | User account to use for authenticating communication requests to the proxy server. |
smtp | |
account | User name to access the SMTP account. |
emailServer | FQDN or the IP address of the SMTP server. |
encryption_enabled | Specify whether to use a secure connection and to encrypt communication with the SMTP server. |
hardware | Email address of the admin users who will be the recipients of hardware-related email alerts. |
notificationInterval | Notification interval, in minutes, for email-based alerts. Enter a value in multiples of 15 minutes. |
password | Password for the user name if authentication is required to access the SMTP account. |
senderEmail | Source email address that is used to send email alerts. |
serverPort | Port number to use for communicating with the SMTP server. The default port is 25. |
software | Email address of the admin users who will be the recipients of software-related email alerts. |
snmp | |
server | FQDN or the IP address (IPv4 or IPv6) of the SNMP server in your network Alert notifications that are generated by the appliance are sent to this server. |
port | Port number of the SNMP server. |
community | Community to which the alerts are sent. |
enable_snmp | Specify whether you want to enable the SNMP service to remotely monitor the cluster nodes using the SNMP protocol. Set to true to enable the SNMP service. Set to false if you do not want to configure the SNMP service. |
Table:
Parameter | Description |
---|---|
console_ip_ipv4 | Public IPv4 address for the NetBackup Flex Scale infrastructure management UI. The type of IP address, whether IPv4 or IPv6 depends on the IP addressing you specified for the management network's routing settings. |
console_ip_ipv6 | Public IPv6 address for the NetBackup Flex Scale infrastructure management UI. The type of IP address, whether IPv4 or IPv6 depends on the IP addressing you specified for the management network's routing settings. |
dr_passphrase | Passphrase for the disaster recovery package that is created for the NetBackup catalog backup. This passphrase is required when installing NetBackup in a disaster recovery mode. (Only for a new NetBackup domain with both primary and media server deployment) |
NBU_licenses | A (Only for a new NetBackup domain with both primary and media server deployment) |
storage_licenses | Storage license. You can specify multiple storage licenses during the initial configuration. |
management_server_fqdn | Resolvable host name or FQDN for the NetBackup Flex Scale management and API server. The FQDN can contain a maximum of 64 characters. |
management_server_ip_ipv4 | Public IP address for the NetBackup Flex Scale management server. The type of IP address, whether IPv4 or IPv6 depends on the IP addressing you specified for the management network's routing settings. |
name | Cluster name.
|
Under the netbackup_master section, specify the following details:
(Only for a new NetBackup domain with both primary and media server deployment)
Table:
Parameter | Description |
---|---|
ipv4_address | Public IPv4 address for the NetBackup primary server service. Note: You can specify either an IPv4 or an IPv6 address based on the data network settings. |
ipv6_address | Public IPv6 address for the NetBackup primary server service. Note: You can specify either an IPv4 or an IPv6 address based on the data network settings. |
name | Resolvable host name or FQDN for the NetBackup primary server service. |
Under the ntp_setting section, specify the following details:
Table:
Parameter | Description |
---|---|
server | NTP server that you want to use to set and synchronize the system clocks on the cluster nodes. You can specify an IP address or an FQDN. The type of IP address depends on the data network routing settings that you specified earlier. If the data network is configured to use IPv4 addresses, the NTP server IP address must be an IPv4 address. Conversely, if the data network uses IPv6 addresses, the NTP server IP must be an IPv6 address. |
timezone | Time zone of the nodes. |
Under the lockdown_mode section, specify the following details:
Table:
Parameter | Description |
---|---|
mode | Lockdown mode that provides different levels of security and data retention capabilities to protect data. You can use lockdown mode to create WORM storage that prevents your data from being encrypted, modified, or deleted. Each mode provides different levels of protection and data retention capabilities. NetBackup Flex Scale supports the following lockdown modes:
|
retention | |
min | Minimum duration for which data cannot be modified or deleted when the cluster is in enterprise or compliance mode. |
max | Maximum duration for which data cannot be modified or deleted when the cluster is in enterprise or compliance mode. |
unit | Retention period in terms of hours, days, months, or years. Minimum data retention time is one hour and maximum retention time is 30 years. |
ipmiRestricted | Restrict remote management access to the node when the lockdown mode is set to enterprise or compliance. Specify yes to restrict remote access and no to disable the restriction. This option is not available for normal lockdown mode. Restricting remote access to nodes provides an additional level of data security and limits the privileges and operations that you can perform. You can view and perform limited operations in the IPMI web GUI but cannot open the remote console. Physical access to the system is required to log on to the console. After you enable this restriction, a sysadmin user with IPMI role on an HPE platform has only Login and Virtual Power and Reset privileges. With these privileges, the user can only view settings in iLO and perform power-related operations. Ensure that the sysadmin user account with default password P@ssw0rd is present on all the nodes and that the sysadmin user account has full administrative privileges before you enable this restriction. Note: After you enable restricted remote access, you can disable this option if the appliance is in enterprise lockdown mode. If the lockdown mode is set to compliance, you cannot disable the remote access restriction. You can also choose to enable or disable remote access after the initial configuration is complete. |
Under the private_network section, specify the following details. Specify both the IPv4 and IPv6 addresses irrespective of the data network settings.
Table:
Parameter | Description |
---|---|
ipv4 | |
ip | Specify a private subnet IP to be used for internal communication between the cluster nodes. |
subnet | Subnet mask for the specified IP address. |
ipv6 | |
ip | Specify a private subnet IP to be used for internal communication between the cluster nodes. |
prefix_length | If using IPv6 addresses, specify the IPv6 prefix length. The prefix length must be greater than or equal to 115. |
Under user_management, specify the following details:
Table:
Parameter | Description |
---|---|
msdp_engine | |
password | Password for the user account that can access the MSDP engine containers. |
user_name | Name for the user account that can be used to access the MSDP engine containers. This account has the permissions to manage all the storage on the NetBackup Flex Scale cluster nodes. |
The following are the rules for the credentials:
| |
users | |
password | Password for the administrator account. |
roles | Role to assign to the administrator account. The Appliance administrator role has permissions to manage all the infrastructure components in the cluster such as the cluster nodes, cluster settings, and the cluster operations. The NetBackup administrator role has the permissions to manage the NetBackup services and operations in the cluster. You can assign both the roles to a single administrator account. |
user_name | Name for the administrator account. |
additional_users | |
user_name | Maintenance or sysadmin user account for which you want to change the known default password. Specify maintenance or sysadmin. Ensure that the sysadmin user is configured on all or none of the nodes that you want to include in the cluster. If the sysadmin user account does not exist on the nodes, do not specify this user. |
password | The new password that you want to set for the maintenance or the sysadmin user account. The known default password of the user account, which is specified in the user_name parameter is set to this new password. The password for the maintenance user must be at least eight characters in length and must include at least one uppercase, lowercase, numeric, and special character. The permitted special characters are !@#$%^&~ Dictionary words are not allowed. The password for the sysadmin user can be a maximum of 16 characters and cannot include white spaces and \! special characters. |
Network settings for the cluster, such as network boding, DNS, and gateway details.
dns
Table:
Parameter | Description |
---|---|
dns_domain | Domain that the nodes will be a part of. The name must be a fully qualified name. |
data
Table:
Parameter | Description |
---|---|
bond | |
enable | Specify if you want to use NIC bonding for eth5 and eth7 for high availability of the network interfaces. |
mode | Specify the bonding mode:
|
option | Sub-type layer2, layer2+3 , and layer3+4 for bonding mode 802.3ad and balance-xorbond types. |
ipv4 | |
gateway_ip | If using IPv4 public addresses, specify the IP address of the gateway server in your network. |
subnet_mask | If using IPv4 public addresses, specify the subnet mask of the data network. |
ipv6 | |
prefix_length | If using IPv6 public addresses, specify the IPv6 prefix length. |
router_ip | If using IPv6 public addresses, specify the router address. |
Table:
Parameter | Description |
---|---|
vlan_id | VLAN ID of a pre-configured virtual LAN. The ID can be any value between 1 and 4095. |
dns
Table:
Parameter | Description |
---|---|
dns_server | IP address of the DNS server in your network. Specify an IPv4 or an IPv6 address based on the data network settings. For details about the supported options for DNS configuration, see the Veritas NetBackup™ Flex Scale Best Practices and Troubleshooting Guide. |
search_domain | Search domains for resolving host names and IP addresses. |
ipmi
Table:
Parameter | Description |
---|---|
ipv4 | |
gateway_ip | If using IPv4 public addresses, specify the IP address of the gateway server in your network. |
subnet_mask | If using IPv4 public addresses, specify the subnet mask of the IPMI network. |
ipv6 | |
prefix_length | If using IPv6 public addresses, specify the IPv6 prefix length. |
router_ip | If using IPv6 public addresses, specify the router address. |
management
Table:
Parameter | Description |
---|---|
ipv4 | |
gateway_ip | If using IPv4 public addresses, specify the IP address of the gateway server in your network. |
subnet_mask | If using IPv4 public addresses, specify the subnet mask of the management network. |
ipv6 | |
prefix_length | If using IPv6 public addresses, specify the IPv6 prefix length. |
router_ip | If using IPv6 public addresses, specify the router address. |
dns
Table:
Parameter | Description |
---|---|
dns_server | IP address of the DNS server in your network. Specify an IPv4 or an IPv6 address based on the management network settings. For details about the supported options for DNS configuration, see the Veritas NetBackup™ Flex Scale Best Practices and Troubleshooting Guide. |
search_domain | Search domains for resolving host names and IP addresses. |
Table:
Parameter | Description |
---|---|
bond | |
enable | Specify true if you want to use NIC bonding for eth1 and eth2 for high availability of management network interfaces. By default, the value is set to false. |
mode | Specify the bonding mode:
|
option | Sub-type layer2, layer2+3 , and layer3+4 for bonding mode 802.3ad and balance-xorbond types. |
Node name and details of media server, MSDP engine, and management server for each node:
Table:
Parameter | Description |
---|---|
hostnames | Name of the nodes, can contain a maximum of 63 characters. |
serial_number | Serial number of the node. You can specify the serial number to assign the media, storage, and management interface IP to the specific node for which the serial number is specified. If you do not specify the serial number, these are assigned randomly. Specifying a serial number is optional. If you specify the serial number, ensure that you specify it for all the nodes. You can find the serial number on the pull tab present on the server. The pull tab is double-sided, one side shows the server serial number and the other side shows the default iLO account information. |
media_server_ip | Public IP address range for the media server service on each node.
The FQDN is automatically resolved with DNS lookup. |
msdp_engine_ip | Public IP address range for the MSDP engine service on each node
The FQDN is automatically resolved with DNS lookup. |
management_interface_ip | Public IP address to be assigned to the designated management network interface (eth1) on each node. You can specify:
|
ipmi_interface | Public IP address to be assigned to the designated IPMI interface on each node.
The FQDN is automatically resolved with DNS lookup. |
Details of the external NetBackup primary server that the cluster connects to.
(Only for media server only deployment)
Table:
Parameter | Description |
---|---|
name | Resolvable host name or FQDN of the NetBackup primary server that is external to the cluster. The primary server must be already configured in an existing NetBackup domain. The media servers configured in the cluster communicate with this external primary server for NetBackup primary server services. The FQDN can contain a maximum of 253 characters. |
ipv4_address | IPv4 address of the external primary server. The type of IP address, whether IPv4 or IPv6 depends on your network settings. |
ipv6_address | IPv6 address of the external primary server. The type of IP address, whether IPv4 or IPv6 depends on your network settings. |
api_key | NetBackup API key, which is a pre-authenticated token that identifies a NetBackup user to NetBackup RESTful APIs. The user can use the API key in an API request header when a NetBackup API requires authentication. API keys can be created for authenticated NetBackup users. A specific API key is only created one time and cannot be recreated. Each API key has a unique key value and API key tag. Ensure that the provided API key corresponds to a NetBackup user who has the administrator role. |
media_server_gateway | Name that the primary server can use to identify all the media servers in the cluster. The primary server uses this name as an alias to map and access all the media servers in the cluster. This alias is not automatically updated in the bp.conf file. For backups jobs to be successful, on the NetBackup client, edit the For example, for the following settings: external_primary_server_setting: name: "sclhypscontainer3vm06p3.xxx.yyy. com" ipv4_address: '192.168.2.241' ipv6_address: '' api_key: "A0sBjVxO5S8hwfa5cp_ QvSqs0AmYlFsy6qzGLK8z2S5ayBfPnOKV6jXOI-cLtXrd" media_server_gateway: "nbfsclus001" Add the SERVER entry as follows in the SERVER=nbfsclus001 |
The following example shows a sample YML configuration file where a separate DNS is configured for the management and the data network and bonding is configured for the eth1 and eth2 management interfaces:
# deployment_yaml_version: V3.2 cluster_setting: name: nbu-hc autosupport_setting: smtp: notificationInterval: '' emailServer: '' serverPort: '' account: '' password: '' encryption_enabled: false hardware: '' software: '' senderEmail: '' snmp: enable_snmp: false server: '' port: 0 community: '' call_home: enable_call_home: false enable_proxy_server: false proxy: enable_proxy_tunel: false server: '' port: '' username: '' password: '' console_ip_ipv6: '' console_ip_ipv4: xx.xx.xx.xx management_server_ip_ipv4: xx.xx.xx.xx management_server_ip_ipv6: '' ntp_setting: timezone: Pacific server: - xx.xx.xx.xx dr_passphrase: xxxxxxxxxxxxx NBU_licenses: '' storage_licenses: [] netbackup_master: name: netbackup-master.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: '' user_management: users: - user_name: admin_user password: xxxxxxxxxxxxx roles: - appliance_admin - backup_admin - user_name: app_admin_user password: xxxxxxxxxxxxx roles: - appliance_admin - user_name: nbu_admin_usr password: xxxxxxxxxxxxx roles: - backup_admin additional_users: - user_name: maintenance password: xxxxxxxxxxxxx - user_name: sysadmin password: xxxxxxxxxxxxx msdp_engine: - password: xxxxxxxxxxxxx user_name: root private_network: ipv4: ip: xx.xx.xx.xx subnet: yy.yy.yy.yy ipv6: ip: 'fd00::2' prefix_length: '115' additional_fqdn_entries: [] lockdown_mode: mode: Enterprise retention: min: 10 max: 20 unit: days ipmiRestricted: 'yes' management_server_fqdn: management-server.xxx.yyy.com common_network_setting: dns: dns_domain: xxx.yyy.com data: dns: dns_server: xx.xx.xx.xx search_domain: - xxx.yyy.com enable: true bond: enable: false mode: '' option: '' vlan_id: '' ipv4: gateway_ip: xx.xx.xx.xx subnet_mask: yy.yy.yy.yy ipv6: prefix_length: '' router_ip: '' management: dns: dns_server: xx.xx.xx.xx search_domain: - xxx.yyy.com bond: enable: true mode: 'balance-alb' option: '' vlan_id: '' ipv4: gateway_ip: xx.xx.xx.xx subnet_mask: yy.yy.yy.yy ipv6: prefix_length: '' router_ip: '' ipmi: ipv4: gateway_ip: '' subnet_mask: '' ipv6: prefix_length: '' router_ip: '' nodes_setting: - host_name: host01 ipmi_interface: ipv4_address: '' ipv6_address: '' management_interface: name: management01.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: '' media_server: name: media01.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: null msdp_engine: name: engine01.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: '' serial_number: SGH030VQMV - host_name: host02 ipmi_interface: ipv4_address: '' ipv6_address: '' management_interface: name: management02.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: '' media_server: name: media02.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: null msdp_engine: name: engine02.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: '' serial_number: SGH030VQPW - host_name: host03 ipmi_interface: ipv4_address: '' ipv6_address: '' management_interface: name: management03.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: '' media_server: name: media03.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: null msdp_engine: name: engine03.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: '' serial_number: SGH030VQLP - host_name: host04 ipmi_interface: ipv4_address: '' ipv6_address: '' management_interface: name: management04.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: '' media_server: name: media04.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: null msdp_engine: name: engine04.xxx.yyy.com ipv4_address: xx.xx.xx.xx ipv6_address: '' serial_number: SGH030VQMS
The following example shows a sample YML configuration file with different DNS servers for the data and the management network, management bonding configured for eth1 and eth2 interfaces, and lockdown mode set to enterprise with restricted remote management access:
# # # deployment_yaml_version: V3.2 # common_network_setting: dns: dns_domain: 'xxx.yyy.com' data: bond: enable: false mode: '' option: '' vlan_id: '' ipv4: gateway_ip: 'xx.xx.xx.xx' subnet_mask: 'yy.yy.yy.yy' ipv6: prefix_length: '' router_ip: '' dns: dns_server: 'xx.xx.xx.xx' search_domain: ['xxx.yyy.com'] management: bond: enable: true mode: 'balance-alb' option: '' vlan_id: '' ipv4: gateway_ip: 'xx.xx.xx.xx' subnet_mask: 'yy.yy.yy.yy' ipv6: prefix_length: '' router_ip: '' dns: dns_server: 'xx.xx.xx.xx' search_domain: ['xxx.yyy.com'] ipmi: ipv4: gateway_ip: '' subnet_mask: '' ipv6: prefix_length: '' router_ip: '' cluster_setting: name: pbclust console_ip_ipv4: 'xx.xx.xx.xx' console_ip_ipv6: '' lockdown_mode: mode : 'Enterprise' ipmiRestricted: 'yes' retention: min: 10 max: 25 unit : days private_network: ipv4: ip: xx.xx.xx.xx subnet: yy.yy.yy.yy ipv6: ip: 'fd00::2' prefix_length: '115' ntp_setting: timezone: 'Pacific' server: ['xx.xx.xx.xx'] autosupport_setting: smtp: notificationInterval: '' hardware: '' software: '' senderEmail: '' emailServer: '' account: '' password: '' serverPort: '' encryption_enabled: false snmp: enable_snmp: false server: '' port: '' community: '' call_home: enable_call_home: false enable_proxy_server: false proxy: enable_proxy_tunel: false server: '' port: '' username: '' password: '' user_management: users: - user_name: 'admin_user' password: 'xxxxxxxxxx' roles: ['appliance_admin'] - user_name: app_admin_user password: xxxxxxxxxxxxx roles: - appliance_admin additional_users: - user_name: maintenance password: xxxxxxxxxxxxx - user_name: sysadmin password: xxxxxxxxxxxxx msdp_engine: - user_name: 'root' password: 'xxxxxxx' storage_licenses: [] additional_fqdn_entries: - ip_address: '' name: [] nodes_setting: - host_name: pbnso01.xxx.yyy.com serial_number: FSVSMH3 media_server: name: 'media01.xxx.yyy.com' ipv4_address: 'xx.xx.xx.xx' ipv6_address: '' management_interface: name: 'management01.xxx.yyy.com' ipv4_address: xx.xx.xx.xx ipv6_address: '' ipmi_interface: ipv4_address: '' ipv6_address: '' msdp_engine: name: 'engine01.xxx.yyy.com' ipv4_address: 'xx.xx.xx.xx' ipv6_address: '' - host_name: pbnso02.xxx.yyy.com serial_number: FSVQMH3 media_server: name: 'media02.xxx.yyy.com' ipv4_address: 'xx.xx.xx.xx' ipv6_address: '' management_interface: name: 'management02.xxx.yyy.com' ipv4_address: xx.xx.xx.xx ipv6_address: '' ipmi_interface: ipv4_address: '' ipv6_address: '' msdp_engine: name: 'engine02.xxx.yyy.com' ipv4_address: 'xx.xx.xx.xx' ipv6_address: '' - host_name: pbnso03.xxx.yyy.com serial_number: FSVVMH3 media_server: name: 'media03.xxx.yyy.com' ipv4_address: 'xx.xx.xx.xx' ipv6_address: '' management_interface: name: 'management03.xxx.yyy.com' ipv4_address: xx.xx.xx.xx ipv6_address: '' ipmi_interface: ipv4_address: '' ipv6_address: '' msdp_engine: name: 'engine03.xxx.yyy.com' ipv4_address: 'xx.xx.xx.xx' ipv6_address: '' - host_name: pbnso04.xxx.yyy.com serial_number: FSVTMH3 media_server: name: 'media04.xxx.yyy.com' ipv4_address: 'xx.xx.xx.xx' ipv6_address: '' management_interface: name: 'management04.xxx.yyy.com' ipv4_address: xx.xx.xx.xx ipv6_address: '' ipmi_interface: ipv4_address: '' ipv6_address: '' msdp_engine: name: 'engine04.xxx.yyy.com' ipv4_address: 'xx.xx.xx.xx' ipv6_address: '' external_primary_server_setting: name: "sclhypscontainer3vm06p3.xxx.yyy.com" ipv4_address: 'xx.xx.xx.xx' ipv6_address: '' api_key: "abcdefgh" media_server_gateway: "nbfsclus001"