NetBackup™ Installation Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.4)
  1. Preparing for installation
    1. General installation information
      1.  
        Available NetBackup installation methods
      2.  
        About compatibility between NetBackup versions
      3.  
        About NetBackup software availability
      4.  
        Required libraries missing from some Linux distributions
      5. How to install NetBackup
        1.  
          About the NetBackup preinstall checker
        2.  
          About the NetBackup Product Improvement Program
      6.  
        Creating the user account to support the NetBackup web server
      7. About storage device configuration
        1.  
          Locating supported robot types
      8.  
        About security certificates for NetBackup hosts
      9.  
        Environment variable for certificate key size
      10.  
        Restrictions on the NetBackup installation directory
      11.  
        NetBackup database is not supported on the btrfs file system
    2. Installation operational notes and limitations
      1.  
        Windows compiler and security requirements for NetBackup 10.4 and later installation
      2.  
        Java GUI and JRE installation optional for some computers
      3.  
        Enable 8dot3 name file setting for the NetBackup primary servers
      4.  
        NetBackup servers must use a host name that is compliant with RFC 1123 and RFC 952
      5.  
        Host ID-based certificate is not deployed during installation on 8.1 media server or client host with dual stack configuration
      6.  
        External certificate authority certificates supported in NetBackup 8.2 and later
      7.  
        SCCM and Chef deployment tools and documentation now available
      8.  
        Known SUSE Linux primary server install issue
    3.  
      Performance and tuning considerations
    4. SORT information
      1.  
        About Veritas Services and Operations Readiness Tools
      2.  
        Recommended SORT procedures for new installations
    5. Veritas NetInsights Console information
      1.  
        About Veritas Usage Insights
      2.  
        Best practices for Veritas Usage Insights
  2. NetBackup licenses
    1.  
      About NetBackup license requirements
    2.  
      About license entry
    3.  
      Frequently asked questions about licenses
  3. Installing server software on UNIX systems
    1. Installation requirements for UNIX and Linux
      1.  
        Do not mix non-English versions of Windows and UNIX platforms unless primary and media servers are NetBackup appliances
      2.  
        NetBackup installations on environments that run different versions of UNIX-based operating systems
      3.  
        Special installation guidelines for Solaris systems
      4.  
        Special installation guidelines for Linux clustered environments
    2.  
      How the installation script works
    3. Installing NetBackup primary server software on Linux
      1.  
        Silently installing NetBackup primary server software on Linux
      2.  
        Continuing with NetBackup software installation
    4. Installing NetBackup media server software on Linux
      1.  
        Silently installing NetBackup media server software on Linux
    5. About pushing client software from a primary server to clients
      1.  
        Installing client type software on a primary server
  4. Installing server software on Windows systems
    1.  
      Installation requirements for Windows and Windows clusters
    2.  
      Requirements for Windows cluster installations
    3.  
      Performing local, remote, or clustered server installation on Windows systems
    4.  
      Post-installation tasks for NetBackup cluster environments
    5.  
      Verifying Windows cluster installations or upgrades
    6.  
      Installing NetBackup servers silently on Windows systems
  5. About the administrative interfaces
    1.  
      About the NetBackup web user interface
    2.  
      About the NetBackup Administration Console
    3.  
      Installing the NetBackup Administration Console
    4.  
      Installing multiple versions of the NetBackup Administration Console on Windows
    5.  
      Removing earlier versions of the NetBackup Administration Console on Windows
    6.  
      About the NetBackup Remote Administration Console
    7.  
      Installing the NetBackup Remote Administration Console
  6. Installing NetBackup client software
    1.  
      About NetBackup client installation
    2. About NetBackup client installation on Windows
      1.  
        About Windows client installation methods and requirements
      2.  
        Installing NetBackup Windows clients locally or remotely
      3.  
        Installing NetBackup Windows clients silently
      4.  
        How to configure NetBackup clients
    3. About NetBackup client installation on UNIX and Linux
      1.  
        About UNIX and Linux client installation methods
      2.  
        Installing UNIX clients locally
      3.  
        Install of the UNIX and Linux client binaries with native installers
      4. About remote installation methods for UNIX and Linux clients
        1.  
          Installing client software with the ssh method
        2.  
          Installing client software with the sftp method
      5.  
        Adding a UNIX/Linux client after initial server installation
  7. Configuring NetBackup
    1.  
      About NetBackup startup and shutdown scripts
    2. About NetBackup server configuration
      1.  
        Starting the NetBackup Administration Console
      2.  
        About the Device Configuration Wizard
      3.  
        About the Volume Configuration Wizard
      4.  
        About the Catalog Backup Wizard
      5.  
        About the Backup Policy Configuration Wizard
  8. Removing NetBackup server and client software
    1.  
      About NetBackup server software removal on Linux systems
    2.  
      About NetBackup client software removal on UNIX and Linux systems
    3.  
      Removing NetBackup from UNIX and Linux servers and clients
    4.  
      About NetBackup server software removal on Windows systems
    5.  
      Removing NetBackup server and client software from Windows servers, clusters, and clients
    6.  
      About removal of the Java Console state data from Windows servers and Windows clients
    7.  
      Removing a clustered media server by migrating all data to a new media server
  9. Reference
    1.  
      Generate a certificate on the inactive nodes of a clustered primary server
    2.  
      NetBackup database user
    3.  
      About the NetBackup answer file
    4.  
      About the NetBackup IT Analytics Data Collector
    5.  
      Manually install or uninstall NetBackup IT Analytics Data Collector binaries
    6.  
      Manually configure the NetBackup IT Analytics Data Collector
    7.  
      Persistent Java Virtual Machine options
    8.  
      About RBAC bootstrapping
    9.  
      NetBackup primary server web server user and group creation
    10.  
      About the NetBackup Java Runtime Environment
    11.  
      Add or Remove Java GUI and JRE after install
    12.  
      Using NetApp disk arrays with Replication Director
    13.  
      Security updates to the NetBackup database
    14.  
      Size guidance for the NetBackup primary server and domain

