Search <book_title>...

Veritas NetBackup™ Virtual Appliance Documentation

Last Published: 2021-01-22

Product(s): Appliances (3.3.0.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 3.3.0.1 new features, enhancements, and changes
5. Known limitations of the NetBackup Virtual Appliance 3.3.0.1 release
6. Operational Notes for the NetBackup Virtual Appliance 3.3.0.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 master 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 master 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. About authenticating Kerberos-NIS users
  1. Adding a Kerberos-NIS authentication configuration on the NetBackup Virtual Appliance
  2. Unconfiguring Kerberos-NIS user authentication on the NetBackup Virtual Appliance
16. Generic user authentication guidelines
17. About user authorization on the NetBackup Virtual Appliance
18. Creating NetBackup administrator user accounts
19. 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
6. About the NetBackup Virtual Appliance intrusion detection system
7. About the NetBackup Virtual Appliance intrusion prevention system
8. Major components of the NetBackup Virtual Appliance OS
9. OS STIG hardening for NetBackup Virtual Appliance
10. Unenforced STIG hardening rules
11. FIPS 140-2 conformance for NetBackup Virtual Appliance
12. Vulnerability scanning of the NetBackup Virtual Appliance
13. About the appliance login banner
14. Setting the appliance login banner
  1. Creating the appliance login banner
  2. Removing the appliance login banner
15. Log Forwarding feature overview
Upgrading the appliance
1. About upgrading to NetBackup Virtual Appliance software version 3.3.0.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 master 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
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 master 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 initial deployment 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. 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 > Master
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 > DownloadProgress
10. Manage > Software > UpgradeStatus
11. Manage > Software > VxUpdate
12. Manage > Storage > Show
13. Manage > Storage > Add
14. Manage > Storage > Create
15. Manage > Storage > Delete
16. Manage > Storage > Edit
17. Manage > Storage > Monitor
18. Manage > Storage > Move
19. Manage > Storage > Remove
20. Manage > Storage > Resize
21. Manage > Storage > Scan
22. Manage > OpenStorage > Install
23. Manage > OpenStorage > List
24. Manage > OpenStorage > Readme
25. Manage > OpenStorage > Share
26. Manage > OpenStorage > Uninstall
27. Manage > MountPoints > List
28. Manage > MountPoints > Mount
29. Manage > MountPoints > Unmount
30. Manage > License > Add
31. Manage > License > List
32. Manage > License > ListInfo
33. Manage > License > Remove
34. Manage > Certificates > Generate
35. Manage > Certificates > Delete
36. Manage > NetBackupCLI > Create
37. Manage > NetBackupCLI > Delete
38. 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 > Password
6. Settings > SystemLocale
7. Settings > Share
8. Settings > Sysctl
9. Settings > NetBackup DNAT
10. Settings > NetBackup NATServers
11. Settings > Notifications > LoginBanner
12. Settings > Security > Authentication > LDAP
13. Settings > Security > Authentication > ActiveDirectory
14. Settings > Security > Authentication > Kerberos
15. Settings > Security > Authentication > LocalUser
16. Settings > Security > Authorization
17. Main > Settings > Security > Certificate
18. Main > Settings > Security > STIG
19. Main > Settings > Security > FIPS
20. Settings > Alerts > CallHome
21. Settings > Alerts > SNMP
22. Settings > Alerts > Email
23. Settings > Alerts > Hardware
Appendix G. Support commands
1. Support > Checkpoint
2. Support > DataCollect
3. Support > Disk
4. Support > Errors
5. Support > FactoryReset
6. Support > InfraServices
7. Support > iostat
8. Support > LogBrowser
9. Support > Logs
10. Support > Maintenance
11. Support > Messages
12. Support > NBDNA
13. Support > nbperfchk
14. Support > NBSU
15. Support > Processes
16. Support > Reboot
17. Support > Service
18. Support > Shutdown
19. Support > Storage SanityCheck
20. Support > Storage Reset
21. Support > Test

Name

Main > Settings > Security > Authentication > LDAP — configure and manage Lightweight Directory Access Protocol (LDAP) user registration and authentication on the appliance.

SYNOPSIS

Attribute

Certificate

ConfigParam

Configure

Disable

Enable

Export

Groups

Import

List

Map

Show

Status

Unconfigure

Users

DESCRIPTION

You can use the LDAP command to perform the following tasks:

Add or delete LDAP configuration attributes.
Set or show the trusted LDAP server certificate.
Set, unset, or show the various LDAP configuration parameters.
Configure the appliance for LDAP user authentication.
Disable LDAP user authentication.
Enable LDAP user authentication.
Export LDAP configuration as an XML file.
Add or remove one or more LDAP user groups.
Import LDAP configuration from an XML file.
List all LDAP users and user groups.
Add, delete, or show NSS map attributes or object classes.
Show the LDAP configuration.
Show the status of LDAP authentication.
Unconfigure LDAP user authentication for the appliance.
Add or remove one or more LDAP users.

OPTIONS

The following commands and options are available under Authentication > LDAP:

Attribute

Add or delete LDAP configuration attributes.

Use the Attribute Add <parameter_name> <attribute> command to add a new attribute.
Use the Attribute Delete <attribute_name> command to delete an existing attribute.

Certificate

Set, view, or disable the SSL certificate.

Use the Certificate Set <filename> command to enable and add the SSL certificate. The SSL certificate must be stored in the /inst/patch/incoming directory.
Note:
When you use the ssl=StartTLS and ssl=Yes options during LDAP or AD configuration on the appliance, the initial setup is done over a non-SSL channel. After the LDAP connection and initial discover phase is over, the SSL channel is turned on. Even at this phase, establishing the SSL channel does not perform the server-side certificate validation. This validation starts after the server's root certificate is explicitly set using the LDAP > Certificate Set <path> option.
Use the Certificate Show command to view the certificate applicable for the LDAP server.
Use the Certificate Unset command to disable the SSL certificate.

ConfigParam

Set, view, and unset the LDAP configuration parameters.

Note:

The ConfigParam command is only used to set the various LDAP configuration parameters. Once you set all of the necessary parameters, use the Configure command to enable the LDAP configuration and establish a connection with the LDAP server.

Use the ConfigParam Set command to add or change the following LDAP configuration parameters:
* Required parameters
- *ConfigParam Set base <base_DN>
  Enter the base directory name which is the top level of the LDAP directory tree.
- ConfigParam Set binddn <bind_DN>
  Enter the bind directory name. The bind DN is used as an authentication to externally search the LDAP directory within the defined search base.
- ConfigParam Set bindpw <password>
  Enter the password to access the LDAP server.
- ConfigParam Set directoryType <directoryType>
  Enter the LDAP directory type. The available options are: OpenLDAP, ActiveDirectory, and Others.
  Select OpenLDAP if you use a typical OpenLDAP directory service.
  Select ActiveDirectory if you use AD as an LDAP directory service.
  Select Others if you use a different type of LDAP directory service.
- ConfigParam Set groupList <group_name(s)>
  Enter the name of an existing LDAP user group that resides on the LDAP server. To enter multiple groups, separate each group name with a comma (,).
- *ConfigParam Set host <server_name or IP>
  Enter the FQDN or IP address of the LDAP server.
  Note:
  The specified LDAP server should comply with RFC 2307bis. The RFC2307bis specifies that hosts with IPv6 addresses must be written in their preferred form, such that all components of the address are indicated and leading zeros are omitted.
- *ConfigParam Set ssl <No|Yes|StartTLS>
  Enable SSL certificate for the LDAP server.
  Note:
  When you use the StartTLS and Yes options during LDAP configuration, the initial setup is done over a non-SSL channel. After the LDAP connection and initial discover phase is over, the SSL channel is turned on. Even at this phase, the established SSL channel doesn't do the server-side certificate validation. This validation starts after the server's root certificate is explicitly set using the LDAP > Certificate Set command.
- ConfigParam Set userList <user_name(s)>
  Enter the name of an existing LDAP user that resides on the LDAP server. To enter multiple users, separate each user name with a comma (,).
Use the ConfigParam Show command to view the existing LDAP configuration parameters.
Use the ConfigParam Unset <parameters> command to unset the LDAP configuration parameters.

Configure: After setting the LDAP parameters using the ConfigParam command, run the Configure command to complete the configuration and enable LDAP authentication on the appliance.

Disable: Disable LDAP user authentication on the appliance. This command does not remove the configuration and you can reenable it using the Enable command.

Enable: Enable a disabled LDAP configuration on the appliance.

Export <file_name>: Export the existing LDAP configuration as an XML file. The file is saved at /inst/patch/incoming/<file_name>. This file can be imported to configure LDAP on other appliances.

Groups

Add or remove one or more LDAP user groups. Only the user groups that already exist on the LDAP server can be added to the appliance.

Use the Groups Add <groupname> command to add a comma-separated list of LDAP user groups.
Use the Groups Remove <groupname> command to delete a comma-separated list of LDAP user groups.

Import <path>: Import the LDAP configuration from an XML file. The XML file must reside at /inst/patch/incoming/<file_name>.

List: List all of the LDAP users and user groups that have been added to the appliance.

Map

Add, delete, or show NSS map attributes.

Use the Map Add Attribute <attribute type> <attribute value> command to set an NSS map attribute.
Use the Map Delete Attribute <attribute type> command to delete an NSS map attribute.
Use the Map Show command to view the NSS map attributes.

Show: View the LDAP configuration details.
Status: View the status of LDAP authentication on the appliance.

Unconfigure: Unconfigure LDAP user authentication for the appliance.
Note:
Before you unconfigure the LDAP server, you must revoke the roles from all of the LDAP users that have been added to the appliance. Otherwise the operation fails.
Warning:
Unconfiguring LDAP user authentication disables and deletes the current LDAP configuration. The LDAP users are deleted from the appliance, but not from the LDAP server.

Users

Add or remove one or more LDAP users. Only the users that already exist on the LDAP server can be added to the appliance.

Use the Users Add <username> command to add a comma-separated list of LDAP users.
Use the Users Remove <username> command to delete a comma-separated list of LDAP users.
Note:
As a matter of best practice, you should delete a registered user or user group from the appliance before deleting it from the LDAP server, AD server, or NIS server. If a user is removed from the remote directory service first (and not removed from appliance), the user is listed as a registered user on the appliance but won't be able to log on.

EXAMPLES

Example 1 - Configure an association between the appliance and an LDAP directory server to enable the appliance to import users and user groups.

appliance123.LDAP > ConfigParam Set host ldap.example.com
appliance123.LDAP > ConfigParam Set base dc=sample,dc=com
appliance123.LDAP > ConfigParam Set ssl no
appliance123.LDAP > Configure
- [Info] Configure Successful. Continuing with Post-Configure Processing!
Configure Successful. Continuing with Post-Configure Processing!

Command was successful!

Example 2 - Register a user or user group from the LDAP directory server so that those users can be authorized and authenticated on the appliance.

appliance123.LDAP> Users Add ldapuser1,ldapuser2
Command was successful!
appliance123.LDAP> Groups Add ldapgroup01
Command was successful!
appliance123.Authorization> List

+----------------------------------------------------------+
|Principal Type|Name/login |Access | Role |Principal Source|
|--------------+-----------+-------+------+----------------|
|User          |ldapuser1  |Allowed|NoRole|Ldap            |
|--------------+-----------+-------+------+----------------|
|User          |ldapuser2  |Allowed|NoRole|Ldap            |
|--------------+-----------+-------+------+----------------|
|Group         |ldapgroup01|Allowed|NoRole|Ldap            |
|--------------+-----------+-------+------+----------------|
|  -Member     |ldapuser3  |Allowed|      |                |
+----------------------------------------------------------+

Command was successful!

Example 3 - Export the current LDAP configuration into an XML file that can be imported on other appliances.

appliance123.LDAP> Export ldapconfig1
- [Info] Exporting LDAP configuration
Exporting LDAP configuration

Command was successful!

Example 4 - Import an LDAP configuration from an XML file.

appliance123.LDAP> Export ldapconfig1
- [Info] Exporting LDAP configuration
Exporting LDAP configuration

Command was successful!