YML configuration file for deploying 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
common_network_setting
nodes_setting
external_primary_server_setting

The following table describes the parameters in the YML configuration file:

cluster_setting

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 `/etc/hosts` file so that the IP addresses are resolved.
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 U. The type of IP address, whether IPv4 or IPv6 depends on the IP addressing you specified for the management network's routing settings.
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.
name	Cluster name. The cluster name can contain a-z, 0-9, - characters. The cluster name must start with a lowercase letter. The cluster name must not contain uppercase letters. The cluster name must include a minimum of 3 characters and can contain a maximum of 63 characters.

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.

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: Normal: Default mode that does not support WORM storage and data retention. Enterprise: In this mode, you can create WORM storage and specify the expiration time for data. In this mode, a user with an Appliance administrator role can remove the retention lock and delete data before the specified expiration duration. A user with NetBackup Administrator role can increase the retention period. Compliance: In this mode you can create WORM storage and specify the expiration time for data. However, you cannot remove the retention lock and delete the data before the specified expiration duration. A user with NetBackup administrator role can increase the retention period.
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.
user_name	Name for the administrator account.

common_network_settings

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: `balance-rr` `active-backup` `balance-xor` `broadcast` `802.3ad` `balance-tlb` `balance-alb`
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

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.

nodes_setting

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. You can specify the IP address range separated by a dash. For example,10.xx.xxx.192-10.xx.xxx.208 You can specify the IP address range in the CIDR format. For example,10.xx.xxx.192/30 The FQDN is automatically resolved with DNS lookup.
storage_server_ip	Public IP address range for the storage server service on each node. You can specify the IP address range separated by a dash. For example,10.xx.xxx.192-10.xx.xxx.208 You can specify the IP address range in the CIDR format. For example,10.xx.xxx.192/30 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: A single IP range Multiple IP ranges separated by a comma Comma-separated individual IP addresses A combination of individual IP addresses and IP ranges separated by a comma IP addresses in CIDR format
ipmi_interface	Public IP address to be assigned to the designated IPMI interface on each node. You can specify the IP address range separated by a dash. For example,10.xx.xxx.192-10.xx.xxx.208 You can specify the IP address range in the CIDR format. For example,10.xx.xxx.192/30 The FQDN is automatically resolved with DNS lookup.

external_primary_server_setting

Details of the external NetBackup primary server that the cluster connects to.

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. To create an API key: Log in to the NetBackup Web UI using the administrator credentials. In the left pane, click Security, and then click API keys. In the upper-right corner, click Add. Enter a username for which you want to create the API key. Indicate how long you want the API key to be valid, from today's date. NetBackup calculates the expiration date and displays it. Click Add. The key is displayed in a popup window. To copy the API key, click Copy and close. Store this key in a safe place. After you click Copy and close, the key cannot be retrieved again.
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 `/usr/openv/netbackup/bp.conf` file and add a SERVER entry that corresponds to the name specified by the media_server_gateway parameter. 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 `bp.conf` file: SERVER=nbfsclus001

The following example shows a sample YML configuration file where IP ranges are specified for the node details. The IP addresses are resolved to FQDNs during the initial configuration.

#                    
#
# deployment_yaml_version: V3.0
#
  
common_network_setting:
  dns:
    dns_domain: 'example.com'
    
  data:
    bond:
      enable: false
      mode: ''
      option: ''
    vlan_id: ''
    ipv4:
      gateway_ip: '192.168.1.1'
      subnet_mask: '255.255.248.0'
    ipv6:
      prefix_length: ''
      router_ip: ''
    dns:
      dns_server: '10.0.0.12'
      search_domain: ['example.com']
  management:
    vlan_id: ''
    ipv4:
      gateway_ip: '192.168.1.1'
      subnet_mask: '255.255.248.0'
    ipv6:
      prefix_length: ''
      router_ip: ''
    dns:
      dns_server: '10.0.0.12'
      search_domain: ['example.com']
  ipmi:
    ipv4:
      gateway_ip: ''
      subnet_mask: ''
    ipv6:
      prefix_length: ''
      router_ip: ''
cluster_setting:
  name: pbclust
  console_ip_ipv4: '192.168.2.205'
  console_ip_ipv6: ''
  lockdown_mode:
    mode : 'Normal'
    retention:
      min: null
      max: null    
      unit : null  
  private_network:
    ipv4:
      ip: 172.16.0.1
      subnet: 255.252.0.0
    ipv6:
      ip: 'fd00::2'
      prefix_length: '112'
  ntp_setting:
    timezone: 'Pacific'
    server: ['10.0.0.34']
  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: 'We!!c0me'
        roles: ['appliance_admin']
    storage_server:
      - user_name: 'root'
        password: 'We!!c0me'
  license_key: ''
  storage_licenses: []
  additional_fqdn_entries:
    - ip_address: ''
      name: []
  
nodes_setting:
  - host_name: host1.example.com
    media_server:
      name: 'sclacslnxd17pbvm27.example.com'
      ipv4_address: '192.168.2.197'
      ipv6_address: ''
    management_interface:
      name: 'sclacslnxd17pbvm23.example.com'
      ipv4_address: 192.168.2.193
      ipv6_address: ''
    ipmi_interface:
      ipv4_address: ''
      ipv6_address: ''
    storage_server:
      name: 'sclacslnxd17pbvm28.example.com'
      ipv4_address: '192.168.2.198'
      ipv6_address: ''
  - host_name: host2.example.com
    media_server:
      name: 'sclacslnxd17pbvm19.example.com'
      ipv4_address: '192.168.2.189'
      ipv6_address: ''
    management_interface:
      name: 'sclacslnxd17pbvm24.example.com'
      ipv4_address: 192.168.2.194
      ipv6_address: ''
    ipmi_interface:
      ipv4_address: ''
      ipv6_address: ''
    storage_server:
      name: 'sclacslnxd17pbvm29.example.com'
      ipv4_address: '192.168.2.199'
      ipv6_address: ''
  - host_name: host3.example.com
    media_server:
      name: 'sclacslnxd17pbvm18.example.com'
      ipv4_address: '192.168.2.188'
      ipv6_address: ''
    management_interface:
      name: 'sclacslnxd17pbvm25.example.com'
      ipv4_address: 192.168.2.195
      ipv6_address: ''
    ipmi_interface:
      ipv4_address: ''
      ipv6_address: ''
    storage_server:
      name: 'sclacslnxd17pbvm30.example.com'
      ipv4_address: '192.168.2.200'
      ipv6_address: ''
  - host_name: host4.example.com
    media_server:
      name: 'sclacslnxd17pbvm31.example.com'
      ipv4_address: '192.168.2.201'
      ipv6_address: ''
    management_interface:
      name: 'sclacslnxd17pbvm26.example.com'
      ipv4_address: 192.168.2.196
      ipv6_address: ''
    ipmi_interface:
      ipv4_address: ''
      ipv6_address: ''
    storage_server:
      name: 'sclacslnxd17pbvm32.example.com'
      ipv4_address: '192.168.2.202'
      ipv6_address: ''
external_primary_server_setting:
  name: "sclhypscontainer3vm06p3.example.com"
  ipv4_address: '192.168.2.241'
  ipv6_address: ''
  api_key: "A0sBjVxO5S8hwfa5cp_QvSqs0AmYlFsy6qzGLK8z2S5ayBfPnOKV6jXOI-cLtXrd"
  media_server_gateway: "nbfsclus001"

YML configuration file for deploying media servers

Feedback

Feedback