Veritas NetBackup™ Appliance Commands Reference Guide

Last Published:
Product(s): Appliances (3.2)
Platform: NetBackup Appliance OS
  1. 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
      1.  
        About the commands under the Appliance view
      2.  
        About the commands under the Manage view
      3.  
        About the commands under the Monitor view
      4.  
        About the commands under the Network view
      5.  
        About the commands under the Reports view
      6.  
        About the commands under the Settings view
      7.  
        About the commands under the Support view
  2. Appendix A. Main > Appliance commands
    1.  
      Appliance > Master
    2.  
      Appliance > Media
    3.  
      Appliance > Management
    4.  
      Appliance > Remove
    5.  
      Appliance > ShowDedupPassword
    6.  
      Appliance > ShowIdentity
    7.  
      Appliance > Status
  3. 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
  4. Appendix C. Main > Manage > HighAvailability commands
    1.  
      Manage > HighAvailability > AddNode
    2.  
      Manage > HighAvailability > GetAssetTag
    3.  
      Manage > HighAvailability > RemoveNode
    4.  
      Manage > HighAvailability > Setup
    5.  
      Manage > HighAvailability > Status
    6.  
      Manage > HighAvailability > Switchover
  5. 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
  6. 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
  7. Appendix F. Main > Manage > License commands
    1.  
      Manage > License > Add
    2.  
      Manage > License > List
    3.  
      Manage > License > ListInfo
    4.  
      Manage > License > Remove
  8. Appendix G. Main > Manage > MountPoints commands
    1.  
      Manage > MountPoints > List
    2.  
      Manage > MountPoints > Mount
    3.  
      Manage > MountPoints > Unmount
  9. Appendix H. Main > Manage > NetBackup CLI commands
    1.  
      Manage > NetBackupCLI > Create
    2.  
      Manage > NetBackupCLI > Delete
    3.  
      Manage > NetBackupCLI > List
  10. 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
  11. Appendix J. Main > Manage > Software commands
    1.  
      Manage > Software > Cancel
    2.  
      Manage > Software > Delete
    3.  
      Manage > Software > Download
    4.  
      Manage > Software > DownloadProgress
    5.  
      Manage > Software > Firmware
    6.  
      Manage > Software > Install
    7.  
      Manage > Software > List
    8.  
      Manage > Software > Readme
    9.  
      Manage > Software > Rollback
    10.  
      Manage > Software > Share
    11.  
      Manage > Software > UpgradeStatus
    12.  
      Manage > Software > VxUpdate
  12. 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
    11.  
      Manage > Storage > Erase
  13. 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
  14. Appendix M. Main > Manage > Certificates commands
    1.  
      Manage > Certificates > Generate
    2.  
      Manage > Certificates > Delete
  15. Appendix N. Main > Monitor commands
    1.  
      Monitor > Beacon
    2.  
      Monitor > MemoryStatus
    3.  
      Monitor > NetBackup
    4.  
      Monitor > NetworkStatus
    5.  
      Monitor > SDCS
    6.  
      Monitor > Top
    7.  
      Monitor > Uptime
    8.  
      Monitor > Who
    9.  
      Monitor > Hardware
  16. Appendix O. 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
  17. Appendix P. Main > Network > Security commands (IPsec)
    1.  
      Network > Security > Configure
    2.  
      Network > Security > Delete
    3.  
      Network > Security > Export
    4.  
      Network > Security > Import
    5.  
      Network > Security > Provision
    6.  
      Network > Security > Refresh
    7.  
      Network > Security > Show
    8.  
      Network > Security > Unconfigure
  18. Appendix Q. Main > Reports commands
    1.  
      Reports > Deduplication
    2.  
      Reports > Process
  19. Appendix R. Main > Settings commands
    1.  
      Settings > Deduplication
    2.  
      Settings > FibreTransport
    3.  
      Settings > iSCSI > Initiator
    4.  
      Settings > iSCSI > Interface
    5.  
      Settings > iSCSI > Target
    6.  
      Settings > LogForwarding
    7.  
      Settings > LifeCycle
    8.  
      Settings > NetBackup
    9.  
      Settings > NetBackup DNAT
    10.  
      Settings > Password
    11.  
      Settings > Share
    12.  
      Settings > SNMP polling
    13.  
      Settings > Sysctl
    14.  
      Settings > SystemLocale
  20. Appendix S. Main > Settings > Alerts commands
    1.  
      Settings > Alerts > CallHome
    2.  
      Settings > Alerts > Email
    3.  
      Settings > Alerts > Hardware
    4.  
      Settings > Alerts > SNMP
  21. Appendix T. Main > Settings > Notifications view commands
    1.  
      Settings > Notifications > LoginBanner
  22. Appendix U. Main > Settings > Security commands
    1.  
      Settings > Security > Authorization
    2.  
      Settings > Security > Authentication > ActiveDirectory
    3.  
      Settings > Security > Authentication > Kerberos
    4.  
      Settings > Security > Authentication > LDAP
    5.  
      Settings > Security > Authentication > LocalUser
    6.  
      Main > Settings > Security > Certificate
    7.  
      Main > Settings > Security > FIPS
    8.  
      Main > Settings > Security > Ports
    9.  
      Main > Settings > Security > STIG
  23. Appendix V. Main > Support commands
    1.  
      Support > Checkpoint
    2.  
      Support > Cleanup > RemoveShelfEntries
    3.  
      Support > Cleanup > ResetDIMMErrors
    4.  
      Support > Collect
    5.  
      Support > DataCollect
    6.  
      Support > Disk
    7.  
      Support > Errors
    8.  
      Support > FactoryReset
    9.  
      Support > FibreTransport
    10.  
      Support > InfraServices
    11.  
      Support > iostat
    12.  
      Support > IPMI
    13.  
      Support > KillRemoteCall
    14.  
      Support > Logs
    15.  
      Support > Maintenance
    16.  
      Support > Messages
    17.  
      Support > NBDNA
    18.  
      Support > nbperfchk
    19.  
      Support > NBSU
    20.  
      Support > Processes
    21.  
      Support > RAID
    22.  
      Support > Reboot
    23.  
      Support > RecoverStorage
    24.  
      Support > Service
    25.  
      Support > ServiceAllowed
    26.  
      Support > ShelfOrdering
    27.  
      Support > Show
    28.  
      Support > Shutdown
    29.  
      Support > Storage ClearReservations
    30.  
      Support > Storage Reset
    31.  
      Support > Storage SanityCheck
    32.  
      Support > System
    33.  
      Support > Test

