Veritas NetBackup™ Appliance Commands Reference Guide

Last Published:
Product(s): Appliances (3.1.1)
  1. Overview
    1.  
      About the NetBackup Appliance Shell Menu
    2. Logging on 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
    4.  
      Manage > NetBackupCLI > PasswordExpiry
  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 > LiveUpdateClients
    9.  
      Manage > Software > Readme
    10.  
      Manage > Software > Rollback
    11.  
      Manage > Software > Share
    12.  
      Manage > Software > UpgradeStatus
  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 (IPsec) commands
    1.  
      Network > IPsec > Configure
    2.  
      Network > IPsec > Delete
    3.  
      Network > IPsec > Export
    4.  
      Network > IPsec > Import
    5.  
      Network > IPsec > Provision
    6.  
      Network > IPsec > Refresh
    7.  
      Network > IPsec > Show
    8.  
      Network > IPsec > Unconfigure
  18. Appendix Q. Main > Reports commands
    1.  
      Reports > Deduplication
    2.  
      Reports > Process
  19. Appendix R. Main > Settings commands
    1.  
      Settings > Cloud
    2.  
      Settings > Deduplication
    3.  
      Settings > FibreTransport
    4.  
      Settings > iSCSI > Initiator
    5.  
      Settings > iSCSI > Interface
    6.  
      Settings > iSCSI > Target
    7.  
      Settings > LogForwarding
    8.  
      Settings > LifeCycle
    9.  
      Settings > LiveUpdateServer
    10.  
      Settings > NetBackup
    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 > ActiveDirectory
    3.  
      Settings > Security > Authentication > Kerberos
    4.  
      Settings > Security > Authentication > LDAP
    5.  
      Settings > Security > Authentication > LocalUser
    6.  
      Main > Settings > Security > STIG
    7.  
      Main > Settings > Security > FIPS
  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 > Show
    27.  
      Support > Shutdown
    28.  
      Support > Storage ClearReservations
    29.  
      Support > Storage Reset
    30.  
      Support > Storage SanityCheck
    31.  
      Support > Test

Name

Main > Settings > Alerts > SNMP — Add SNMP information on your appliance that enables the host to send SNMP notifications for monitoring.

SYNOPSIS

SNMP Disable

SNMP Enable

SNMP Set Server [Community] [Port]

SNMP Show

SNMP ShowMIB

DESCRIPTION

The NetBackup Appliance uses the SNMPv2-SMI application protocol to monitor the appliance. Use this command to add or change SNMP parameters on the server. You can use the following commands to display the current parameters and the changes that were made to the SNMP information. You can use this command to enable and disable SNMP notifications for appliance monitoring.

When you create and enable an SNMP community you enable appliance monitoring to occur on the appliance through the SNMP protocol. Notifications or traps are programmed to occur on the appliance. In addition, you can use this command to see the notification traps that have been configured for the appliance.

The following list is an example of the types of hardware notifications that are monitored through SNMP for the appliance:

  • CPU

  • Disk

  • Fan

  • Fibre Channel

  • Power Supply

  • RAID

  • Temperature

OPTIONS

SNMP Disable

Disables the ability to send SNMP notifications (traps) for monitoring.

SNMP Enable

Enable the ability to send SNMP notifications (traps) for monitoring.

SNMP Set Server [Community] [Port]

Add information about SNMP. Here, Server is the name of the SNMP server, [Community] is the SNMP community, and [Port] is the SNMP port.

Note:

The NetBackup Appliance supports all the SNMP servers in the market. However, the ManageEngine™ SNMP server and the HP OpenView SNMP server are tested and certified for version 2.6 and later.

SNMP Show

Displays the parameters that are set after you have run an SNMP Set Server command. If you run this command before you have run a SNMP Set Server command, then default values for [Community] and [Port] are displayed and no value is displayed for Server.

SNMP ShowMIB

Display the contents of the Management Information Base (MIB) file. This file contains the notification traps that are configured to monitor the appliance.

EXAMPLES

You can use either of the following methods to configure a public SNMP community on port 8080. The example uses the [Community] and [Port] options.

abc123.Alerts> SNMP Set pqr222.xyz.com public 8080
Successfully set SNMP manager

When you run the Settings> Alerts > SNMP ShowMIB command, an output similar to the following is displayed.

