Veritas NetBackup™ Appliance Commands Reference Guide

Last Published:
Product(s): Appliances (3.1.2)
Platform: 5220,5230,5240,5330,5340
  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 > Ports
    7.  
      Main > Settings > Security > STIG
    8.  
      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 > Security > Authentication > LDAP — configure and manage Lightweight Directory Access Protocol (LDAP) user registration and authentication on the appliance.

SYNOPSIS

Attribute

Certificate

ConfigParam

Configure

Disable

Enable

Export

Groups

Import

List

Map

Show

Status

Unconfigure

Users

DESCRIPTION

You can use the LDAP command to perform the following tasks:

  • Add or delete LDAP configuration attributes.

  • Set or show the trusted LDAP server certificate.

  • Set, unset, or show the various LDAP configuration parameters.

  • Configure the appliance for LDAP user authentication.

  • Disable LDAP user authentication.

  • Enable LDAP user authentication.

  • Export LDAP configuration as an XML file.

  • Add or remove one or more LDAP user groups.

  • Import LDAP configuration from an XML file.

  • List all LDAP users and user groups.

  • Add, delete, or show NSS map attributes or object classes.

  • Show the LDAP configuration.

  • Show the status of LDAP authentication.

  • Unconfigure LDAP user authentication for the appliance.

  • Add or remove one or more LDAP users.

OPTIONS

The following commands and options are available under Authentication > LDAP:

Attribute

Add or delete LDAP configuration attributes.

  • Use the Attribute Add <parameter_name> <attribute> command to add a new attribute.

  • Use the Attribute Delete <attribute_name> command to delete an existing attribute.

Certificate

Set, view, or disable the SSL certificate.

  • Use the Certificate Set <filename> command to enable and add the SSL certificate. The SSL certificate must be stored in the /inst/patch/incoming directory.

    Note:

    When you use the ssl=StartTLS and ssl=Yes options during LDAP or AD configuration on the appliance, the initial setup is done over a non-SSL channel. After the LDAP connection and initial discover phase is over, the SSL channel is turned on. Even at this phase, establishing the SSL channel does not perform the server-side certificate validation. This validation starts after the server's root certificate is explicitly set using the LDAP > Certificate Set <path> option.

  • Use the Certificate Show command to view the certificate applicable for the LDAP server.

  • Use the Certificate Unset command to disable the SSL certificate.

ConfigParam

Set, view, and unset the LDAP configuration parameters.

Note:

The ConfigParam command is only used to set the various LDAP configuration parameters. Once you set all of the necessary parameters, use the Configure command to enable the LDAP configuration and establish a connection with the LDAP server.

  • Use the ConfigParam Set command to add or change the following LDAP configuration parameters:

    * Required parameters

    • *ConfigParam Set base <base_DN>

      Enter the base directory name which is the top level of the LDAP directory tree.

    • ConfigParam Set binddn <bind_DN>

      Enter the bind directory name. The bind DN is used as an authentication to externally search the LDAP directory within the defined search base.

    • ConfigParam Set bindpw <password>

      Enter the password to access the LDAP server.

    • ConfigParam Set directoryType <directoryType>

      Enter the LDAP directory type. The available options are: OpenLDAP, ActiveDirectory, and Others.

      Select OpenLDAP if you use a typical OpenLDAP directory service.

      Select ActiveDirectory if you use AD as an LDAP directory service.

      Select Others if you use a different type of LDAP directory service.

    • ConfigParam Set groupList <group_name(s)>

      Enter the name of an existing LDAP user group that resides on the LDAP server. To enter multiple groups, separate each group name with a comma (,).

      The appliance does not handle ID mapping for LDAP configuration. Veritas recommends that you reserve a group ID range of 1000 to 1999 for appliance users only.

      Note:

      As a best practice, do not enter group names that are already used for appliance local users or NetBackupCLI users.

    • *ConfigParam Set host <server_name or IP>

      Enter the FQDN or IP address of the LDAP server.

      Note:

      The specified LDAP server should comply with RFC 2307bis. The RFC2307bis specifies that hosts with IPv6 addresses must be written in their preferred form, such that all components of the address are indicated and leading zeros are omitted.

    • *ConfigParam Set ssl <No|Yes|StartTLS>

      Enable SSL certificate for the LDAP server.

      Note:

      When you use the StartTLS and Yes options during LDAP configuration, the initial setup is done over a non-SSL channel. After the LDAP connection and initial discover phase is over, the SSL channel is turned on. Even at this phase, the established SSL channel doesn't do the server-side certificate validation. This validation starts after the server's root certificate is explicitly set using the LDAP > Certificate Set command.

    • ConfigParam Set userList <user_name(s)>

      Enter the name of an existing LDAP user that resides on the LDAP server. To enter multiple users, separate each user name with a comma (,).

      The appliance does not handle ID mapping for LDAP configuration. Veritas recommends that you reserve a user ID range of 1000 to 1999 for appliance users only.

      Note:

      As a best practice, do not enter user names that are already used for appliance local users or NetBackupCLI users. Additionally, do not use the appliance default names admin or maintenance for LDAP users.

  • Use the ConfigParam Show command to view the existing LDAP configuration parameters.

  • Use the ConfigParam Unset <parameters> command to unset the LDAP configuration parameters.

