Veritas NetBackup™ Appliance Commands Reference Guide

Last Published:
Product(s): Appliances (4.1)
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 > Primary
    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 > 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 > UpgradeStatus
    13.  
      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 > NetBackup NATServers
    11.  
      Settings > Password
    12.  
      Settings > Share
    13.  
      Settings > SNMP polling
    14.  
      Settings > Sysctl
    15.  
      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 > AccountStatus
    3.  
      Settings > Security > Authentication > ActiveDirectory
    4.  
      Main > Settings > Security > Authentication > CIFSShare
    5.  
      Settings > Security > Authentication > Kerberos
    6.  
      Settings > Security > Authentication > LDAP
    7.  
      Settings > Security > Authentication > LocalUser
    8.  
      Main > Settings > Security > Certificate
    9.  
      Main > Settings > Security > Certificate > CertificateSigningRequest
    10.  
      Main > Settings > Security > FIPS
    11.  
      Main > Settings > Security > Ports
    12.  
      Main > Settings > Security > STIG
    13.  
      Main > Settings > Security > SecurityLevel
  23. Appendix V. 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 > InfraServices
    12.  
      Support > InstantAccess
    13.  
      Support > iostat
    14.  
      Support > IPMI
    15.  
      Support > KillRemoteCall
    16.  
      Support > LogBrowser
    17.  
      Support > Logs
    18.  
      Support > Maintenance
    19.  
      Support > Messages
    20.  
      Support > NBDNA
    21.  
      Support > nbperfchk
    22.  
      Support > NBSU
    23.  
      Support > Processes
    24.  
      Support > RAID
    25.  
      Support > Reboot
    26.  
      Support > RecoverStorage
    27.  
      Support > Service
    28.  
      Support > ServiceAllowed
    29.  
      Support > ShelfOrdering
    30.  
      Support > Show
    31.  
      Support > Shutdown
    32.  
      Support > Storage ClearReservations
    33.  
      Support > Storage Reset
    34.  
      Support > Storage SanityCheck
    35.  
      Support > System
    36.  
      Support > Test

Name

Main > Monitor > Hardware — View the various hardware components, view the errors and the health status.

SYNOPSIS

Hardware ShowErrors

Hardware ShowComponents

Hardware ShowHealth Appliance [Item]

Hardware ShowHealth StorageShelf [Item]

Hardware ShowHealth PrimaryShelf [Item]

Hardware ShowHealth ExpansionShelf [ExpansionShelfID] [Item]

DESCRIPTION

Use this command to do the following:

  • Display the hardware components such as the appliance or the compute node, or the storage shelves. The items that are associated with these components also display.

  • View the errors that are related to the hardware components of an appliance. You can use this information to notify Veritas Technical Support of the errors.

  • View the performance and status of various hardware components of the appliance and the attached storage.

OPTIONS

Hardware ShowComponents

Display all the hardware components and items of an appliance.

Hardware ShowErrors

Display all the errors that are related to hardware status.

Hardware ShowHealth Appliance [Item]

View the performance and status of various hardware components of the appliance. The [Item] parameter specifies the hardware part for which the data is queried.

The following options are available for the [Item] parameter. The default value is ALL.

For 5230 and 5240 appliances:

(All/Fan/CPU/Disk/Fibrechannel/RAID/Power/Temperature/Product/
PCI/Network/Firmware/Adapter/Partition/MSDP/MSDPCloud/DIMM/
StorageConnections) [all]

Note:

The StorageConnections option uses a different plugin that makes it non-compatible for a 5230 appliance. Attempting to run this option on a 5230 results in an error message.

For a 5250 appliance:

(All/Fan/CPU/Disk/Fibrechannel/RAID/Power/Temperature/Product/
PCI/Network/Adapter/Partition/MSDP/DIMM/Mini_SSD)[all]

For a 5330 appliance:

(All/Fan/CPU/Disk/Fibrechannel/RAID/Power/Temperature/Product/
PCI/Network/Firmware/Connection/StorageStatus/Partition/DIMM) [all]

For 5340 and 5350 appliances:

(All/Fan/CPU/CMOSBattery/Disk/Fibrechannel/RAID/Power/Temperature/
Product/PCI/Network/Firmware/Partition/MSDP/Connection/
StorageStatus/DIMM/DIMMPopulation/Certificate/Adapter [all]

For example, to view the serial number of the appliance, run the following command:

Hardware ShowHealth Appliance Product

Hardware ShowHealth StorageShelf [Item]

View the performance and status of various hardware components of the storage shelf that is attached to a 52xx appliance. The [Item] parameter specifies the hardware part for which the data is queried.

The following options are available for the [Item] parameter. The default value is ALL.

(All/Fan/Disk/Power/Temperature/Product) [all]
Hardware ShowHealth PrimaryShelf [Item]

View the performance and status of the primary storage shelf of the NetBackup 53xx Appliance.

The following options are available for the [Item] parameter. The default value is ALL.

(All/Fan/Disk/RAID/Power/Temperature/Product/Firmware/BBU/
Controller/Volume/Connection) [all]
Hardware ShowHealth ExpansionShelf [ExpansionShelfID] [Item]

View the performance and status of the expansion storage shelf(shelves) of the NetBackup 53xx Appliance.

Where [ExpansionShelfID] is the ID of a specific expansion shelf. By default, the data is displayed for all the storage shelves. To check the expansion shelf IDs, use the Main > Monitor > Hardware ShowComponents command.

The following options are available for the [Item] parameter. The default value is ALL.

(All/Fan/Disk/Power/Temperature/Product) [all]

For example, to view the status of fan on the expansion storage shelf with an ID of 1, run the following command:

Hardware ShowHealth ExpansionShelf 1 FAN

ShowHealth Appliance Partition ExportCSV

Export the status of all the partitions on an appliance. Follow the instructions on the shell menu to find the CSV file for more details.

EXAMPLES

The following is an example output of the Monitor > Hardware ShowHealth Appliance Product command.

abc123.Monitor> Hardware ShowHealth Appliance Product
Compute Node abc123.company.com

Time Monitoring Ran: Tue Jul 19 2016 02:29:15 PDT 

+-----------------------------------------------------+
|            Hardware monitor information             |
|+----------------+--------------+------------------+ |
|| Name           | Manufacturer | Serial           | |
|+----------------+--------------+------------------+ |
|| NetBackup 52xx | Veritas      | abc123serialno   | |
|+----------------+--------------+------------------+ |
|                                                     |
+-----------------------------------------------------+

The following is an example output of the Main > Monitor > Hardware ShowHealth ExpansionShelf 1 Fan command:

Node abc122

Time Monitoring Ran: Thu Mar 27 2014 07:20:43

Compute node does not have any errors.

+------------------------------------------------------------+
|        Expansion Storage Shelf 1 Fan Information           |
|+----------------------------------------------------------+|
||ID|  Location  |   Status   |  State  |    Acknowledge    ||
||--+------------+------------+---------+-------------------||
||1 |Tray 1 Right|Optimal     |OK       |N/A                ||
||--+------------+------------+---------+-------------------||
||2 |Tray 1 Left |Optimal     |OK       |N/A                ||
||--+------------+------------+---------+-------------------||
||3 |Tray 1 Right|Optimal     |OK       |N/A                ||
||--+------------+------------+---------+-------------------||
||4 |Tray 1 Left |Optimal     |OK       |N/A                ||
|+----------------------------------------------------------+|
+------------------------------------------------------------+