Search <book_title>...

Veritas NetBackup™ Appliance Commands Reference Guide

Last Published: 2023-11-27

Product(s): Appliances (5.3)

Platform: NetBackup Appliance OS

Overview
1. About the NetBackup Appliance Shell Menu
2. Logging in to the NetBackup Appliance Shell Menu
  1. Command limitations on appliances that are not configured
3. Using the NetBackup Appliance Shell Menu
4. About the NetBackup Appliance Shell Menu command views
Appendix A. Main > Appliance commands
1. Appliance > Primary
2. Appliance > Media
3. Appliance > Management
4. Appliance > Remove
5. Appliance > ShowDedupPassword
6. Appliance > ShowIdentity
7. Appliance > Status
Appendix B. Main > Manage > FibreChannel commands
1. Manage > FibreChannel > Clean
2. Manage > FibreChannel > Configure
3. Manage > FibreChannel > Reset
4. Manage > FibreChannel > Scan
5. Manage > FibreChannel > Show
6. Manage > FibreChannel > Statistics
Appendix C. Main > Manage > HighAvailability commands
1. Manage > HighAvailability > AddNode
2. Manage > HighAvailability > AutoFix
3. Manage > HighAvailability > GetAssetTag
4. Manage > HighAvailability > RemoveNode
5. Manage > HighAvailability > Setup
6. Manage > HighAvailability > Status
7. Manage > HighAvailability > Switchover
Appendix D. Main > Manage > Libraries commands
1. Manage > Libraries > Configure
2. Manage > Libraries > Deny
3. Manage > Libraries > Down
4. Manage > Libraries > Inventory
5. Manage > Libraries > List
6. Manage > Libraries > Requests
7. Manage > Libraries > Reset
8. Manage > Libraries > Resubmit
9. Manage > Libraries > Up
Appendix E. Main > Manage > Libraries > Advanced > ACS commands
1. Manage > Libraries > Advanced > ACS > ACS_CSI_HOSTPORT
2. Manage > Libraries > Advanced > ACS > ACS_SEL_SOCKET
3. Manage > Libraries > Advanced > ACS > ACS_SSI_HOSTNAME
4. Manage > Libraries > Advanced > ACS > ACS_SSI_INET_PORT
5. Manage > Libraries > Advanced > ACS > ACS_SSI_SOCKET
6. Manage > Libraries > Advanced > ACS > ACS_TCP_RPCSERVICE
7. Manage > Libraries > Advanced > ACS > ACS_UDP_RPCSERVICE
8. Manage > Libraries > Advanced > ACS > API_BARCODE_RULES
9. Manage > Libraries > Advanced > ACS > TestACS
10. Manage > Libraries > Advanced > ACS > ViewVMconf
Appendix F. Main > Manage > License commands
1. Manage > License
Appendix G. Main > Manage > MountPoints commands
1. Manage > MountPoints > List
2. Manage > MountPoints > Mount
3. Manage > MountPoints > Unmount
Appendix H. Main > Manage > NetBackup CLI commands
1. Manage > NetBackupCLI > AllowSelfService
2. Manage > NetBackupCLI > Create
3. Manage > NetBackupCLI > Delete
4. Manage > NetBackupCLI > List
Appendix I. Main > Manage > OpenStorage commands
1. Manage > OpenStorage > Install
2. Manage > OpenStorage > List
3. Manage > OpenStorage > Readme
4. Manage > OpenStorage > Share
5. Manage > OpenStorage > Uninstall
Appendix J. Main > Manage > Software commands
1. Manage > Software > Cancel
2. Manage > Software > Delete
3. Manage > Software > Download
4. Manage > Software > DownloadAnalyzer
5. Manage > Software > DownloadProgress
6. Manage > Software > Firmware
7. Manage > Software > Install
8. Manage > Software > List
9. Manage > Software > Readme
10. Manage > Software > Rollback
11. Manage > Software > Share
12. Manage > Software > UpgradeReadinessCheck
13. Manage > Software > UpgradeStatus
14. Manage > Software > VxUpdate
Appendix K. Main > Manage > Storage commands
1. Manage > Storage > Add
2. Manage > Storage > Create
3. Manage > Storage > Delete
4. Manage > Storage > Edit
5. Manage > Storage > Monitor
6. Manage > Storage > Move
7. Manage > Storage > Remove
8. Manage > Storage > Resize
9. Manage > Storage > Scan
10. Manage > Storage > Show
Appendix L. Main > Manage > Tapes commands
1. Manage > Tapes > Cleaning
2. Manage > Tapes > Delete
3. Manage > Tapes > Eject
4. Manage > Tapes > Freeze
5. Manage > Tapes > Inventory
6. Manage > Tapes > List
7. Manage > Tapes > ListNetBackupMedia
8. Manage > Tapes > Suspend
9. Manage > Tapes > Unfreeze
10. Manage > Tapes > Unsuspend
Appendix M. Main > Monitor commands
1. Monitor > Beacon
2. Monitor > Hardware
3. Monitor > MemoryStatus
4. Monitor > NetBackup
5. Monitor > NetworkStatus
6. Monitor > SDCS
7. Monitor > Top
8. Monitor > Uptime
9. Monitor > Who
Appendix N. Main > 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 > VLAN
19. Network > WANOptimization
Appendix O. Main > Network > Security commands (DeviceCert)
1. Network > Security > Export
2. Network > Security > Import
Appendix P. Main > Reports commands
1. Reports > Deduplication
2. Reports > Process
Appendix Q. Main > Settings commands
1. Settings > Deduplication
2. Settings > FibreTransport
3. Settings > iSCSI > Initiator
4. Settings > iSCSI > Interface
5. Settings > iSCSI > Target
6. Settings > LifeCycle
7. Settings > LogForwarding
8. Settings > NetBackup
9. Settings > NetBackup DNAT
10. Settings > NetBackup NATServers
11. Settings > Password
12. Settings > Share
13. Settings > SNMP
14. Settings > Sysctl
15. Settings > SystemLocale
Appendix R. Main > Settings > Alerts commands
1. Settings > Alerts > CallHome
2. Settings > Alerts > Email
3. Settings > Alerts > Hardware
4. Settings > Alerts > SNMP
5. Settings > Alerts > Transmission
Appendix S. Main > Settings > Notifications view commands
1. Settings > Notifications > LoginBanner
Appendix T. Main > Settings > Security commands
1. Settings > Security > Antimalware
2. Settings > Security > Authorization
3. Settings > Security > Authentication > AccountStatus
4. Settings > Security > Authentication > ActiveDirectory
5. Main > Settings > Security > Authentication > CIFSShare
6. Settings > Security > Authentication > LDAP
7. Settings > Security > Authentication > LocalUser
8. Settings > Security > Authentication > MFA
9. Settings > Security > Authentication > SingleSignOn
10. Settings > Security > Authentication > SmartCard > SSH
11. Settings > Security > Authentication > SmartCard
12. Main > Settings > Security > Certificate
13. Main > Settings > Security > Certificate > CertificateSigningRequest
14. Main > Settings > Security > FIPS
15. Settings > Security > NetworkAccessControl
16. Main > Settings > Security > PasswordAge
17. Main > Settings > Security > Ports
18. Main > Settings > Security > SecurityLevel
19. Main > Settings > Security > Sessions
20. Main > Settings > Security > STIG
Appendix U. Main > Support commands
1. Support > Checkpoint
2. Support > Cleanup > CleanMonInvData
3. Support > Cleanup > RemoveShelfEntries
4. Support > Cleanup > ResetDIMMErrors
5. Support > Collect
6. Support > DataCollect
7. Support > Disk
8. Support > Errors
9. Support > FactoryReset
10. Support > FibreTransport
11. Support > ImportISO
12. Support > InfraServices
13. Support > InstantAccess
14. Support > iostat
15. Support > IPMI
16. Support > KillRemoteCall
17. Support > LogBrowser
18. Support > Logs
19. Support > Maintenance
20. Support > Messages
21. Support > NBDNA
22. Support > Nbperfchk
23. Support > NBSU
24. Support > Processes
25. Support > RAID
26. Support > Reboot
27. Support > RecoverStorage
28. Support > Service
29. Support > ShelfOrdering
30. Support > SHMCLI
31. Support > Show
32. Support > Shutdown
33. Support > Storage ClearReservations
34. Support > Storage SanityCheck
35. Support > Storage Show
36. Support > System
37. Support > Test