Name

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

SYNOPSIS

CallHome Disable

CallHome Enable

CallHome NBInventory Disable

CallHome NBInventory Enable

CallHome Proxy Add name port [username] [passwd]

CallHome Proxy Disable

CallHome Proxy DisableTunnel

CallHome Proxy Enable

CallHome Proxy EnableTunnel

CallHome Proxy Test

CallHome Registration Show

CallHome Show

CallHome Test

DESCRIPTION

The CallHome Registration Show command displays your appliance registration information and your contact information. The MyAppliance portal is the unified address where you register the appliance and edit registration details.

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 name port [username] [passwd]

Add a proxy server to the appliance. Here, name is the name of the proxy server that is either the TCP/IP address or the fully qualified name of the proxy server. Port is the proxy port number on the proxy server. The [username] is the name of the user for the proxy server authentication and [passwd] is the password for the proxy server authentication.

If you do not add "http(s):" at the start of the server name then by default http:// is added to it.

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 Proxy Test

In a high availability configuration, Call Home proxy settings on a node are synchronized automatically to the partner node. Log on to the partner node and run the command to verify that the synchronized settings work properly.

CallHome Registration Show

View registration details for the appliance and the link to the MyAppliance portal to register and edit contact information.

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 abc123.com 1234

Successfully set proxy server

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 the information that is displayed when you run the Settings > Alerts > CallHome Registration Show command.

Registration Information (Node: abc123.example.com)
+---------------------------------------------+
|   Contact Name   |John                      |
|------------------+--------------------------|
|     Email ID     |john@abc.com              |
|------------------+--------------------------|
|  Contact Number  |121                       |
|------------------+--------------------------|
|  Appliance Name  |abc123																				|
|------------------+--------------------------|
|   Company Name   |VTAS                      |
|------------------+--------------------------|
|Street Name/Number|436376                    |
|------------------+--------------------------|
|       City       |Mounttain Vi              |
|------------------+--------------------------|
|     Zip/Pin      |9999                      |
|------------------+--------------------------|
|      State       |CA                        |
|------------------+--------------------------|
|     Country      |USA                       |
+---------------------------------------------+

Note:

Browse to the MyApplliance portal at https://my.appliance.veritas.com to register your appliance and your contact information.

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