Search <book_title>...

Veritas NetBackup™ Appliance Commands Reference Guide

Last Published: 2021-07-19

Product(s): Appliances (4.1)

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 > GetAssetTag
3. Manage > HighAvailability > RemoveNode
4. Manage > HighAvailability > Setup
5. Manage > HighAvailability > Status
6. 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 > Add
2. Manage > License > List
3. Manage > License > ListInfo
4. Manage > License > Remove
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 > Create
2. Manage > NetBackupCLI > Delete
3. 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 > UpgradeStatus
13. 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
11. Manage > Storage > Erase
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 > Manage > Certificates commands
1. Manage > Certificates > Generate
2. Manage > Certificates > Delete
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
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
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
Appendix Q. Main > Reports commands
1. Reports > Deduplication
2. Reports > Process
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
Appendix S. Main > Settings > Alerts commands
1. Settings > Alerts > CallHome
2. Settings > Alerts > Email
3. Settings > Alerts > Hardware
4. Settings > Alerts > SNMP
Appendix T. Main > Settings > Notifications view commands
1. Settings > Notifications > LoginBanner
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
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 > Settings > Alerts > SNMP — Add SNMP information on your appliance that enables the host to send SNMP notifications for monitoring.

SYNOPSIS

SNMP Clear

SNMP Disable

SNMP Enable

SNMP Set Server [Community] [Port]

SNMP Show

SNMP ShowMIB

DESCRIPTION

The NetBackup appliance uses the SNMPv2-SMI or SNMPv3-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 Clear: Clears all of the previously stored SNMP settings.

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

SNMP Enable [version]

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

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

SNMP Set Community Server [Port] Security

Community

Sets the SNMP Community string. The default setting is public. This setting is required for SNMP V2, and is optional for SNMP V3.

Server [Port]

Sets the SNMP server name and the port assignment. The default setting is 162.

Note:

NetBackup appliance supports all of the SNMP servers in the market. However, the ManageEngine™ SNMP server and the HP OpenView SNMP server are tested and certified.

Security

Lets you configure the following security parameters when SNMP version 3 is enabled:

noAuthNoPriv [Username]
Sets the security level to no authentication and no privileges for a specific SNMP user.
AuthNoPriv [Username] [Authentication Protocol] [Authentication Password]
Sets the security level to authentication with no privileges for a specific SNMP user. Authentication Protocol can be set to SHA256 or SHA512. An Authentication Password is required.
AuthPriv [Username] [Authentication Protocol] [Encryption Policy] [Authentication Password] [Encryption Passphrase]
Sets the security level to authentication with privileges for a specific SNMP user. Authentication Protocol can be set to SHA256 or SHA512. Encryption Policy can be set to AES128, AES192, or AES256. An Authentication Password and an Encryption Passphrase are required.
Rules for Username, Authentication Password, and Encryption Passphrase:
- Username can have 1-32 characters.
  Authentication Password and Encryption Passphrase must have 8 or more characters.
- Username, passwords, and passphrases may include uppercase letters, lowercase letters, numbers, and the following punctuation marks: period, hyphen/dash, underscore.
- Spaces, commas, and special characters are not allowed.

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