About the NetBackup answer file

NetBackup provides a way to perform unattended, silent installation, and upgrades with a predefined set of configuration options. These options allow the user to:

  • Override some default values.

  • Avoid answering some questions during interactive installation.

On UNIX and Linux, templates for primary, media, and clients are available at the top level of the NetBackup installation image that is downloaded from Veritas. These templates should be modified as needed and placed in /tmp/NBInstallAnswer.conf for use during installs and upgrades.

On Windows, templates for primary, media, and client are in the windows_x64 directory at the top level of the NetBackup installation image that is downloaded from Veritas. These templates are called silentprimary.cmd, silentmedia.cmd, and silentclient.cmd.

Templates for media and clients are available at the top level of the NetBackup installation image downloaded from Veritas.

Populate the NetBackup answer file on the target host before you run the installation script. Create the file if it does not exist. The supported entries are shown along with any relevant information.

Table: All template options and required computers

Option

NetBackup role

Platform

Required for install?

ABORT_REBOOT_INSTALL

Primary, media, and client

Windows

No

ACCEPT_EULA

Primary, media, and client

UNIX and Linux

No

ACCEPT_REVERSE_CONNECTION

Client

All

No

ADDITIONALSERVERS

Primary, media, and client

Windows

No

ALLOW_PRE_90_UPGRADE

Primary

All

No

AUTHORIZATION_TOKEN

Media and client

All

Review About security configuration considerations for details.

CA_CERTIFICATE_FINGERPRINT

Media and client

All

Review About security configuration considerations for details.

CLIENT

Client

Windows

Yes

CLIENT_NAME

Media and client

UNIX and Linux

Yes

DATABASE_USER

Primary

Linux

Review DATABASE_USER for details.

DISASTER_RECOVERY_INSTALL

Primary

Linux

No

ECA_CERT_PATH

Media and client

All

Review About security configuration considerations for details.

ECA_CERT_STORE

Media and client

Windows

Review About security configuration considerations for details.

ECA_CRL_CHECK_LEVEL

Media and client

All

Review About security configuration considerations for details.

ECA_CRL_PATH

Media and client

All

Only when ECA_CRL_CHECK_LEVEL=USE_PATH is specified.

ECA_KEY_PASSPHRASEFILE

Media and client

All

No

ECA_PRIVATE_KEY_PATH

Media and client

All

Review About security configuration considerations for details.

ECA_TRUST_STORE_PATH

Media and client

All

Review About security configuration considerations for details.

INCLUDE_JAVA_GUI_AND_JRE

Media and clients

All

UNIX and Linux media servers and clients: No

Windows media servers: Yes

INCLUDE_VRTSPDDEU_CLIENT

Client

Linux

No

See the option details for more information related to role and platform.

INSTALL_ITA_DATA_COLLECTOR

Primary

All

No

INSTALL_PATH

Media and client

All

No

INSTALLDIR

Primary, media, and client

Windows

Yes

LICENSE

Primary

All

Yes

MACHINE_ROLE

Media and client

UNIX and Linux

Yes

MEDIA_SERVER

Primary, media, and client

UNIX and Linux

No

MEDIASERVER

Media

Windows

No

MERGE_SERVERS_LIST

Client

UNIX and Linux

No

NB_FIPS_MODE

Primary, media, and client

All

No

PRIMARYSERVER

Primary, media, and client

Windows

Yes

PROCEED_WITH_INSTALL

Primary, media, and client

UNIX and Linux

No

RBAC_DOMAIN_NAME

Primary

Linux

No

RBAC_DOMAIN_TYPE

Primary

Linux

No

RBAC_PRINCIPAL_NAME

Primary

Linux

No

RBAC_PRINCIPAL_TYPE

Primary

Linux

No

SECURITY_CONFIGURATION

Media and client

All

No

SERVER

Media and client

UNIX and Linux

Yes

SERVICES

Client

UNIX and Linux

No

SERVICESTARTTYPE

Primary, media, and client

Windows

No

SERVICE_USER

Primary

Linux

Yes

START_JOB_DAEMONS

Primary

Linux

No

STOP_NB_BEFORE_VCREDIST

Primary, media, and client

Windows

No

STOP_NBU_PROCESSES

Primary, media, and client

Windows

No

USE_URANDOM

Primary, media, and client

UNIX and Linux

No

VCREDIST_ATTEMPT_PREFERENCE

Primary, media, and client

Windows

No

VCREDIST_RESTART_PREFERENCE

Primary, media, and client

Windows

No

VNETD_PORT

Primary, media, and client

Windows

No

VXDBMS_POSTGRESQL_POOLER_ODBC_PORT

Primary

All

No

WEBSVC_DOMAIN

Primary

Windows

Yes

WEBSVC_GROUP

Primary

All

UNIX and Linux: No

Windows: Yes

WEBSVC_PASSWORD_PLAIN

Primary

Windows

Yes

WEBSVC_USER

Primary

All

UNIX and Linux: No

Windows: Yes

Answer file options by platform and role

These tables show the possible answer file options based on platform and role. Not all listed options are required. Refer to Table: All template options and required computers or the option details for further information.

Table: Platform and role

Role

Windows computers

UNIX and Linux computers

Primary

