Veritas NetBackup™ Virtual Appliance Documentation
- Getting to know the NetBackup Virtual Appliance
- NetBackup Virtual Appliance product description
- NetBackup Virtual Appliance supported features
- About the NetBackup Virtual Appliance documentation
- NetBackup Virtual Appliance 5.1.1 new features, enhancements, and changes
- Known limitations of the NetBackup Virtual Appliance 5.1.1 release
- Operational Notes for the NetBackup Virtual Appliance 5.1.1 release
- Preparing to deploy the appliance
- Deploying and configuring the appliance
- Post initial configuration procedures
- Appliance common tasks
- Storage management
- About NetBackup Virtual Appliance storage configuration
- About viewing storage space information using the Show command
- Resizing a partition
- Troubleshooting resize-related issues
- Moving a partition
- Monitoring the progress of storage manipulation tasks
- Scanning storage devices using the NetBackup Virtual Appliance Shell Menu
- Adding storage space for the NetBackup Virtual Appliance
- Removing an existing storage disk
- About OpenStorage plugin installation
- About NetBackup Virtual Appliance storage configuration
- Deduplication pool catalog backup and recovery
- About the NetBackup Virtual Appliance deduplication pool catalog backup policy
- Automatic configuration of the NetBackup Virtual Appliance deduplication pool catalog backup policy
- Manually configuring the NetBackup Virtual Appliance deduplication pool catalog backup policy
- Manually updating the NetBackup Virtual Appliance deduplication pool catalog backup policy
- Recovering the NetBackup Virtual Appliance deduplication pool catalog
- Network connection management
- About IPv4-IPv6-based network support
- Network settings for the NetBackup Virtual Appliance
- Configuring DNS and host name mapping for the NetBackup Virtual Appliance
- Setting the date and time on a NetBackup Virtual Appliance
- Configuring static routes on the NetBackup Virtual Appliance
- Expanding the bandwidth on the NetBackup Virtual Appliance
- Managing users
- About managing NetBackup Virtual Appliance users
- About NetBackup Virtual Appliance account types
- Adding NetBackup Virtual Appliance users
- Deleting NetBackup Virtual Appliance users
- Adding NetBackup Virtual Appliance user groups
- Deleting NetBackup Virtual Appliance user groups
- Granting roles to NetBackup Virtual Appliance users and user groups
- Revoking roles from NetBackup Virtual Appliance users and user groups
- About user name and password specifications
- Changing NetBackup Virtual Appliance user passwords
- About password management and recovery
- About authenticating LDAP users
- Adding or modifying an LDAP server configuration on the NetBackup Virtual Appliance
- Importing an LDAP server configuration for the NetBackup Virtual Appliance
- Setting the SSL certification for LDAP on the NetBackup Virtual Appliance
- Exporting an LDAP server configuration from the NetBackup Virtual Appliance
- Unconfiguring LDAP user authentication on the NetBackup Virtual Appliance
- Disabling LDAP user authentication on the NetBackup Virtual Appliance
- Enabling LDAP user authentication on the NetBackup Virtual Appliance
- Adding an LDAP attribute mapping on the NetBackup Virtual Appliance
- Deleting an LDAP attribute mapping on the NetBackup Virtual Appliance
- About authenticating Active Directory users
- About authentication using smart cards and digital certificates
- Generic user authentication guidelines
- About user authorization on the NetBackup Virtual Appliance
- Creating NetBackup administrator user accounts
- Deleting NetBackup administrator user accounts
- Using the appliance
- About configuring Host parameters for your appliance on the NetBackup Virtual Appliance
- About Copilot functionality and Share management
- About NetBackup Virtual Appliance as a VMware backup host
- About running NetBackup commands from the appliance
- Running NetBackup commands from the NetBackup Virtual Appliance
- Creating a NetBackup touch file from the NetBackup Virtual Appliance
- Best practices for running NetBackup commands from the NetBackup Virtual Appliance
- About NetBackup operating system commands
- Known limitations of running NetBackup commands from the NetBackup Virtual Appliance
- About mounting a remote NFS
- About Auto Image Replication from a NetBackup Virtual Appliance
- Generating certificates
- Monitoring the appliance
- About NetBackup Virtual Appliance alerts
- Setting up email notifications for a NetBackup Virtual Appliance
- Setting up SNMP notifications for a NetBackup Virtual Appliance
- Enabling and disabling Call Home from the appliance shell menu
- Configuring a Call Home proxy server from the NetBackup Virtual Appliance Shell Menu
- About SNMP
- About Call Home
- About AutoSupport
- About storage email alerts
- Appliance security
- About Symantec Data Center Security on the NetBackup Virtual Appliance
- About data security
- About data integrity
- About data classification
- About data encryption
- About SSL usage
- About implementing external certificates
- About the NetBackup Virtual Appliance intrusion detection system
- About the NetBackup Virtual Appliance intrusion prevention system
- Major components of the NetBackup Virtual Appliance OS
- OS STIG hardening for NetBackup Virtual Appliance
- FIPS 140-2 conformance for NetBackup Virtual Appliance
- Disable user access to the NetBackup appliance operating system
- Manage support access to the maintenance shell
- About the appliance login banner
- Setting the appliance login banner
- Log Forwarding feature overview
- Upgrading the appliance
- About upgrading to NetBackup Virtual Appliance software version 5.1.1
- Requirements and best practices for upgrading NetBackup appliances
- Pre-upgrade tasks for appliance upgrades
- Methods for downloading appliance software release updates
- Installing a NetBackup Virtual Appliance software update using the NetBackup Virtual Appliance Shell Menu
- Troubleshooting upgrade issues
- NetBackup client upgrades with VxUpdate
- Appliance restore
- Decommissioning and Reconfiguring
- Troubleshooting
- About troubleshooting the NetBackup Virtual Appliance
- About contacting Technical Support
- Determining the NetBackup Virtual Appliance serial number
- About disaster recovery
- About NetBackup support utilities
- Troubleshooting NetBackup Virtual Appliance deployment or initial configuration issues
- Error messages displayed on the NetBackup Virtual Appliance Shell Menu
- NetBackup status codes applicable for NetBackup Virtual Appliance
- Installing an EEB
- Rolling back an EEB using the NetBackup Virtual Appliance Shell Menu
- Appliance logging
- About NetBackup Virtual Appliance log files
- Viewing log files using the Support command
- Where to find NetBackup Virtual Appliance log files using the Browse command
- Enabling and disabling VxMS logging
- Gathering device logs on a NetBackup virtual appliance
- Moving the log data
- About forwarding logs to an external server
- Commands overview
- Appendix A. Appliance commands
- Appendix B. Manage commands
- Manage > Software > Delete
- Manage > Software > Download
- Manage > Software > List
- Manage > Software > Install
- Manage > Software > Share
- Manage > Software > Readme
- Manage > Software > Rollback
- Manage > Software > Cancel
- Manage > Software > DownloadAnalyzer
- Manage > Software > DownloadProgress
- Manage > Software > UpgradeStatus
- Manage > Software > VxUpdate
- Manage > Storage > Show
- Manage > Storage > Add
- Manage > Storage > Create
- Manage > Storage > Delete
- Manage > Storage > Edit
- Manage > Storage > Monitor
- Manage > Storage > Move
- Manage > Storage > Remove
- Manage > Storage > Resize
- Manage > Storage > Scan
- Manage > OpenStorage > Install
- Manage > OpenStorage > List
- Manage > OpenStorage > Readme
- Manage > OpenStorage > Share
- Manage > OpenStorage > Uninstall
- Manage > MountPoints > List
- Manage > MountPoints > Mount
- Manage > MountPoints > Unmount
- Manage > License
- Manage > Certificates > Generate
- Manage > Certificates > Delete
- Manage > NetBackupCLI > Create
- Manage > NetBackupCLI > Delete
- Manage > NetBackupCLI > List
- Appendix C. Monitor commands
- Appendix D. Network commands
- Network > Configure
- Network > Date
- Network > DNS
- Network > Gateway
- Network > Hostname
- Network > Hosts
- Network > IPv4
- Network > IPv6
- Network > LinkAggregation
- Network > NetStat
- Network > NTPServer
- Network > Ping
- Network > SetProperty
- Network > Show
- Network > TimeZone
- Network > TraceRoute
- Network > Unconfigure
- Network > WANOptimization
- Appendix E. Reports commands
- Appendix F. Settings commands
- Settings > Deduplication
- Settings > LifeCycle
- Settings > LogForwarding
- Settings > NetBackup
- Settings > NetBackup DNAT
- Settings > NetBackup NATServers
- Settings > Password
- Settings > SystemLocale
- Settings > Share
- Settings > Sysctl
- Settings > Notifications > LoginBanner
- Settings > Security > Authentication > AccountStatus
- Settings > Security > Authentication > LDAP
- Settings > Security > Authentication > ActiveDirectory
- Settings > Security > Authentication > LocalUser
- Main > Settings > Security > Authentication > CIFSShare
- Settings > Security > Authorization
- Main > Settings > Security > Certificate
- Main > Settings > Security > Certificate > CertificateSigningRequest
- Main > Settings > Security > STIG
- Main > Settings > Security > FIPS
- Main > Settings > Security > SecurityLevel
- Main > Settings > Security > Sessions
- Settings > Alerts > CallHome
- Settings > Alerts > SNMP
- Settings > Alerts > Email
- Settings > Alerts > Hardware
- Appendix G. Support commands
- Support > Checkpoint
- Support > Cleanup > CleanMonInvData
- Support > DataCollect
- Support > Disk
- Support > Errors
- Support > FactoryReset
- Support > InfraServices
- Support > InstantAccess
- Support > iostat
- Support > LogBrowser
- Support > Logs
- Support > Maintenance
- Support > Messages
- Support > NBDNA
- Support > Nbperfchk
- Support > NBSU
- Support > Processes
- Support > Reboot
- Support > Service
- Support > Shutdown
- Support > Storage Create LogPartition
- Support > Storage Create NDMPLogPartition
- Support > Storage SanityCheck
- Support > Storage Reset
- Support > System
- Support > Test
- Appendix H. Available commands for a NetBackupCLI user
Performing the initial configuration on a NetBackup Virtual Appliance combined primary and media server
This section describes how to perform the initial configuration on a NetBackup Virtual Appliance with the combined primary and media server role.
To perform the initial configuration on a NetBackup Virtual Appliance with the combined primary and media server role
- After you have deployed a new virtual appliance, log on to the NetBackup Virtual Appliance Shell Menu.
The logon is admin, and the default password is P@ssw0rd.
- Use the following command to start the initial configuration:
Main > Appliance > Configure
A message about the Virtual Appliance Initial Configuration Wizard appears. This wizard will walk you through the process to configure this appliance.
- The wizard prompts you to change the default passwords.
Change each user account password as prompted.
Review the following password policy before setting a new password:
Passwords must contain at least eight characters.
Passwords must contain at least one lowercase letter (a-z) and one number (0-9).
Dictionary words are considered weak passwords and are not accepted.
The last seven passwords cannot be reused and the new password cannot be similar to previous passwords.
Note:
If you enter five consecutive invalid passwords for any user account, the appliance aborts the initial configuration process automatically. You must start the initial configuration process again.
Note:
If you enable the STIG feature after completing the initial configuration, you may be prompted to change the new passwords you entered here to meet the requirements of the STIG password policy.
- The wizard takes you to the network configuration.
Specify the following:
Hostname
Enter a short host name or a fully qualified domain name (FQDN) for this appliance. As a best practice, Veritas recommends that you use an FQDN.
Caution:
After the initial deployment has completed successfully, the only way to change the host name is to redeploy the appliance.
Note:
If you plan to configure Active Directory (AD) authentication on this appliance, the host name must be 15 characters or less. Otherwise, AD configuration can fail.
DNS domain name
Enter a DNS domain name for this appliance.
IPv4 address
Enter the IPv4 address to be used for this appliance.
Netmask
Enter the netmask that corresponds to the IP address.
Gateway IP address
Enter the IPv4 address of the gateway (network point) that acts as an entrance to another network.
DNS server 1 IP address
Enter the IPv4 address of the primary DNS server for this appliance.
DNS server 2 IP address(Optional)
Enter the IPv4 address of the secondary DNS server for this appliance.
When you are prompted with the following message, choose whether you want to add the host name and IP address to the HOSTS file.
The host name must be resolvable with a DNS or a HOSTS file for the initial configuration to be successful. Do you want to write the host name resolution information to the HOSTS file? [yes, no](no)
Note:
The host name must be resolvable with a DNS server or a HOSTS file for the initial configuration to be successful. If DNS is not available, you can add the host name and IP address to the HOSTS file.
- A Call Home settings test is performed. If Call Home is enabled, a Call Home test is performed. You can enable a proxy server if the test fails.
If Call Home is disabled, a prompt appears to enable Call Home. Veritas recommends that you enable Call Home for an improved support experience and recommendations through the NetInsights Console. However, you can ignore the warning and continue to the next step if you do not want to enable Call Home.
- After the network configuration is completed, the wizard takes you to the next step for the Veritas Usage Insights customer registration key. You cannot complete the configuration until you provide the registration key. To obtain a key, follow the onscreen prompts.
- Once the file is uploaded, the wizard takes you to final step for storage configuration.
Specify the following:
AdvancedDisk disk pool name
Enter a name for the AdvancedDisk disk pool on the appliance.
AdvancedDisk storage unit name
Enter a name for the AdvancedDisk storage unit on the appliance.
MSDP storage unit name
Enter a name for the MSDP storage unit on the appliance.
MSDP disk pool name
Enter a name for the MSDP disk pool on the appliance.
The storage configuration may take several minutes.
- Use the following command to verify that the configuration completed successfully:
Main > Appliance > Status
The command output should contain a message similar to the following:
Appliance Version is 5.1.1. Appliance is configured as primary appliance.
If the output does not show that the appliance is configured as a primary appliance, you need to redeploy the appliance or perform other troubleshooting steps to fix the issue before you proceed to the next step. See Troubleshooting NetBackup Virtual Appliance deployment or initial configuration issues.
- Use the following command to change the nbasecadmin account password from the known default password (P@ssw0rd):
Main > Settings > Password nbasecadmin
Note:
You cannot access the NetBackup web UI until you have changed the nbasecadmin user password.
- Use the following command to set the time zone:
Main > Network > TimeZone Set
Select the appropriate time zone from the displayed list.
- Use the following command to add a Network Time Protocol (NTP) server:
Main > Network > NTPServer Add <Server>
Where <Server> is the name of the NTPServer.
- Add a permanent license key before the evaluation key expires with the following command:
Main > Manage > License > NetBackup > Add
You can locate your permanent license key from the Veritas Entitlement Management System (VEMS). To access VEMS, click Licensing on the Veritas Support website.
Warning:
If the correct license key is not installed, the appliance services stop functioning after the evaluation key expires. Make sure that the NetBackup license you add includes support for NetBackup Virtual Appliance.
See Managing license keys on the NetBackup Virtual Appliance.
- (Optional)
If you want to configure an IPv6 address for the appliance, run the following command:
Main > Network > IPv6 <IPAddress> <Prefix> InterfaceName
Where <IPAddress> is the IPv6 address and <Prefix> is the prefix length.
- (Optional)
If you want to configure an IPv6 DNS server on the appliance, run the following command:
Main > Network > DNS Add NameServer <IPAddress>
Where <IPAddress> is the IPv6 address of the additional DNS server. Only global-scope and unique-local IPv6 addresses are allowed.
See Configuring DNS and host name mapping for the NetBackup Virtual Appliance.
- (Optional)
If you want to use an external Certificate Authority (CA) for communication between the appliance and your other NetBackup hosts, run the following command:
Main > Settings > NetBackup CertificateUsage Enable ECA
- (Optional)
If you plan to connect this combined primary and media server to another media server in a NAT network, perform the following tasks:
Enable the NetBackup DNAT feature on this combined primary and media server as follows:
Main > Settings > NetBackup DNAT Enable
Add the name of the other media server to the NetBackup Servers list on this combined primary and media server as follows:
Main > Settings > NetBackup NATServers Add
- (Optional)
If you deployed a product file with an initial storage capacity of .5 TB and want to add storage up to a total of 16 TB, use the following steps to add additional disks:
Use the VMware vSphere Client to create new virtual disks with sizes that are multiples of 0.5 TB, or 512 GB.
From the NetBackup Virtual Appliance Shell Menu, run the following command:
Main > Manage > Storage > Scan
This command refreshes the storage disks and device information to locate available disks.
Run the following command:
Main > Manage > Storage > Add
This command launches a wizard that displays the available disks. Follow the prompts to add the disks. To add multiple disks at one time, use a comma-separated list.
See Adding storage space for the NetBackup Virtual Appliance.
- Log on to the appliance from the NetBackup Administration Console and activate the NetBackup catalog backup policy.
By default, the appliance creates an inactive backup policy that uses a Storage Lifecycle Policy (SLP) to protect the NetBackup catalog. The SLP backs up the data to AdvancedDisk and then duplicates it to MSDP. You are then able to use Auto Image Replication to save your catalog backup off site. Veritas recommends that you use this replication-based strategy for disaster recovery (DR) due to the combined primary and media server role of the appliance.
To activate the policy, navigate to the NetBackup Management > Policies tab in the Administration Console, right-click on the
nbu-catalogpolicy, and select Activate.Note:
You must set a encryption passphrase for the disaster recovery package for the catalog to be successful. Catalog backups continue to fail until the passphrase is set.
For more information about the security requirements for disaster recovery , see the NetBackup Security and Encryption Guide.
If you plan to use AdvancdDisk to back up your clients, note that the AdvancedDisk does not support Auto Image Replication. If you want to save the data off site, create an SLP to duplicate the backup data on AdvancedDisk to MSDP. You are then able to use Auto Image Replication to transfer the data off site.
- If you want to configure the appliance for MSDP cloud, log in to the NetBackup web UI as the nbasecadmin user and configure the MSDP cloud storage as follows:
Create a disk pool.
Create a storage unit.
For details, see the NetBackup Web UI Administrator's Guide.
After the appliance is configured and operational, you are ready to install NetBackup client software on the computers that you want to back up.
See the NetBackup Installation Guide for how to install NetBackup clients.