About the commands under the Manage view

From the appliance management view, Manage, you can perform the following functions:

Administer the Fibre Transport HBA cards.
Manage a high availability (HA) configuration.
Note:
NetBackup Appliance models 5240 and 5250 do not support HA.
Configure and inventory robotic tape libraries.
Add, remove, and list license keys.
Manage software updates.
List and resize Storage Disk Pool Volumes of NetBackup.
Manage the tape media for the appliance.
Manage NetBackupCLI user accounts.
Manage OpenStorage plugins.
Manage remote mount points.

The following table summarizes the commands that are available in the Main > Manage view.

Table: Main > Manage view commands

Commands	Explanation
FibreChannel	Enter the FibreChannel view to administer the Fibre Transport HBA cards. You can perform the following administrative functions: Clean - Clean stale SCSI information about unresponsive Fibre Channel devices from the system. See Manage > FibreChannel > Clean. Configure - Configure supported FC HBA cards. See Manage > FibreChannel > Configure. Reset - Reset Fibre Channel initiator ports on this appliance. See Manage > FibreChannel > Reset. Scan - Scan the Fibre Channel HBA initiator ports on this appliance. See Manage > FibreChannel > Scan. Show - Show the Fibre Channel cards in this appliance and configuration. See Manage > FibreChannel > Show. Statistics - Display utilization statistics for the Fibre Channel HBA initiator ports on this appliance. See Manage > FibreChannel > Statistics.
HighAvailability	Use these command options to configure or manage a high availability setup. From the HighAvailability view you can do the following: AddNode - Add a new compute node to the high availability setup. See Manage > HighAvailability > AddNode . AutoFix See Manage > HighAvailability > AutoFix. GetAssetTag - Display the status and the values of the asset tags on the hardware components in a high availability setup. See Manage > HighAvailability > GetAssetTag. RemoveNode - Remove a node from the high availability setup. See Manage > HighAvailability > RemoveNode. Setup - Perform a pre-check and configure the high availability setup. See Manage > HighAvailability > Setup. Status - Display the high availability setup and the status of all related services. See Manage > HighAvailability > Status. Switchover - Switch the services between the two nodes. See Manage > HighAvailability > Switchover. Note: These commands can only be used on appliance model 53xx media servers. Appliance model 52xx primary or media servers cannot be used to run these commands.
Libraries	Enter the NetBackup Library view. From the Libraries view you can configure and inventory robotic tape libraries. You can also perform the following functions: Advanced > ACS - Configure or edit the ACSLS network configuration entries in the `vm.conf` file. Configure - Configure attached libraries for a media server. See Manage > Libraries > Configure . Deny - Deny a pending tape request. See Manage > Libraries > Deny . Down - Take drive offline. See Manage > Libraries > Down . Inventory - Inventory libraries for volumes. See Manage > Libraries > Inventory . List - List the attached libraries and tape drives for a media server. See Manage > Libraries > List . Requests - List any pending tape requests. See Manage > Libraries > Requests . Reset - Reset a drive. See Manage > Libraries > Reset . Resubmit - Resubmit a pending tape request. See Manage > Libraries > Resubmit . Up - Bring a drive online. See Manage > Libraries > Up .
License	Enter the License administration view where you can add, list, and remove appliance license keys on 5250 and 5350 appliances. License keys are not required for 5240 and 5340 appliances. License > Appliance - Appliance license administration Add - Add an appliance license key. List - List the currently installed appliance licenses. ListInfo - List the detailed information of the installed appliance licenses. Remove - Remove an appliance license key. See Manage > License.
MountPoints	Enter the MountPoints view. List - List existing mount points on the appliance. See Manage > MountPoints > List. Mount - Mount a remote NFS drive. See Manage > MountPoints > Mount. Unmount - Unmount a mounted NFS drive See Manage > MountPoints > Unmount.
NetBackupCLI	Enter the NetBackupCLI view. AllowSelfService - Configure a NetBackupCLI user to access NetBackup SelfService on the appliance. See Manage > NetBackupCLI > AllowSelfService. Create - Create a NetBackup user account. See Manage > NetBackupCLI > Create. Delete - Delete a NetBackup user account. See Manage > NetBackupCLI > Delete. List - View a list of NetBackup users. See Manage > NetBackupCLI > List.
OpenStorage	Install - Install an OpenStorage plug-in. See Manage > OpenStorage > Install. List - View list of available or installed OpenStorage plug-ins. See Manage > OpenStorage > List. Readme - Instructions to install OpenStorage plugins. See Manage > OpenStorage > Readme. Share - Share or unshare directory for uploading a plug-in See Manage > OpenStorage > Share. Uninstall - Uninstall the OpenStorage plug-in. See Manage > OpenStorage > Uninstall.
Software	Enter the Software view. From this view you can do the following: Cancel - Cancel the download of a software patch. See Manage > Software > Cancel. Delete - Delete a software update. See Manage > Software > Delete. Download - Download a software update. See Manage > Software > Download. DownloadAnalyzer - Download the latest version of the Appliance Upgrade Readiness Analyzer tool. See Manage > Software > DownloadAnalyzer. DownloadProgress - View the progress of an online patch download. See Manage > Software > DownloadProgress. Install - Install a release update. See Manage > Software > Install . List - List the available software information. See Manage > Software > List . Readme - View the Readme to obtain the event sequence for installing a release update. See Manage > Software > Readme . Rollback - Roll back the last installed release update. See Manage > Software > Rollback . Share - Share or unshare a directory for uploading a software update. See Manage > Software > Share . UpgradeReadinessCheck - Check the upgrade readiness status for the appliance. See Manage > Software > UpgradeReadinessCheck. UpgradeStatus - View the version of your appliance. See Manage > Software > UpgradeStatus.
Storage	Enter the Storage view. From this view you can do the following: Add - Add new storage expansion unit. See Manage > Storage > Add. Create - Create a share. See Manage > Storage > Create. Delete - Delete a share. See Manage > Storage > Delete. Edit - Edit a share. See Manage > Storage > Edit. Monitor - Monitor storage tasks. See Manage > Storage > Monitor. Move - Move storage partition from one device to another. See Manage > Storage > Move. Remove - Remove a storage expansion unit. See Manage > Storage > Remove. Resize - Resize NetBackup storage partitions. See Manage > Storage > Resize. Scan - Refresh the storage disks and devices information. See Manage > Storage > Scan. Show - View NetBackup storage information. See Manage > Storage > Show .
Tapes	Enter the Tapes view. The Tapes view contains the following commands that enable you administer the media that is configured to your appliance: Cleaning - Designate which tape is the cleaning tape See Manage > Tapes > Cleaning . Delete - Delete media from a NetBackup database See Manage > Tapes > Delete . Eject - Eject media from a tape library See Manage > Tapes > Eject . Freeze - Freeze media in a NetBackup database See Manage > Tapes > Freeze . Inventory - Inventory all of the libraries for the volumes that have been added or removed See Manage > Tapes > Inventory . List - Show a list of the available media See Manage > Tapes > List . ListNetBackupMedia - Show a list of the media that NetBackup uses See Manage > Tapes > ListNetBackupMedia . Suspend - Suspend media in a NetBackup database See Manage > Tapes > Suspend . Unfreeze - Unfreeze the media that has been frozen in a NetBackup database See Manage > Tapes > Unfreeze . Unsuspend - Unsuspend the media that has been suspended in a NetBackup database See Manage > Tapes > Unsuspend .