ABORT_REBOOT_INSTALL
ADDITIONALSERVERS 
ALLOW_PRE_90_UPGRADE 
INSTALL_ITA_DATA_COLLECTOR
INSTALLDIR
LICENSE
NB_FIPS_MODE
PRIMARYSERVER
SERVICESTARTTYPE
STOP_NB_BEFORE_VCREDIST
STOP_NBU_PROCESSES 
VCREDIST_ATTEMPT_PREFERENCE
VCREDIST_RESTART_PREFERENCE
VNETD_PORT
VXDBMS_POSTGRESQL_POOLER_ODBC_PORT
WEBSVC_DOMAIN 
WEBSVC_GROUP 
WEBSVC_PASSWORD_PLAIN 
WEBSVC_USER
ACCEPT_EULA
ALLOW_PRE_90_UPGRADE 
CLIENT_NAME
DATABASE_USER
DISASTER_RECOVERY_INSTALL
INSTALL_ITA_DATA_COLLECTOR
INSTALL_PATH
LICENSE
MACHINE_ROLE
MEDIA_SERVER
NB_FIPS_MODE
PROCEED_WITH_INSTALL
RBAC_DOMAIN_NAME 
RBAC_DOMAIN_TYPE 
RBAC_PRINCIPAL_NAME 
RBAC_PRINCIPAL_TYPE 
SERVER
SERVICE_USER 
START_JOB_DAEMONS
USE_URANDOM
VXDBMS_POSTGRESQL_POOLER_ODBC_PORT
WEBSVC_GROUP 
WEBSVC_USER

Media

ABORT_REBOOT_INSTALL
ADDITIONALSERVERS
AUTHORIZATION_TOKEN 
CA_CERTIFICATE_FINGERPRINT 
ECA_CERT_PATH 
ECA_CERT_STORE 
ECA_CRL_CHECK_LEVEL 
ECA_CRL_PATH 
ECA_KEY_PASSPHRASEFILE 
ECA_PRIVATE_KEY_PATH 
ECA_TRUST_STORE_PATH 
INCLUDE_JAVA_GUI_AND_JRE 
INSTALL_PATH 
INSTALLDIR 
MEDIASERVER
NB_FIPS_MODE
PRIMARYSERVER
SERVICESTARTTYPE 
STOP_NB_BEFORE_VCREDIST
STOP_NBU_PROCESSES 
VCREDIST_ATTEMPT_PREFERENCE
VCREDIST_RESTART_PREFERENCE
VNETD_PORT
ACCEPT_EULA
AUTHORIZATION_TOKEN 
CA_CERTIFICATE_FINGERPRINT 
CLIENT_NAME 
ECA_CERT_PATH 
ECA_CRL_CHECK_LEVEL 
ECA_CRL_PATH 
ECA_KEY_PASSPHRASEFILE 
ECA_PRIVATE_KEY_PATH 
ECA_TRUST_STORE_PATH 
INCLUDE_JAVA_GUI_AND_JRE 
INSTALL_PATH  
MACHINE_ROLE
NB_FIPS_MODE
PROCEED_WITH_INSTALL
SERVER
USE_URANDOM

Client

ABORT_REBOOT_INSTALL 
ACCEPT_REVERSE_CONNECTION 
ADDITIONALSERVERS 
AUTHORIZATION_TOKEN 
CA_CERTIFICATE_FINGERPRINT 
CLIENT 
ECA_CERT_PATH 
ECA_CERT_STORE 
ECA_CRL_CHECK_LEVEL 
ECA_CRL_PATH 
ECA_KEY_PASSPHRASEFILE 
ECA_PRIVATE_KEY_PATH 
ECA_TRUST_STORE_PATH 
INCLUDE_JAVA_GUI_AND_JRE 
INSTALL_PATH 
INSTALLDIR 
NB_FIPS_MODE
PRIMARYSERVER
SERVICESTARTTYPE 
STOP_NB_BEFORE_VCREDIST
STOP_NBU_PROCESSES 
VCREDIST_ATTEMPT_PREFERENCE
VCREDIST_RESTART_PREFERENCE
VNETD_PORT
ACCEPT_EULA
ACCEPT_REVERSE_CONNECTION 
AUTHORIZATION_TOKEN 
CA_CERTIFICATE_FINGERPRINT 
CLIENT_NAME 
ECA_CERT_PATH 
ECA_CRL_CHECK_LEVEL 
ECA_CRL_PATH 
ECA_KEY_PASSPHRASEFILE 
ECA_PRIVATE_KEY_PATH 
ECA_TRUST_STORE_PATH 
INCLUDE_JAVA_GUI_AND_JRE
INCLUDE_VRTSPDDEU_CLIENT 
INSTALL_PATH 
MACHINE_ROLE 
MEDIA_SERVER 
MERGE_SERVERS_LIST
NB_FIPS_MODE
PROCEED_WITH_INSTALL
SERVER 
SERVICES
USE_URANDOM
About security configuration considerations

The version of NetBackup and the operation that is performed determines what security parameters are required in the template file.

Security configuration considerations for initial installation or pre-8.1 upgrade

If this operation is an initial installation or an upgrade from pre-8.1, at least one set of security configuration parameters must be provided. You can skip the security configuration but that requires manual steps on each target host after installation or upgrade.

To use the NetBackup primary server as your Certificate Authority, the CA_CERTIFICATE_FINGERPRINT of the primary server must be provided. The AUTHORIZATION_TOKEN option may be required depending on either the security level of the primary server or if this computer is already configured on the primary server. More information is available: https://www.veritas.com/support/en_US/article.000127129.

