Veritas NetBackup™ Appliance Commands Reference Guide

Last Published:
Product(s): Appliances (5.3)
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 > AutoFix
    3.  
      Manage > HighAvailability > GetAssetTag
    4.  
      Manage > HighAvailability > RemoveNode
    5.  
      Manage > HighAvailability > Setup
    6.  
      Manage > HighAvailability > Status
    7.  
      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
  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 > AllowSelfService
    2.  
      Manage > NetBackupCLI > Create
    3.  
      Manage > NetBackupCLI > Delete
    4.  
      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 > UpgradeReadinessCheck
    13.  
      Manage > Software > UpgradeStatus
    14.  
      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
  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 > 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
  15. 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
  16. Appendix O. Main > Network > Security commands (DeviceCert)
    1.  
      Network > Security > Export
    2.  
      Network > Security > Import
  17. Appendix P. Main > Reports commands
    1.  
      Reports > Deduplication
    2.  
      Reports > Process
  18. 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
  19. 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
  20. Appendix S. Main > Settings > Notifications view commands
    1.  
      Settings > Notifications > LoginBanner
  21. 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
  22. 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

Using the NetBackup Appliance Shell Menu

This section details the use, options, and organization of the NetBackup Appliance Shell Menu.

The initial view outlines the various categories of tasks you can perform from the command-line interface.

All the commands are auto-completed. You can press Tab or Enter to complete a command.

The following is a list of helpful tips on how to use the NetBackup Appliance Shell Menu:

  • When you press the ? key, more information about the commands or sub-views is displayed. If you press ? after you enter a command, the format and usage of the parameters for that command is displayed.

  • When you press the space bar key, the next parameter that needs to be entered is displayed.

  • When you press the Enter key, the next "mandatory" parameter that needs to be entered is displayed. A "mandatory" parameter is one that does not have default values.

    Note:

    In the documentation, command variables that are italicised or in angular barackets (<>) are mandatory variables; whereas command parameters that are in square brackets ([]) are optional. For example, in the Main > Manage > MountPoints > Unmount <MountPoint> [Force] command, where MountPoint is a mandatory variable and [Force] is an optional parameter.

  • The Secure Shell(SSH) sessions have a limited idle time due to security limits on the Red Hat Enterprise Linux (RHEL) Operating System. You may experience the following issues:

    • You are logged out automatically if the SSH session remains idle up to the current session time limit.

    • Commands fail to complete if they require more time than the current session time limit. One example where you may experience this issue is when you add a large number of LDAP or AD users and user groups.

    To help avoid these issues, keep the session alive for a longer duration by increasing the session time limit in the SSH client. For detailed configuration instructions, refer to your SSH client documentation.