Veritas NetBackup™ Appliance Commands Reference Guide

Last Published:
Product(s): Appliances (3.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
  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 > Security > Authorization — authorize users to access the appliance by assigning them various roles (permissions).

SYNOPSIS

Grant

List

Revoke

SyncGroupMembers

DESCRIPTION

The Authorization commands let you manage permissions for appliance users and user groups. The users include local users, LDAP users, Active Directory (AD) users, and NIS users. The user groups include LDAP user groups, AD user groups, and NIS user groups.

You can use the Authorization commands to do the following:

  • Grant access privileges to the users and user groups that have been added to the appliance.

  • List all of the users and user groups that have been added to the appliance, along with their designated permissions.

  • Revoke access privileges from the users and user groups that have been added to the appliance.

OPTIONS

Grant Administrator Group groups

Grant the Administrator role to a user group. Here, groups is a comma-separated list of registered user groups that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Grant Administrator Users users

Grant the Administrator role to a user. Here, users is a comma-separated list of local users, or registered users that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Grant AMS Group groups

Grant the AMS role to a user group. Here, groups is a comma-separated list of registered user groups that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Grant AMS Users users

Grant the AMS role to a user. Here, users is a comma-separated list of local users, or registered users that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Grant NetBackupCLI Group groups

Grant the NetBackupCLI role to a user group. Here, groups is a comma-separated list of registered user groups that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Grant NetBackupCLI Users users

Grant the NetBackupCLI role to a user. Here, users is a comma-separated list of registered users that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Note:

You cannot grant the NetBackupCLI role to an existing local user. However, you can create a local NetBackupCLI user by using the Main_Menu > Manage > NetBackupCLI > Create command from the NetBackup Appliance Shell Menu.

Note:

NetBackupCLI users are solely restricted to run the NetBackup CLI and do not have access outside the scope of NetBackup software directories. Once these users log in, they are provided restricted access to the shell menu for managing NetBackup. These users do not have access to NetBackup Appliance Web Console or the other menus of the shell menu.

List

List all of the users and user groups that have been added to the appliance, along with their designated roles. The users include local users, or the registered users that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS). The user groups include those that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Revoke Administrator Group groups

Revoke the Administrator role from a user group. Here, groups is a comma-separated list of registered user groups that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Revoke Administrator Users users

Revoke the Administrator role from a user. Here, users is a comma-separated list of local users, or registered users that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Revoke AMS Group groups

Revoke the AMS role from a user group. Here, groups is a comma-separated list of registered user groups that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Revoke AMS Users users

Revoke the AMS role from a user. Here, users is a comma-separated list of local users, or registered users that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Revoke NetBackupCLI Group groups

Revoke the NetBackupCLI role from a user group. Here, groups is a comma-separated list of registered user groups that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

Revoke NetBackupCLI Users users

Revoke the NetBackupCLI role from a user. Here, users is a comma-separated list of local users, or registered users that have been added to the appliance from a configured remote directory service (such as LDAP, AD, or NIS).

SyncGroupMembers AddTask HHMM

Use this command to add a daily task that is synchronized for registered groups. Here, HHMM is the time of the day in hours and minutes.

SyncGroupMembers DeleteTask

Delete the daily tasks that are synchronized for registered groups.

SyncGroupMembers Now

Force synchronization for registered groups now.

SyncGroupMembers ShowTask

View the daily tasks that are synchronized for registered groups.