Search <book_title>...

Veritas NetBackup™ Virtual Appliance Documentation

Last Published: 2023-07-31

Product(s): Appliances (5.1.1)

Platform: NetBackup Virtual Appliance

Getting to know the NetBackup Virtual Appliance
1. NetBackup Virtual Appliance product description
2. NetBackup Virtual Appliance supported features
3. About the NetBackup Virtual Appliance documentation
4. NetBackup Virtual Appliance 5.1.1 new features, enhancements, and changes
5. Known limitations of the NetBackup Virtual Appliance 5.1.1 release
6. Operational Notes for the NetBackup Virtual Appliance 5.1.1 release
Preparing to deploy the appliance
1. NetBackup Virtual Appliance product files (OVF templates)
2. NetBackup Virtual Appliance deployment methods
3. NetBackup Virtual Appliance deployment guidelines
  1. Configuration overview for NetBackup Virtual Appliance MSDP cloud applications
  2. NetBackup Virtual Appliance initial deployment checklist
Deploying and configuring the appliance
1. How to deploy and configure a NetBackup Virtual Appliance combined primary and media server
2. How to deploy and configure a NetBackup Virtual Appliance media server
3. How to deploy and configure a NetBackup Virtual Appliance primary server
Post initial configuration procedures
1. About modifying the NetBackup Virtual Appliance settings
2. Adding a permanent license key if an evaluation license key expires
3. Managing license keys on the NetBackup Virtual Appliance
Appliance common tasks
1. Common tasks in NetBackup Virtual Appliance
Storage management
1. About NetBackup Virtual Appliance storage configuration
2. About OpenStorage plugin installation
  1. Installing the OpenStorage plugin
  2. Uninstalling the OpenStorage plugin
Deduplication pool catalog backup and recovery
1. About the NetBackup Virtual Appliance deduplication pool catalog backup policy
2. Automatic configuration of the NetBackup Virtual Appliance deduplication pool catalog backup policy
3. Manually configuring the NetBackup Virtual Appliance deduplication pool catalog backup policy
4. Manually updating the NetBackup Virtual Appliance deduplication pool catalog backup policy
5. Recovering the NetBackup Virtual Appliance deduplication pool catalog
Network connection management
1. About IPv4-IPv6-based network support
2. Network settings for the NetBackup Virtual Appliance
3. Configuring DNS and host name mapping for the NetBackup Virtual Appliance
4. Setting the date and time on a NetBackup Virtual Appliance
5. Configuring static routes on the NetBackup Virtual Appliance
6. Expanding the bandwidth on the NetBackup Virtual Appliance
Managing users
1. About managing NetBackup Virtual Appliance users
2. About NetBackup Virtual Appliance account types
3. Adding NetBackup Virtual Appliance users
4. Deleting NetBackup Virtual Appliance users
5. Adding NetBackup Virtual Appliance user groups
6. Deleting NetBackup Virtual Appliance user groups
7. Granting roles to NetBackup Virtual Appliance users and user groups
8. Revoking roles from NetBackup Virtual Appliance users and user groups
9. About user name and password specifications
  1. About STIG-compliant password policy rules
10. Changing NetBackup Virtual Appliance user passwords
11. About password management and recovery
12. About authenticating LDAP users
13. About authenticating Active Directory users
  1. Adding an Active Directory server configuration
  2. Unconfiguring Active Directory user authentication on the NetBackup Virtual Appliance
14. About authentication using smart cards and digital certificates
15. Generic user authentication guidelines
16. About user authorization on the NetBackup Virtual Appliance
17. Creating NetBackup administrator user accounts
18. Deleting NetBackup administrator user accounts
Using the appliance
1. About configuring Host parameters for your appliance on the NetBackup Virtual Appliance
2. About Copilot functionality and Share management
3. About NetBackup Virtual Appliance as a VMware backup host
  1. NetBackup Virtual Appliance as backup host: component overview
  2. Notes on NetBackup Virtual Appliance as a VMware backup host
4. About running NetBackup commands from the appliance
5. About mounting a remote NFS
  1. Mounting a remote NFS drive
  2. Unmounting an NFS drive
