Veritas NetBackup™ Virtual Appliance Documentation
- Getting to know the NetBackup Virtual Appliance
- NetBackup Virtual Appliance product description
- 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
- About OpenStorage plugin installation
- About NetBackup Virtual Appliance storage configuration
- Deduplication pool catalog backup and recovery
- Network connection management
- Managing users
- About user name and password specifications
- About authenticating LDAP users
- About authenticating Active Directory users
- About authentication using smart cards and digital certificates
- About user authorization on the NetBackup Virtual Appliance
- Creating 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
- About mounting a remote NFS
- About Auto Image Replication from a NetBackup Virtual Appliance
- Monitoring the appliance
- About SNMP
- About Call Home
- Appliance security
- About Symantec Data Center Security on the NetBackup Virtual Appliance
- About data encryption
- Setting the appliance login banner
- Upgrading the appliance
- About upgrading to NetBackup Virtual Appliance software version 5.1.1
- Requirements and best practices for upgrading NetBackup appliances
- Methods for downloading appliance software release updates
- NetBackup client upgrades with VxUpdate
- Appliance restore
- Decommissioning and Reconfiguring
- Troubleshooting
- About disaster recovery
- About NetBackup support utilities
- Appliance logging
- About forwarding logs to an external server
- Commands overview
- Appendix A. Appliance commands
- Appendix B. Manage commands
- Appendix C. Monitor commands
- Appendix D. Network commands
- Appendix E. Reports commands
- Appendix F. Settings commands
- Appendix G. Support commands
- 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/nbusers
path to the NetBackupbpcd allowed list
.Add the special directive commands to the
/home/nbusers
directory.
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