VERITAS-APPLIANCE-MONITORING-MIB DEFINITIONS ::= BEGIN
	 
	  IMPORTS 
	    DisplayString, mib-2 FROM RFC1213-MIB
	    enterprises, OBJECT-TYPE, NOTIFICATION-TYPE, MODULE-IDENTITY FROM SNMPv2-SMI;
	 
	  
	  applianceMonitoringMib MODULE-IDENTITY
	  LAST-UPDATED "2016083000Z"
	  ORGANIZATION "Veritas Technologies LLC"
	  CONTACT-INFO "500 East Middlefield Road
	                Mountain View, CA 94043 US
	                Subject: appliance.mib"
	  DESCRIPTION  "The MIB module for Veritas Appliance Monitoring"
	 
 	 REVISION     "201609060000Z"
 	 DESCRIPTION  "Changed symc strings to vrts."
	 
	  ::= { products 9 }
	  
	  veritassoftware          OBJECT IDENTIFIER ::= { enterprises 48328 }
	  products                  OBJECT IDENTIFIER ::= { veritassoftware 3 }
	 
	  systems                   OBJECT IDENTIFIER ::= { applianceMonitoringMib 1 }
	  software                  OBJECT IDENTIFIER ::= { applianceMonitoringMib 2 }
	  
	-- system traps 
	 
	  vrtssystemName OBJECT-TYPE
	    SYNTAX DisplayString (SIZE(0..80))
	    MAX-ACCESS read-only
	    STATUS current 
	    DESCRIPTION "System Name"
	  ::= { systems 1 }
	 
	  vrtsfanTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps fan failures"
	  ::= { systems 3 }
	 
	  vrtspowerTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps power failures"
	  ::= { systems 4 }
	 
	  vrtsfibrechannelTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps FibreChannel failures"
	  ::= { systems 5 }
	 
	  vrtstemperatureTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps temperature failures"
	  ::= { systems 6 }
	 
	  vrtscpuTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps cpu failures"
	  ::= { systems 7 }
	 
	  vrtsdiskTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps disk failures"
	  ::= { systems 8 }
	 
	  vrtsraidgroupTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps raid failures"
	  ::= { systems 9 }
	 
	 
	  vrtsenclosurefanTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps enclosure fan failures"
	  ::= { systems 10 }
	 
	  vrtsenclosurepowerTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps enclosure power failures"
	  ::= { systems 11 }
	 
	  vrtsenclosuretemperatureTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps enclosure temperature failures"
	  ::= { systems 12 }
	 
	  vrtsenclosurediskTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps enclosure disk failures"
	  ::= { systems 13 }
	 
	  vrtsadapterTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps adapter failures"
	  ::= { systems 14 }
	 
	  vrtsfirmwareTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps firmware failures"
	  ::= { systems 15 }
	  
	  vrtspciTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps pci failures"
	  ::= { systems 16 }
	  
	  vrtsnetworkcardTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps network card failures"
	  ::= { systems 17 }
	 
	  vrtsvolumeTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps volume failures"
	  ::= { systems 18 }
	 
	  vrtsbbuTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps BBU failures"
	  ::= { systems 19 }
	  
	  vrtsconnectionTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps connection failures"
	  ::= { systems 20 }
	 
	  vrtspartitionTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Partition alert traps"
	  ::= { systems 21 }
	 
	  vrtsstoragestatusTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps StorageArray HealthStatus failures"
	  ::= { systems 22 }
	  
	  vrtsdimmTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Traps Dimm failures"
	  ::= { systems 23 }
	 
	-- software traps
	 
	  vrtsfailedJobsTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Job failures Trap"
	  ::= { software 1 }
	 
	  vrtsprocessTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Processes stopped traps"
	  ::= { software 2 }
	 
	  vrtsdiskSpaceTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Low disk space traps"
	  ::= { software 3 }
	  
	  vrtssoftwareUpdateSuccessTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Software update success trap"
	  ::= { software 4 }
	  
	  vrtssoftwareUpdateFailedRollbackSuccessTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Software update failed but rollback was successful trap"
	  ::= { software 5 }
	  
	  vrtssoftwareUpdateFailedRollbackFailedTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Software update and rollback failed trap"
	  ::= { software 6 }
	  
	  vrtsrollbackSuccessTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Software rollback success trap"
	  ::= { software 7 }
	  
	  vrtsrollbackFailedTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Software rollback failed trap"
	  ::= { software 8 }
	  
	  vrtsclusterStateTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Cluster node failed trap"
	  ::= { software 9 }
	  
	  vrtsdiskPerfTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Disk performance alert trap"
	  ::= { software 10 }
	  
	  vrtscollectorserviceTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
	    DESCRIPTION "Collector plugin loading failed trap"
	  ::= { software 11 }
	  
	  vrtshaclusternameTrap NOTIFICATION-TYPE
	    OBJECTS { vrtssystemName }
	    STATUS current
 	    DESCRIPTION "HA cluster name trap"
	  ::= { software 12 }
	  
	END