Configure

After setting the LDAP parameters using the ConfigParam command, run the Configure command to complete the configuration and enable LDAP authentication on the appliance.

The ValidateIDs option determines whether the appliance checks the LDAP server and the local server for conflicts when creating LDAP user IDs, group IDs, user names, or group names. By default, the appliance is set to validate IDs by checking for conflicts. Any conflict is reported immediately and stops LDAP configuration.

  • Use the Configure Yes command to enable ValidateIDs.

  • Use the Configure No command to disable ValidateIDs.

Disable

Disable LDAP user authentication on the appliance. This command does not remove the configuration and you can reenable it using the Enable command.

Enable

Enable a disabled LDAP configuration on the appliance.

Export <file_name>

Export the existing LDAP configuration as an XML file. The file is saved at /inst/patch/incoming/<file_name>. This file can be imported to configure LDAP on other appliances.

Groups

Add or remove one or more LDAP user groups. Only the user groups that already exist on the LDAP server can be added to the appliance.

  • Use the Groups Add <groupname> command to add a comma-separated list of LDAP user groups.

  • Use the Groups Remove <groupname> command to delete a comma-separated list of LDAP user groups.

Import <path>

Import the LDAP configuration from an XML file. The XML file must reside at /inst/patch/incoming/<file_name>.

List

List all of the LDAP users and user groups that have been added to the appliance.

Map

Add, delete, or show NSS map attributes.

  • Use the Map Add Attribute <attribute type> <attribute value> command to set an NSS map attribute.

  • Use the Map Delete Attribute <attribute type> command to delete an NSS map attribute.

  • Use the Map Show command to view the NSS map attributes.

Show

View the LDAP configuration details.

Status

View the status of LDAP authentication on the appliance.

Unconfigure

Unconfigure LDAP user authentication for the appliance.

Note:

Before you unconfigure the LDAP server, you must revoke the roles from all of the LDAP users that have been added to the appliance. Otherwise the operation fails.

Warning:

Unconfiguring LDAP user authentication disables and deletes the current LDAP configuration. The LDAP users are deleted from the appliance, but not from the LDAP server.

Users

Add or remove one or more LDAP users. Only the users that already exist on the LDAP server can be added to the appliance.

  • Use the Users Add <username> command to add a comma-separated list of LDAP users.

  • Use the Users Remove <username> command to delete a comma-separated list of LDAP users.

    Note:

    As a matter of best practice, you should delete a registered user or user group from the appliance before deleting it from the LDAP server, AD server, or NIS server. If a user is removed from the remote directory service first (and not removed from appliance), the user is listed as a registered user on the appliance but won't be able to log on.

EXAMPLES

Example 1 - Configure an association between the appliance and an LDAP directory server to enable the appliance to import users and user groups.

appliance123.LDAP > ConfigParam Set host ldap.example.com
appliance123.LDAP > ConfigParam Set base dc=sample,dc=com
appliance123.LDAP > ConfigParam Set ssl no
appliance123.LDAP > Configure
- [Info] Configure Successful. Continuing with Post-Configure Processing!
Configure Successful. Continuing with Post-Configure Processing!

Command was successful!

Example 2 - Register a user or user group from the LDAP directory server so that those users can be authorized and authenticated on the appliance.

appliance123.LDAP> Users Add ldapuser1,ldapuser2
Command was successful!
appliance123.LDAP> Groups Add ldapgroup01
Command was successful!
appliance123.Authorization> List

+----------------------------------------------------------+
|Principal Type|Name/login |Access | Role |Principal Source|
|--------------+-----------+-------+------+----------------|
|User          |ldapuser1  |Allowed|NoRole|Ldap            |
|--------------+-----------+-------+------+----------------|
|User          |ldapuser2  |Allowed|NoRole|Ldap            |
|--------------+-----------+-------+------+----------------|
|Group         |ldapgroup01|Allowed|NoRole|Ldap            |
|--------------+-----------+-------+------+----------------|
|  -Member     |ldapuser3  |Allowed|      |                |
+----------------------------------------------------------+

Command was successful!

Example 3 - Export the current LDAP configuration into an XML file that can be imported on other appliances.

appliance123.LDAP> Export ldapconfig1
- [Info] Exporting LDAP configuration
Exporting LDAP configuration

Command was successful!

Example 4 - Import an LDAP configuration from an XML file.

appliance123.LDAP> Export ldapconfig1
- [Info] Exporting LDAP configuration
Exporting LDAP configuration

Command was successful!