To use an external certificate authority on UNIX and Linux, the ECA_CERT_PATH, ECA_CRL_CHECK_LEVEL, ECA_PRIVATE_KEY_PATH, and ECA_TRUST_STORE_PATH values are required. More information is available: https://www.veritas.com/support/en_US/article.100044300

For more information, see the NetBackup Security and Encryption Guide and refer to the chapter on external CA and external certificates.

To use an external certificate authority on Windows: either provide the ECA_CERT_STORE and ECA_CRL_CHECK_LEVEL values or all values previously specified for UNIX and Linux.

The ECA_CRL_PATH and ECA_KEY_PASSPHRASEFILE values are optional. More information is available: https://www.veritas.com/support/en_US/article.100044300.

For more information, see the NetBackup Security and Encryption Guide and refer to the chapter on external CA and external certificates.

Security configuration considerations for upgrades of NetBackup 8.1 or newer

When you upgrade NetBackup from a version that already has secure communications configured (NetBackup 8.1 or newer), the CA_CERTIFICATE_FINGERPRINT and AUTHORIZATION_TOKEN values are ignored.

Security configuration considerations for upgrades of NetBackup 8.2 or newer

When you upgrade NetBackup from a version that already has ECA configured (NetBackup 8.2 or newer), all the ECA* parameters are ignored.

About skipping the external certificate authority configuration

To continue the installation or upgrade without configuring the certificate authority, include the SECURITY_CONFIGURATION key and set it to SKIP. Remove the CA_CERTIFICATE_FINGERPRINT, AUTHORIZATION_TOKEN, and all ECA_ values from the answer file. If you continue the installation or the upgrade without the required certificate authority components, backups and restores fail.

ABORT_REBOOT_INSTALL

  • Description: This option specifies whether to proceed with remaining steps if one or more files being held in use have been overwritten such that a restart is required. If set to 1, the installation halts, the system is restored to its original state, and the restart is not required.

  • Applicable platforms: Windows only.

  • Default value: 0

  • Required: No.

  • ABORT_REBOOT_INSTALL 0 | 1

  • Return to Table: All template options and required computers.

ACCEPT_EULA

  • Description: This option specifies if you accept the terms of the EULA and want to proceed with the installation or the upgrade.

  • Applicable platforms: UNIX and Linux

  • Default value: None

  • Required: No

  • ACCEPT_EULA = yes | no

  • Return to Table: All template options and required computers.

ACCEPT_REVERSE_CONNECTION

  • Description: Use this option to identify how a NAT client connects with a NetBackup host. Accepted values are TRUE and FALSE. Set this option to TRUE if NetBackup needs to support NAT, otherwise set it to FALSE. Set ACCEPT_REVERSE_CONNECTION=FALSE if:

    • You do not want NetBackup to support NAT clients.

    • The NetBackup clients are not behind the firewall.

  • Applicable platforms: Both UNIX and Windows.

  • Default value: FALSE

  • ACCEPT_REVERSE_CONNECTION=TRUE | FALSE

  • Return to Table: All template options and required computers.

ADDITIONALSERVERS

  • Description: Use this option to Include NetBackup media servers that are used to proxy security requests to the primary server. List only the servers that were added since the last installation of this host. The install process combines the existing set of servers with the new ones. The use of IP addresses is not supported. Valid input values are a comma-separated list of fully qualified computer names.

  • Applicable platforms: Windows only.

  • Default value: None.

  • Required: No.

  • ADDITIONALSERVERS server1,server2,servern

  • Return to Table: All template options and required computers.

ALLOW_PRE_90_UPGRADE

  • Description: This field is for primary servers only. This value determines if the upgrade from pre-NetBackup 9.0 releases to NetBackup 9.0 and later can proceed. The upgrade includes the infinite expiration conversion process. This conversion only takes place when you upgrade from pre-NetBackup 9.0 to NetBackup 9.0 or later. The upgrade behavior and need for this option depend on your primary server platform.

    • Windows

      This value is required for silent upgrades of Windows primary servers. Specify 1 to allow the upgrade to continue, specify 0 to prevent the upgrade. This value is ignored during an interactive Windows primary server upgrade. Depending on the size of the NetBackup catalog and the required conversion time, you may be asked if you want to continue the upgrade.

    • Linux

      For Linux primary servers, specify yes or no to eliminate user prompts. If the infinite expiration conversion is expected to add length to the upgrade process, a value of yes means the upgrade proceeds. A value of no means the upgrade stops. If this value is not specified, NetBackup prompts you if you want to continue with the upgrade.

    NetBackup 9.0 and later versions support the expiration dates that extend beyond the year 2038. To ensure compatibility with previous NetBackup versions, all items with an infinite expiration date are updated to reflect the new infinite expiration date value. This conversion may extend the time that is required to complete the upgrade. Review the article that is shown for more information:

    https://www.veritas.com/support/en_US/article.100048600

  • Applicable platforms: Both UNIX and Windows.

  • Default value: None

  • Required: Platform and upgrade method dependent.

  • ALLOW_PRE_90_UPGRADE=yes|no (UNIX)

    ALLOW_PRE_90_UPGRADE=1|0 (Windows)

  • Return to Table: All template options and required computers.