6. About Auto Image Replication from a NetBackup Virtual Appliance
7. Generating certificates
Monitoring the appliance
1. About NetBackup Virtual Appliance alerts
2. Setting up email notifications for a NetBackup Virtual Appliance
3. Setting up SNMP notifications for a NetBackup Virtual Appliance
4. Enabling and disabling Call Home from the appliance shell menu
5. Configuring a Call Home proxy server from the NetBackup Virtual Appliance Shell Menu
6. About SNMP
  1. About the Management Information Base (MIB)
7. About Call Home
  1. Understanding the Call Home workflow
  2. About the Product Improvement Program
8. About AutoSupport
9. About storage email alerts
Appliance security
1. About Symantec Data Center Security on the NetBackup Virtual Appliance
2. About data security
3. About data integrity
4. About data classification
5. About data encryption
  1. KMS support
6. About SSL usage
7. About implementing external certificates
8. About the NetBackup Virtual Appliance intrusion detection system
9. About the NetBackup Virtual Appliance intrusion prevention system
10. Major components of the NetBackup Virtual Appliance OS
11. OS STIG hardening for NetBackup Virtual Appliance
12. FIPS 140-2 conformance for NetBackup Virtual Appliance
13. Disable user access to the NetBackup appliance operating system
14. Manage support access to the maintenance shell
15. About the appliance login banner
16. Setting the appliance login banner
  1. Creating the appliance login banner
  2. Removing the appliance login banner
17. Log Forwarding feature overview
Upgrading the appliance
1. About upgrading to NetBackup Virtual Appliance software version 5.1.1
2. Requirements and best practices for upgrading NetBackup appliances
  1. Upgrade time estimation
3. Pre-upgrade tasks for appliance upgrades
4. Methods for downloading appliance software release updates
  1. Downloading software updates directly to a NetBackup appliance
  2. Downloading software updates to a NetBackup appliance using a client share
5. Installing a NetBackup Virtual Appliance software update using the NetBackup Virtual Appliance Shell Menu
6. Troubleshooting upgrade issues
NetBackup client upgrades with VxUpdate
1. About VxUpdate
2. VxUpdate repository management
3. Deployment policy management
4. Manually initiating upgrades from the primary server using VxUpdate
5. Manually initiating upgrades from the client using VxUpdate
6. Deployment job status
Appliance restore
1. About appliance restore
2. Creating an appliance checkpoint from the appliance shell menu
3. Rollback to an appliance checkpoint from the appliance shell menu
4. About NetBackup Virtual Appliance factory reset
5. Factory reset best practices
6. How to factory reset the NetBackup Virtual Appliance
Decommissioning and Reconfiguring
1. About decommissioning a NetBackup Virtual Appliance
2. Decommissioning a NetBackup Virtual Appliance with the media server role
3. Migrating from NetBackup Cloud Catalyst Appliance to MSDP direct cloud tiering
Troubleshooting
1. About troubleshooting the NetBackup Virtual Appliance
2. About contacting Technical Support
3. Determining the NetBackup Virtual Appliance serial number
4. About disaster recovery
  1. Recovering a NetBackup appliance primary server using NetBackup catalog restore
5. About NetBackup support utilities
  1. NetBackup Domain Network Analyzer (NBDNA)
  2. NetBackup Support Utility (NBSU)
