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
About the NetBackupCLI user role
A NetBackupCLI user can execute all NetBackup commands, view logs, edit NetBackup touch files, and edit NetBackup notify scripts. NetBackupCLI users are solely restricted to run NetBackup commands with superuser privileges and do not have access outside the scope of NetBackup software directories. Once these users log on, they are taken to a restricted shell from where they can run the NetBackup commands. The NetBackupCLI users share a home directory and do not have access to the NetBackup Virtual Appliance Shell Menu.
Starting with appliance release 5.0, NetBackupCLI users can only run some commands as a superuser and are required to follow the NetBackup CLI authorization mechanism to authenticate and run such commands. Refer to the NetBackup Commands Reference Guide for more information on the exact permissions that are required by various NetBackup commands and command parameters.
The NetBackupCLI role can be assigned to a maximum of nine user groups at any given time. To create a local NetBackupCLI user, use the Manage > NetBackupCLI > Create command from theNetBackup Virtual Appliance Shell Menu. See Manage > NetBackupCLI > Create.
Note:
You cannot grant the NetBackupCLI role to an existing local user.
Table: Privileges and restrictions of the appliance NetBackupCLI user lists the rights and restrictions of NetBackupCLI users.
Table: Privileges and restrictions of the appliance NetBackupCLI user
Privileges | Restrictions |
|---|---|
The NetBackupCLI user can use the NetBackup Virtual Appliance Shell Menu to do the following:
| The following restrictions are placed on NetBackupCLI users:
|
Log in as a NetBackupCLI user and type Command at the command prompt to enter into a restrictive shell environment. You can then run the NetBackup commands from that shell. Using absolute paths to run NetBackup commands is not allowed. For example, you can run bplist but you cannot run /usr/openv/netbackup/bin/admincmd/bplist from the command shell.
You may need additional authorization before you can run some of the NetBackup commands. You will see a different authorization prompt depending on the NetBackup command you are trying to run.
The following list describes the typical scenarios for successfully executing NetBackup commands:
Authorization prompt: web login is required
Some NetBackup commands may require a web login. You will see the following prompt:
A web login is required. Run the 'bpnbat -login -loginType WEB|WEBUI|APIKEY' command to login. EXIT STATUS 5930: The request could not be authorized.
To authenticate such requests, you must log in to the NetBackup Web Management Service as a NetBackup administrator and run the following command:
myappliance.NBCLIUSER> bpnbat -login -logintype WEB
The following shows an example WEB login:
Authentication Broker: ApplianceHostname Authentication Port: 0 Authentication Type: unixpwd LoginName: Username Password: Password Operation completed successfully.
Authorization prompt: web ui login required
Some NetBackup commands may require an approval using an access token. To authenticate such requests, generate an access code by running the following command:
# bpnbat -login -logintype webui -requestApproval
Make a note of the access code that is displayed in the command window.
Sign in to the NetBackup web UI as a NetBackup Command Line (CLI) Admin user and approve the CLI access request by entering the access code that you generated earlier. For more information about access key and approval requests, refer to the NetBackup Security and Encryption Guide.
Authorization prompt: superuser privileges required
Some NetBackup commands may require superuser privileges. You will see the following prompt:
EXIT STATUS 140: user id was not superuser
To authenticate such requests, use sudo to elevate the privileges and run the NetBackup commands using the absolute path. For example:
# sudo /usr/openv/netbackup/bin/nbkmscmd -discoverNbkms
If the authentication messages persist even after you have used the absolute path and sudo, you can use the WEB login method described earlier and run the following command for authenticating the request:
# sudo /usr/openv/netbackup/bin/bpnbat -login -loginType WEB
General considerations:
The authentication cases described earlier are typical scenarios. Some NetBackup commands may require other authentication methods. Refer to the NetBackup Commands Reference Guide for more information on the exact permissions that are required by various NetBackup commands and command parameters.
Some NetBackup commands are run as root by default. You can verify whether a particular command requires root privileges by running the following command:
nbucliuser-!> alias | grep NetBackup command
For example, nbkms command runs as root by default:
nbucliuser-!> alias | grep nbkms
alias nbkms='sudo -n /usr/openv/netbackup/bin/nbkms'
Some NetBackup commands are run by the current NetBackupCLI user by default. But there are some NetBackup command parameters that require root privileges. In such cases, you can use 'sudo <absolute path of command> <parameters>' to run the command.
If you see a prompt "sudo: a password is required", it means that the command cannot be run as root. Contact Veritas Technical Support for help with such scenarios.
See About running NetBackup commands from the appliance.
Special directive operations can fail if the special directive files and commands are not in the correct NetBackup list or path. One example of a special directive operation is when you specify an alternate restore path.
Appliance users that need to run NetBackup commands to access special directive files as a NetBackupCLI user, must do the following to ensure successful operation:
Add the
/home/nbuserspath to the NetBackupbpcd allowed list.Add the special directive commands to the
/home/nbusersdirectory.
For details about adding entries to the NetBackup bpcd allowed list, refer to the BPCD_WHITELIST_PATH configuration option in the following documents:
NetBackup Administrator's Guide, Volume 1
NetBackup Commands Reference Guide