AUTHORIZATION_TOKEN

  • Description: This option specifies that NetBackup should automatically use an authorization or a reissue token when it retrieves the host certificate. The AUTHORIZATION_TOKEN is 16 upper case letters. Some environments require an authorization token for backups and restores to work correctly. If this information is required and is not provided in the answer file, the installation fails. If SKIP is specified, the installer attempts to retrieve a host certificate without including a token. In some environments this choice may result in additional manual steps following the installation.

    Be aware that AUTHORIZATION_TOKEN is ignored under either of these conditions:

    • ECA is in use on the primary server.

    • The primary server's security level is set lower than High.

  • Applicable platforms: Both UNIX and Windows.

  • Default value: None.

  • Required: Review About security configuration considerations for details.

  • AUTHORIZATION_TOKEN=ABCDEFGHIJKLMNOP | SKIP

  • Return to Table: All template options and required computers.

CA_CERTIFICATE_FINGERPRINT

  • Description: This option specifies the Certificate Authority (CA) Certificate Fingerprint. Both SHA-1 and SHA-256 fingerprints are supported. The Certificate Fingerprint is retrieved from the CA during installation or upgrade. The fingerprint format is 59 or 95 characters and is a combination of the digits 0-9, the letters A-F, and colons. For example, 01:23:45:67:89:AB:CD:EF:01:23:45:67:89:AB:CD:EF:01:23:45:67. The fingerprint value must match the fingerprint for the server value that is specified in the first SERVER=server_name option.

    Be aware that CA_CERTIFICATE_FINGERPRINT is ignored under either of these conditions:

    • ECA is in use on the primary server.

    • The primary server's security level is set lower than High.

  • Applicable platforms: Both UNIX and Windows.

  • Default value: None.

  • Required: Review About security configuration considerations for details.

  • CA_CERTIFICATE_FINGERPRINT=fingerprint

  • Return to Table: All template options and required computers.

CLIENT

  • Description: This option specifies the name that NetBackup uses to identify this client host. The %COMPUTERNAME% value lets the local host provide the computer name. If this value is used, it may be possible to use the same answer file on all computers within a single primary server domain. The use of IP addresses is not supported.

  • Applicable platforms: Windows only.

  • Default value: None.

  • Required: Yes.

  • CLIENT=client_name | %COMPUTERNAME%

  • Return to Table: All template options and required computers.

CLIENT_NAME

  • Description: This option specifies the name that NetBackup uses to identify this computer. The XLOCALHOSTX value lets the local host provide the computer name. If this value is used, it may be possible to use the same answer file on all computers within a single primary server domain. This value is added to the bp.conf file.

    If CLIENT_NAME is specified on upgrade, a check is made to validate that the name that is provided in the answer file matches the value that is configured in the bp.conf file.

  • Applicable platforms: UNIX and Linux only.

  • Default value: None.

  • Required: Yes

  • CLIENT_NAME=name | XLOCALHOSTX

  • Return to Table: All template options and required computers.

DATABASE_USER

  • Description: This option specifies the user name of the account that owns the NetBackup scale-out database instance.

    This user must already exist on the system. The DATABASE_USER cannot be root. The DATABASE_USER cannot be an account with access to the sudo utility. If the specification resolves to root, the installation fails. If the SERVICE_USER defined previously is not root, you can specify SAME_AS_SERVICE_USER. Otherwise, specify a non-root user account name.

  • Applicable platforms: Linux

  • Default value: SAME_AS_SERVICE_USER

  • Required: Conditional.

    This value is required if the service user is root. Additionally, this value is required if DATABASE_USER does not exist in the bp.conf file and the configured SERVICE_USER entry is root. If the value is provided and the DATABASE_USER exists in bp.conf, this value must match the configured database user on the machine.

  • DATABASE_USER = username | SAME_AS_SERVICE_USER

  • Return to Table: All template options and required computers.

DISASTER_RECOVERY_INSTALL

  • Description: This option specifies if the installation is a disaster recovery installation. This operation applies only to installations that use the disaster recovery file through an interactive installation.

  • Applicable platforms: Linux only

  • Default value: None

  • Required: No

  • DISASTER_RECOVERY_INSTALL = no

  • Return to Table: All template options and required computers.

ECA_CERT_PATH
ECA_CERT_STORE
ECA_CRL_CHECK_LEVEL

  • Description: This option specifies the CRL mode. Supported values are:

    • USE_CDP: Use the CRL defined in the certificate.

    • USE_PATH: Use the CRL at the path that is specified in ECA_CRL_PATH.

    • DISABLED: Do not use a CRL.

    • The ECA_CERT_PATH option is ignored on upgrade if ECA is already configured on the host or if NBCA only is in use on the primary server.

  • Applicable platforms: All.

  • Default value: None.

  • Required: Review About security configuration considerations for details.

  • ECA_CRL_CHECK_LEVEL=value

  • Return to Table: All template options and required computers.

ECA_CRL_PATH

  • Description: This option specifies the path and the file name of the CRL associated with the external CA certificate.

    The ECA_CERT_PATH option is ignored on upgrade if ECA is already configured on the host or if NBCA only is in use on the primary server.

  • Applicable platforms: All.

  • Default value: None.

  • Required: Only when ECA_CRL_CHECK_LEVEL=USE_PATH is specified.

  • ECA_CRL_PATH=path

  • Return to Table: All template options and required computers.

ECA_KEY_PASSPHRASEFILE

  • Description: This option specifies the path and the file name of the file that contains the passphrase to access the keystore.

    The ECA_CERT_PATH option is ignored on upgrade if ECA is already configured on the host or if NBCA only is in use on the primary server.

  • Applicable platforms: All.

  • Default value: None.

  • Required: No

  • ECA_KEY_PASSPHRASEFILE=path/filename

  • Return to Table: All template options and required computers.