6. Troubleshooting NetBackup Virtual Appliance deployment or initial configuration issues
7. Error messages displayed on the NetBackup Virtual Appliance Shell Menu
8. NetBackup status codes applicable for NetBackup Virtual Appliance
9. Installing an EEB
10. Rolling back an EEB using the NetBackup Virtual Appliance Shell Menu
Appliance logging
1. About NetBackup Virtual Appliance log files
2. Viewing log files using the Support command
3. Where to find NetBackup Virtual Appliance log files using the Browse command
4. Enabling and disabling VxMS logging
5. Gathering device logs on a NetBackup virtual appliance
6. Moving the log data
7. About forwarding logs to an external server
Commands overview
1. About the NetBackup Virtual Appliance Shell Menu
2. Logging in to the NetBackup Virtual Appliance Shell Menu
3. Using the NetBackup Virtual Appliance Shell Menu
4. About the NetBackup Virtual Appliance Shell Menu command views
Appendix A. Appliance commands
1. Appliance > Primary
2. Appliance > Media
3. Appliance > ShowDedupPassword
4. Appliance > Status
5. Appliance > Configure
Appendix B. Manage commands
1. Manage > Software > Delete
2. Manage > Software > Download
3. Manage > Software > List
4. Manage > Software > Install
5. Manage > Software > Share
6. Manage > Software > Readme
7. Manage > Software > Rollback
8. Manage > Software > Cancel
9. Manage > Software > DownloadAnalyzer
10. Manage > Software > DownloadProgress
11. Manage > Software > UpgradeStatus
12. Manage > Software > VxUpdate
13. Manage > Storage > Show
14. Manage > Storage > Add
15. Manage > Storage > Create
16. Manage > Storage > Delete
17. Manage > Storage > Edit
18. Manage > Storage > Monitor
19. Manage > Storage > Move
20. Manage > Storage > Remove
21. Manage > Storage > Resize
22. Manage > Storage > Scan
23. Manage > OpenStorage > Install
24. Manage > OpenStorage > List
25. Manage > OpenStorage > Readme
26. Manage > OpenStorage > Share
27. Manage > OpenStorage > Uninstall
28. Manage > MountPoints > List
29. Manage > MountPoints > Mount
30. Manage > MountPoints > Unmount
31. Manage > License
32. Manage > Certificates > Generate
33. Manage > Certificates > Delete
34. Manage > NetBackupCLI > Create
35. Manage > NetBackupCLI > Delete
36. Manage > NetBackupCLI > List
Appendix C. Monitor commands
1. Monitor > Uptime
2. Monitor > Who
3. Monitor > NetworkStatus
4. Monitor > Top
5. Monitor > MemoryStatus
6. Monitor > SDCS
7. Monitor > NetBackup
8. Monitor > Hardware
Appendix D. Network commands
1. Network > Configure
2. Network > Date
3. Network > DNS
4. Network > Gateway
5. Network > Hostname
6. Network > Hosts
7. Network > IPv4
8. Network > IPv6
9. Network > LinkAggregation
10. Network > NetStat
11. Network > NTPServer
12. Network > Ping
13. Network > SetProperty
14. Network > Show
15. Network > TimeZone
16. Network > TraceRoute
17. Network > Unconfigure
18. Network > WANOptimization
Appendix E. Reports commands
1. Reports > Deduplication
2. Reports > Process
Appendix F. Settings commands
1. Settings > Deduplication
2. Settings > LifeCycle
3. Settings > LogForwarding
4. Settings > NetBackup
5. Settings > NetBackup DNAT
6. Settings > NetBackup NATServers
7. Settings > Password
8. Settings > SystemLocale
9. Settings > Share
10. Settings > Sysctl
11. Settings > Notifications > LoginBanner
12. Settings > Security > Authentication > AccountStatus
13. Settings > Security > Authentication > LDAP
14. Settings > Security > Authentication > ActiveDirectory
15. Settings > Security > Authentication > LocalUser
16. Main > Settings > Security > Authentication > CIFSShare
17. Settings > Security > Authorization
18. Main > Settings > Security > Certificate
19. Main > Settings > Security > Certificate > CertificateSigningRequest
20. Main > Settings > Security > STIG
21. Main > Settings > Security > FIPS
22. Main > Settings > Security > SecurityLevel
23. Main > Settings > Security > Sessions
24. Settings > Alerts > CallHome
25. Settings > Alerts > SNMP
26. Settings > Alerts > Email
27. Settings > Alerts > Hardware
Appendix G. Support commands
1. Support > Checkpoint
2. Support > Cleanup > CleanMonInvData
3. Support > DataCollect
4. Support > Disk
5. Support > Errors
6. Support > FactoryReset
7. Support > InfraServices
8. Support > InstantAccess
9. Support > iostat
10. Support > LogBrowser
11. Support > Logs
12. Support > Maintenance
13. Support > Messages
14. Support > NBDNA
15. Support > Nbperfchk
16. Support > NBSU
17. Support > Processes
18. Support > Reboot
19. Support > Service
20. Support > Shutdown
21. Support > Storage Create LogPartition
22. Support > Storage Create NDMPLogPartition
23. Support > Storage SanityCheck
24. Support > Storage Reset
25. Support > System
26. Support > Test
Appendix H. Available commands for a NetBackupCLI user
1. Command
2. Password

Requirements and best practices for upgrading NetBackup appliances

This topic describes the requirements and best practices that you should follow anytime you plan to upgrade appliance software.

