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

Name

Main > Settings > Alerts > CallHome — Manage CallHome settings.

SYNOPSIS

CallHome Diagnose

CallHome Disable

CallHome Enable

CallHome NBInventory Disable

CallHome NBInventory Enable

CallHome Proxy Add name port [username] [passwd]

CallHome Proxy ClearSettings

CallHome Proxy Disable

CallHome Proxy DisableTunnel

CallHome Proxy Enable

CallHome Proxy EnableTunnel

CallHome Show

CallHome Test

DESCRIPTION

You can use the CallHome Enable and CallHome Disable commands to instruct the appliance whether or not to send the appliance health status to Veritas Technical Support. Veritas uses the health status to automatically open Support cases to resolve problems faster. The functionality is enabled by default.

You can use the CallHome NBInventory Enable and CallHome NBInventory Disable commands to instruct the appliance whether or not to send installation deployment and product usage information to Veritas for use in the Product Improvement Program. The functionality is enabled by default.

In addition, you can use the CallHome Proxy command to specify proxy server information. If your appliance environment has a proxy server between the environment and external Internet access, you must enable the proxy settings on the appliance. The proxy settings include both a proxy server and a port. The proxy server must accept https connections from the Veritas Call Home server. This feature is disabled by default. To use this feature, the proxy server on your site must be able to handle https requests.

OPTIONS

CallHome Disable: Disable the Call Home feature. Disabling Call Home also disables the Product Improvement Program.

CallHome Enable: Enable the Call Home feature. Enabling the feature lets you send the health status of the appliance to Veritas Technical Support. In case of any failure, Veritas Technical Support uses this information to resolve the issue.

CallHome NBInventory Disable: Disable the Product Improvement Program. Disabling the program prevents Veritas from capturing installation deployment and product usage information from your appliance.

CallHome NBInventory Enable

Enable the Product Improvement Program. Enabling the program allows Veritas to capture installation deployment and product usage information. The information that Veritas receives becomes part of a continuous quality improvement program that helps Veritas understand how customers configure, deploy, and use the product.

You cannot enable the Product Improvement Program if Call Home is disabled.

CallHome Proxy Add

Add a proxy server to the appliance. Follow the prompts to provide the details, as follows:

Enter proxy server name:
Enter the name of the proxy server that is either the TCP/IP address or the fully qualified name of the proxy server.
Enter proxy port:
Enter the proxy port number on the proxy server.
Do you want to set credentials for proxy server?
Enter yes or no.
Enter proxy username:
Enter the name of the user for the proxy server authentication.
Enter proxy password:
Enter the password for the proxy server authentication.

By default, the HTTP protocol is used to communicate with the proxy server.

Note:

If you want to use the HTTPS protocol, ensure that you enter https:// before the proxy server name. To ensure successful communication with the proxy server, add the latest CA certificate used by the proxy server by running the Settings > Security > Certificate > AddCACertificate command.

CallHome Proxy ClearSettings: Clear the proxy server settings.

CallHome Proxy Disable: Disable the use of the proxy server settings.

CallHome Proxy DisableTunnel: Disable SSL tunneling for the proxy server.

CallHome Proxy Enable: Enable the use of the proxy server settings.

CallHome Proxy EnableTunnel: Enable SSL tunneling for the proxy server.

CallHome Show: View the Call Home and proxy settings that are currently configured for your appliance.

CallHome Test: Validate whether or not the appliance is able to send Call Home information to Veritas Technical Support.

EXAMPLES

The following example demonstrates how to add a proxy server to your appliance and the confirmation message that is returned.

Settings> Alerts> CallHome Proxy Add
Enter proxy server name: abc123.com
Enter proxy port: 1234
>> Do you want to set credentials for proxy server? (yes/no) yes
Enter proxy username: username
Enter proxy password: *******

The following example demonstrates how to disable the Call Home proxy server and the confirmation message that is returned.

Settings> Alerts> CallHome Proxy Disable

Successfully disabled proxy

The following example demonstrates how to disable SSL tunneling for the Call Home proxy server and the confirmation message that is returned.

Settings>  Alerts> CallHome Proxy DisableTunnel
- [Info] Successfully added proxy tunnel flag
Successfully set proxy tunneling

The following example demonstrates how to add a proxy server to your appliance and the confirmation message that is returned.

Settings> Alerts> CallHome Proxy Enable

Proxy enabled successfully

The following example demonstrates how to enable SSL tunneling for the Call Home proxy server and the confirmation message that is returned.

Settings>  Alerts> CallHome Proxy EnableTunnel
- [Info] Successfully added proxy tunnel flag
Successfully set proxy tunneling

The following is an example of information that is displayed when you run the Settings > Alerts > CallHome Show command.

abc123.Alerts> CallHome Show
CallHome and Proxy Settings
+-----------------------------------------+
| CallHome State  |Disabled               |
|-----------------+-----------------------|
|NBINventory State|Disabled               |
|-----------------+-----------------------|
|   Proxy State   |Disabled               |
|-----------------+-----------------------|
|   Tunnelling    |Enabled                |
|-----------------+-----------------------|
|  Proxy Server   |http://eng.veritas.com |
|-----------------+-----------------------|
|   Proxy Port    |443                    |
|-----------------+-----------------------|
| Proxy UserName  |admin                  |
+-----------------------------------------+

Note:

NBInventory refers to the NetBackup Product Improvement Program.