ECA_PRIVATE_KEY_PATH
ECA_TRUST_STORE_PATH
INCLUDE_JAVA_GUI_AND_JRE

  • Description: Used to determine how to handle the optional Java and JRE components during install or upgrade. Supported values are:

    • INCLUDE: Include the Java GUI and JRE as part of the installation or upgrade.

    • EXCLUDE: Exclude the Java GUI and JRE.

    • MATCH: Match the existing configuration on the host. If you specify this option on an initial installation, the components are not installed.

  • Applicable platforms: All.

  • Default value: None

  • Required: UNIX and Linux, no. Windows media servers, yes.

  • INCLUDE_JAVA_GUI_AND_JRE = INCLUDE | EXCLUDE

  • Return to Table: All template options and required computers.

INCLUDE_VRTSPDDEU_CLIENT

  • Description: This option specifies whether the VRTSpddeu package is installed in the client. This option only affects the Red Hat client installations that are neither pSeries nor zSeries. Installation of VRTSpddeu package is optional. The supported values for the option are:

    • MATCH: Match the current configuration on the client. If you specify this value for an initial install, the VRTSpddeu package is not installed.

    • INCLUDE: Include the VRTSpddeu package for the installation or upgrade of a client.

    • EXCLUDE: Exclude the VRTSpddeu package for the installation or upgrade of a client.

  • Applicable platforms: Linux. Specifically, Red Hat Linux clients that are neither pSeries nor zSeries.

  • Default value: MATCH

  • Required: No

  • INCLUDE_VRTSPDDEU_CLIENT = INCLUDE | EXCLUDE | MATCH

  • Return to Table: All template options and required computers.

INSTALL_ITA_DATA_COLLECTOR

  • Description: This option determines if the NetBackup IT Analytics Data Collector option is installed. Acceptable values are 1, install, or 0, do not install.

  • Applicable platforms: All

  • Default value: Windows: 1, UNIX and Linux: Yes

  • Required: Yes

  • INSTALL_ITA_DATA_COLLECTOR=1|0

  • Return to Table: All template options and required computers.

INSTALL_PATH

  • Description: This option specifies the location to install the NetBackup binaries. Only the absolute path to a base directory is required for this option. The installer automatically appends /openv. This option cannot be used to change the location of NetBackup during an upgrade.

    Be aware that the INSTALL_PATH option is ignored on upgrade.

  • Applicable platforms: UNIX and Linux only.

  • Default value: /usr

  • Required: No

  • INSTALL_PATH = path

  • Return to Table: All template options and required computers.

INSTALLDIR

  • Description: This option specifies the location to install NetBackup. The fully qualified path to the base directory is required.

  • Applicable platforms: Windows only.

  • Default value: None.

  • Required: Yes

  • INSTALLDIR=C:\Program Files\Veritas

  • Return to Table: All template options and required computers.

LICENSE

  • Description: This option specifies the path of the license file to apply to the primary server. For Linux, additional LICENSE lines may be added if more licenses are to be applied. For Windows, use a single LICENSE line with multiple license file paths separated with semicolons. This option only adds additional keys. Any conflicting licenses are removed.

    Veritas recommends the use of your production license that is downloaded from VEMS, for all upgrades. If you do not have access to your production license, you can use one of the built-in non-downloaded licenses. Which license you use depends on your version of NetBackup.

    The evaluation license (EVALUATION) is only used during upgrades if the upgrade is from NetBackup versions earlier than NetBackup 8.1.2. The evaluation license is valid for 60 days. Alerts appear in the web UI immediately after upgrade, indicating the number of days remaining in the evaluation.

    The temporary license (TEMP_PRODUCTION) is used in upgrades of NetBackup 8.1.2 or later to NetBackup 10.3 or later. The temporary license is valid for 60 days. Alerts appear in the web UI immediately after upgrade, indicating the number of days remaining before the temporary license expires.

    Note:

    After an upgrade to NetBackup 10.3 or later, existing NetBackup licenses become obsolete. They remain in the license.txt file. This file is located in either /usr/openv/var/ on Linux or install_path\NetBackup\var\ on Windows.

  • Applicable platforms: All

  • Default value: None.

  • Required: Yes, for primary servers. Not required for media servers and clients.

  • LICENSE = EVALUATION | slf_filepath

    You can only use TEMP_PRODUCTION for an upgrade.

    More information is available: https://www.veritas.com/support/en_US/article.100058779

  • Return to Table: All template options and required computers.

MACHINE_ROLE

  • Description: This option specifies the NetBackup role to install and configure on this computer. For upgrades, this value must match the configured role on the computer.

  • Default value: None. Supported values are PRIMARY, MEDIA, and CLIENT.

  • Applicable platforms: UNIX and Linux only.

  • Required: Yes.

  • MACHINE_ROLE = PRIMARY | MEDIA | CLIENT

  • Return to Table: All template options and required computers.

MEDIA_SERVER

  • Description: For clients, this option specifies that NetBackup may use the named host to tunnel secure web requests for this client. A tunnel is required when communication between the client and the NetBackup Web Service on the primary server is blocked. This communication is required to obtain a host certificate during the NetBackup installation or upgrade.

    For primary servers and media servers, the MEDIA_SERVER entry effects what the specified host can do on the primary server. Hosts that are listed in a MEDIA_SERVER entry have limited privileges on the primary server. For example, hosts that are listed in a MEDIA_SERVER entry do not have access to add new devices on the primary server. For primary and media servers, all MEDIA_SERVER lines in the answer file are added to the bp.conf file as part of the install or upgrade.

    Regardless of role, you can have multiple MEDIA_SERVER entries in the answer file.

  • Applicable platforms: UNIX and Linux only.

  • Default value: None.

  • Required: No.

  • MEDIA_SERVER=media_server_name

  • Return to Table: All template options and required computers.

