YML configuration file for deploying NetBackup primary and media servers
The YML-based configuration file contains the NetBackup Flex Scale cluster configuration settings as name-value pairs. Use the YML configuration file to import a pre-created configuration. 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.
The configuration file contains the following sections:
cluster_setting
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 (IPv4orIPv6) 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. |
license_key | NetBackup license. You can specify only a single license key during the initial configuration. |
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:
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 60 years. |
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 112. |
Under user_management, specify the following details:
Table:
Parameter | Description |
|---|---|
storage_server | |
password | Password for the user account that can access the storage server containers. |
user_name | Name for the user account that can be used to access the storage server containers. This account has the permissions to manage all the storage on the NetBackup Flex Scale cluster nodes. |
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. |
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, layer(3+4), and default 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
Configuring a DNS server for the cluster is optional. If you set up a cluster without configuring a DNS server, you must provide both the IP addresses and FQDNs for all the cluster nodes and NetBackup services. If you configure a DNS server for the cluster, you need to specify only the IP addresses during the configuration.
You can configure a DNS server for the following networks:
Only for the management network.
Both the management and the data network.
Ensure that the same DNS server details are provided if you want to configure a DNS server for the data and management network. Configuring a separate DNS server for the management and data network is not supported.
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. |
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
Configuring a DNS server for the cluster is optional. If you set up a cluster without configuring a DNS server, you must provide both the IP addresses and FQDNs for all the cluster nodes and NetBackup services. If you configure a DNS server for the cluster, you need to specify only the IP addresses during the configuration.
You can configure a DNS server for the following networks:
Only for the management network.
Both the management and the data network.
Ensure that the same DNS server details are provided if you want to configure a DNS server for the data and management network. Configuring a separate DNS server for the management and data network is not supported.
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. |
search_domain | Search domains for resolving host names and IP addresses. |
Node name and details of media server, storage server, and management server for each node
Table:
Parameter | Description |
|---|---|
hostnames | Name of the nodes, can contain a maximum of 63 characters. |
media_server_ip | Public IP address range for the media server service on each node.
The FQDN is automatically resolved with DNS lookup. |
storage_server_ip | Public IP address range for the storage server 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. |
The following example shows a sample YML configuration file where DNS is configured for the management and data network and IP ranges are specified for the node details. The IP addresses are resolved to FQDNs during the initial configuration.
# deployment_yaml_version: V3.0
cluster_setting:
additional_fqdn_entries:
- ip_address: '10.80.40.1'
name: ["test.com"]
autosupport_setting:
call_home:
enable_call_home: false
enable_proxy_server: false
proxy:
enable_proxy_tunel: false
password: ''
port: ''
server: ''
username: ''
smtp:
account: sendersort_eagappnso41@mtv.nbuappsmtp.example.com
emailServer: nbpipeline-comn.engba.veritas.com
encryption_enabled: true
hardware: hadmin_eagappnso41@mtv.nbuappsmtp.example.com
notificationInterval: '15'
password: UEBzc3cwcmQ=
senderEmail: sendersort_eagappnso41@mtv.nbuappsmtp.example.com
serverPort: '25'
software: hadmin_eagappnso41@mtv.nbuappsmtp.example.com
snmp:
community: ''
enable_snmp: false
port: ''
server: ''
console_ip_ipv4: 10.85.44.145
console_ip_ipv6:
dr_passphrase: P@ssw0rd
license_key: KLNP-UA6L-I4VR-OSS4-C6CP-CIR4-KSOS-KY7F-FYU6-PPNC
storage_licenses: []
management_server_fqdn: eagappnso85-pub2.example.com
management_server_ip_ipv4: 10.85.44.146
management_server_ip_ipv6:
name: betatan
netbackup_master:
ipv4_address: 10.85.44.139
ipv6_address:
name: eagappnso66-vip.example.com
ntp_setting:
server: [10.0.0.12]
timezone: Pacific
private_network:
ipv4:
ip: 172.16.0.1
subnet: 255.252.0.0
ipv6:
ip: 'fd00::2'
prefix_length: '112'
user_management:
storage_server:
- password: P@ssw0rd
user_name: msdp-usr
users:
- password: We!!c0me
roles:
- appliance_admin
- backup_admin
user_name: admin_user
- password: P@ssw0rd
roles:
- appliance_admin
user_name: app_admin_user
- password: 123@Admin
roles:
- backup_admin
user_name: nbu_admin_usr
common_network_setting:
dns:
dns_domain: example.com
data:
bond:
enable: true
mode: balance-alb
option: ''
ipv4:
gateway_ip: 10.85.40.1
subnet_mask: 255.255.248.0
ipv6:
prefix_length: ''
router_ip: ''
vlan_id: ''
dns:
dns_server: 10.0.0.12
search_domain:
- example.com
ipmi:
ipv4:
gateway_ip: ''
subnet_mask: ''
ipv6:
prefix_length: ''
router_ip: ''
management:
ipv4:
gateway_ip: 10.10.10.10
subnet_mask: 255.255.248.0
ipv6:
prefix_length: ''
router_ip: ''
dns:
dns_server: 10.0.0.12
search_domain:
- example.com
vlan_id: ''
nodes_setting:
hostnames: ["node01", "node02", "node03", "node04"]
media_server_ip: [10.209.106.0/30]
storage_server_ip: [10.109.106.0/30]
management_interface_ip: [10.209.106.9,10.209.106.10,10.209.106.11,
10.209.106.12]
ipmi_interface: [10.209.106.13,10.209.106.14/31,10.209.106.16]