You can perform upgrades from the Appliance Management Console. After you review all upgrade guidelines and perform the required pre-upgrade tasks, refer to the Veritas Appliance Management Guide for the upgrade procedure.
Note:
The Appliance Management Console does not currently support upgrading appliances (nodes) in an HA setup. You must use the NetBackup Virtual Appliance Shell Menu to upgrade these appliances.
Always perform upgrades with the admin user account. Do not use a non-admin user account to upgrade appliances.
Always perform a full disaster recovery (DR) backup before an upgrade.
- Primary servers
  Make sure that you have a recent and complete NetBackup Catalog backup.
- Make sure to configure your deduplication pool catalog backup policy and perform a successful backup. For details, refer to the following article:
  https://www.veritas.com/support/en_US/article.100046592
Use the Network > Security > Export command to perform this task. The Export command copies two .pfx files (serialnumber.pfx and .serialnumber.pfx) to a location that you specify when you run the command.
- Log in to the NetBackup Virtual Appliance Shell Menu and navigate to the following view:
  Network > Security > Export
- Enter the following export option details:
  Export [EnterPasswd] [PathValue]
  Where [EnterPasswd] is the field used to answer the question, "Do you want to enter a password?". You must enter yes or no.
  Where [PathValue] is the location where you want to place the exported certificates.
- After the export has completed, back up both of the .pfx files to a non-appliance location.
Delete previously downloaded release updates, client packages, and client add-ons.
To make sure that there is enough space in the /inst partition during the upgrade, first delete all previously downloaded release updates, client packages, and client add-ons from the appliance. As a best practice, always remove downloaded packages after all appliances and clients have been upgraded.
If you do not delete the previously downloaded packages and the /inst directory on the appliance does not contain enough space, the preflight check and the Appliance Upgrade Readiness Analyzer tool prevent the upgrade. Even if enough space exists to allow the upgrade to start, the upgrade may fail if the old client add-ons are not removed. For downloaded packages on high availability (HA) nodes, you must remove the packages from both nodes.
The following describes the package removal methods:
- On the appliance to be upgraded, check for all downloaded release updates and client packages by entering the following command:Manage > Software > List Downloaded.
- To remove each downloaded release update and client package, enter the following command:Manage > Software > Deleteupdate_name. Where update_name is the release update or the client package file name.
- To see a list of all downloaded client add-ons, enter the following command:Manage > Software > List AddOns.
- To remove each downloaded client add-on, enter the following command:Manage > Software > Rollbackeeb_name. Where eeb_name is the client add-on file name.
  Note:
  You must include the .rpm extension when you enter the client add-on file name.
Follow the same upgrade order for appliances as for traditional NetBackup upgrades. If you use NetBackup OpsCenter, upgrade it first. Then upgrade appliances starting with the primary server appliance, followed by all media server appliances.
If you have multiple media servers to upgrade, you must perform the upgrade process on each individual media server.
Appliance media servers (nodes) in an HA setup are updated one at a time. Both nodes must use the same appliance software version. Once you have upgraded one node, you must upgrade the other node immediately.
If a traditional NetBackup primary server is used with an appliance media server, that primary server must have the same NetBackup version or later as the media server appliance. For example, before you upgrade a media server appliance to version 5.1.1, first upgrade the NetBackup primary server to version 10.1.1.
See About corresponding NetBackup software versions .
Make sure that the NetBackup primary server is active and running throughout the duration of an appliance media server upgrade. In addition, make sure that the NetBackup processes are started or running on both the primary server and the media server.
NetBackup clients must use the same or an earlier software version as the appliance. Clients cannot run at a later version than the appliance. For example, a client with NetBackup version 10.1.1 can only be used with an appliance server with version 5.1.1 or later. Client add-ons must also be the same as the client version.
See About corresponding NetBackup software versions .
Upgrades to version 3.2 and later using the NetBackup Virtual Appliance Shell Menu or the Appliance Management Console (AMS) do not support ECA deployment during the upgrade. After a successful upgrade, you can enable the ECA for NetBackup. For details, see the NetBackup Appliance Commands Reference Guide. Additionally, you can configure the ECA to the appliance infrastructure services such as mongodb, tomcat, and nginx. For details, see the NetBackup Appliance Security Guide.
Use a compatible version of the NetBackup Administration Console to manage the NetBackup services.
The NetBackup Administration Console is backward-compatible. A patch release (x.x.x.x) console is compatible with a major (x.x) or minor NetBackup release (x.x.x) that shares the same first and second digits.