MEDIASERVER

  • Description: This option specifies the name of the host this computer recognizes as its media server. The use of IP addresses is not supported.

  • Applicable platforms: Windows only.

  • Default value: None.

  • Required: No.

  • MEDIASERVER=media_server_name

  • Return to Table: All template options and required computers.

MERGE_SERVERS_LIST

  • Description: Merge the servers present in bp.conf on the primary with the server list contained in this client's bp.conf.

  • Applicable platforms: UNIX and Linux only.

  • Default value: NO

  • Required: No.

  • MERGE_SERVERS_LIST = yes | no

  • Return to Table: All template options and required computers.

NB_FIPS_MODE

  • Description: This option specifies whether to install NetBackup in FIPS mode.

    NetBackup does not support modifying FIPS mode during upgrades. If the existing NetBackup version supports FIPS, change the FIPS mode before the upgrade. Otherwise, change it after the upgrade finishes. Refer to the NetBackup Security and Encryption Guide for details on FIPS configuration in NetBackup.

  • Applicable platforms: All.

  • Default value: Disable

  • Required: No.

  • NB_FIPS_MODE = Enable | Disable

  • Return to Table: All template options and required computers.

PRIMARYSERVER

  • Description: This option specifies the server name this computer recognizes as the current NetBackup primary server. If this host is the primary server, %COMPUTERNAME% can be used for the value. The use of IP addresses is not supported. Additional primary servers can be specified with the ADDITIONALSERVERS option.

  • Applicable platforms: Windows only.

  • Default value: None.

  • Required: Yes.

  • PRIMARYSERVER=primary_server_name

  • Return to Table: All template options and required computers.

PROCEED_WITH_INSTALL

  • Description: This option specifies the answer to two possible prompts during the install or the upgrade of NetBackup. The first prompt determines if the install or the upgrade proceeds after NetBackup passes critical preinstallation checks. The user may receive a second prompt if there are potential disk space concerns. In both cases, if YES, the install or upgrade proceeds to install the NetBackup and media manager files on the file system. If NO, the install or the upgrade halts and allows the user to make changes.

  • Applicable platforms: UNIX and Linux

  • Default value: None

  • Required: No

  • PROCEED_WITH_INSTALL = yes | no

  • Return to Table: All template options and required computers.

RBAC_DOMAIN_NAME

  • Description: This option specifies the domain name of the principal that is configured to have the role-based access control (RBAC) permissions for the Administrator role.

  • Default value: None.

  • Applicable platforms: UNIX and Linux only.

  • Required: No

  • RBAC_DOMAIN_NAME = domain_name

  • Return to Table: All template options and required computers.

RBAC_DOMAIN_TYPE

  • Description: This option specifies the domain type of the principal that is configured to have the role-based access control (RBAC) permissions for the Administrator role.

  • Applicable platforms: UNIX and Linux only.

  • Default value: None.

  • Required: No

  • RBAC_DOMAIN_TYPE = domain_type

  • Return to Table: All template options and required computers.

RBAC_PRINCIPAL_NAME

  • Description: This option specifies the name of the principal that is configured to have the role-based access control (RBAC) permissions for the Administrator role. This user or the user group must already exist on the system.

  • Applicable platforms: UNIX and Linux only.

  • Default value: None.

  • Required: No

  • RBAC_PRINCIPAL_NAME = principal_name

  • Return to Table: All template options and required computers.

RBAC_PRINCIPAL_TYPE

  • Description: This option specifies the type of the principal that is configured to have the role-based access control (RBAC) permissions for the Administrator role.

  • Applicable platforms: UNIX and Linux only.

  • Default value: None.

  • Required: No

  • RBAC_PRINCIPAL_TYPE = USER | USERGROUP

  • Return to Table: All template options and required computers.

SECURITY_CONFIGURATION

  • Description: Applicable only if neither NetBackup certificate authority nor external certificate authority are configured on the host. Set this option to SKIP to continue the installation or upgrade without configuring the host to use NBCA or ECA. If you skip security, you must take additional manual steps on all target hosts when the installation or the upgrade finishes. When this option is set to SKIP, values cannot be specified for CA_CERTIFICATE_FINGERPRINT, AUTHORIZATION_TOKEN, and the ECA_ options.

  • Applicable platforms: All.

  • Default value: None.

  • Required: No.

  • SECURITY_CONFIGURATION = SKIP

  • Return to Table: All template options and required computers

SERVER

  • Description: This option specifies the server name this computer recognizes as the current NetBackup primary server. Additional SERVER= lines may be added if there are other servers that should be recognized. In the case where multiple SERVER= lines are present, the first occurrence is the primary server. These entries are added to the bp.conf file.

  • Applicable platforms: UNIX and Linux only.

  • Default value: None.

  • Required: Yes.

  • SERVER=primary_server_name

  • Return to Table: All template options and required computers.

SERVICES

  • Description: This option specifies whether NetBackup services should be started upon completion of the client installation or upgrade. If no is specified, the NetBackup services are not started. Additional manual configuration steps may be performed after the install or upgrade but before the NetBackup services are started.

  • Applicable platforms: UNIX and Linux only.

  • Default value: YES

  • Required: No.

  • SERVICES=no

  • Return to Table: All template options and required computers.

SERVICESTARTTYPE

  • Description: This option specifies if the NetBackup services are restarted after the host server reboots.

  • Applicable platforms: Windows only.

  • Default value: Automatic

  • Required: No.

  • SERVICESTARTTYPE=Automatic | Manual

  • Return to Table: All template options and required computers.

SERVICE_USER

  • Description: This option specifies the service user account is used to start most of the NetBackup services or daemons on the primary server. Be aware of the items shown:

    • Veritas recommends you do not use the root user as the service user.

    • Veritas recommends you do not use the nbwebsvc user as the service user.

    • The nbwebgrp group must be a secondary group of the service user.

    • Ownership of the /usr/openv directory changes to the new service user account that you specify with this option.

    • Use the nbserviceusercmd --changeUser command to change this user after installation.

    • For cluster servers, the service user and the service user ID must be same on all cluster nodes.

    • More information about the service user account is available: https://www.veritas.com/docs/100048220

  • Applicable platforms: Linux only.

  • Default value: None.

  • Required: Yes.

  • SERVICE_USER=name

  • Return to Table: All template options and required computers.

START_JOB_DAEMONS

  • Description: This option specifies whether the NetBackup daemons that control the execution of jobs should be started.

  • Applicable platforms: Linux only.

  • Default value: yes

  • Required: No.

  • START_JOB_DAEMONS=yes|no

  • Return to Table: All template options and required computers.

STOP_NB_BEFORE_VCREDIST

  • Description: This option specifies if NetBackup processes should be stopped automatically before NetBackup attempts to update Visual C++ run-time libraries using Microsoft's redistributable installers. In some cases, stopping NetBackup processes reduces the chances of a restart being required.

  • Applicable platforms: Windows only.

  • Default value: YES

  • Required: No

  • STOP_NB_BEFORE_VCREDIST=YES|NO

  • Return to Table: All template options and required computers

STOP_NBU_PROCESSES

  • Description: This option specifies if the install process should stop any active NetBackup processes automatically if detected. Be sure to confirm there are no active NetBackup jobs and that all NetBackup databases are shut down before installation or upgrade. Valid input values are 0 for don't stop, and 1 for stop.

  • Applicable platforms: Windows only.

  • Default value: 0

  • Required: No.

  • STOP_NBU_PROCESSES = 0 | 1

  • Return to Table: All template options and required computers.

VCREDIST_ATTEMPT_PREFERENCE

  • Description: This option specifies the NetBackup behavior on Windows computers where the compatible Visual C++ run-time libraries are not already present. If set to YES, the setup attempts to update Visual C++ run-time libraries using Microsoft's redistributable installers. The setup halts with an error if a computer does not have the required run-time libraries and this option is set to NO.

  • Applicable platforms: Windows only.

  • Default value: YES

  • Required: No

  • VCREDIST_ATTEMPT_PREFERENCE=YES|NO

  • Return to Table: All template options and required computers

VCREDIST_RESTART_PREFERENCE

  • Description: This option determines how the NetBackup setup proceeds if the Visual C++ run-time libraries were updated and a restart is required to complete the operation. If the option is set to STOP, the setup halts. If the option is set to PROCEED, NetBackup continues the setup but does not restart the computer. Veritas recommends performing a required restart as soon as possible.

  • Applicable platforms: Windows only.

  • Default value: STOP

  • Required: No

  • VCREDIST_RESTART_PREFERENCE=PROCEED|STOP

  • Return to Table: All template options and required computers

USE_URANDOM

  • Description: This option lets you to specify /dev/urandom as the entropy source for random number generation.

  • Applicable platforms: All.

    Applicable platforms: UNIX and Linux

  • Default value: DISABLE

  • Required: No.

  • USE_URANDOM = ENABLE | DISABLE

  • Return to Table: All template options and required computers.

VNETD_PORT
VXDBMS_POSTGRESQL_POOLER_ODBC_PORT

  • Description: This option specifies the port that the NetBackup scale-out database connection pool service uses.

  • Applicable platforms: All.

  • Default value: 13787

  • Required: No.

    If the value is provided for upgrade, it must match the current value that is stored in the VXDBMS_POSTGRESQL_POOLER_ODBC_PORT field in vxdbms.conf.

  • VXDBMS_POSTGRESQL_POOLER_ODBC_PORT = port_number

  • Return to Table: All template options and required computers

WEBSVC_DOMAIN

  • Description: Use this option to associate the web server with Domain (Active Directory) accounts. Provide the domain name in this field. If you plan to associate the web server with local accounts, leave this field blank.

  • Applicable platforms: Windows only.

  • Default value: None.

  • Required: No.

  • WEBSVC_DOMAIN=domain_name

  • Return to Table: All template options and required computers.

WEBSVC_GROUP

  • Description: This option specifies the group name of the account that the NetBackup web server uses. This group must already exist on the system.

  • Applicable platforms: All.

  • Default value: nbwebgrp

  • Required: Linux primary servers, no. Windows primary servers, yes.

  • WEBSVC_GROUP=custom_group_account_name

  • Return to Table: All template options and required computers.

WEBSVC_PASSWORD_PLAIN

  • Description: This option specifies the password for the Windows WEBSVC_USER account. If your websvc password contains any special characters (% ^ & < > | ' ` , ; = ( ) ! " \ [ ] . * ?), add the appropriate escape characters to the password. For example if the websvc password is abc% you must enter abc%%.

    Caution:

    This option places the password for this account in clear text and can potentially be a security concern.

  • Applicable platforms: Windows only.

  • Default value: None.

  • WEBSVC_PASSWORD_PLAIN=password

  • Return to Table: All template options and required computers.

WEBSVC_USER

  • Description: This option specifies the user name of the account that the NetBackup web server uses. This user must already exist on the system.

  • Applicable platforms: All.

  • Default value: nbwebsvc

  • Required: Linux primary servers, no. Windows primary servers, yes.

  • WEBSVC_USER=custom_user_account_name

  • Return to Table: All template options and required computers.