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 > Manage > FibreChannel > Configure — Use this command to configure the QLogic Fibre Channel HBA ports.

SYNOPSIS

Configure NumberPorts

Configure Deduplication Initiator HBAportid

Configure Deduplication Target HBAportid

DESCRIPTION

You can use the configure command to do the following:

  • Configure the number of QLogic Fibre Channel HBA ports for use by SAN Client (if the SAN Client feature is enabled). You can configure the appliance Fibre Transport Media Server (FTMS) to use the 2 target port configuration or the 4 target port configuration.

  • Configure the FC HBA ports on this appliance as target ports for Fibre Transport Deduplication. Fibre Transport Deduplicatoin is a feature that enables you to use an appliance as a taregt host for optimized duplication and Auto Image Replication.

    Note:

    You must restart the appliances in the FC zone where a port mode change has occurred. A port mode change occurs when you change and save the port mode configuration, or enable/disable the feature. Veritas recommends that you complete all the port mode changes before you restart the appliances.

OPTIONS

Configure NumberPorts

Configure the number of FC HBA target ports for use with the SAN Client feature. The available NumberPorts is 2 and 4.

For new appliances or for appliances that have been factory reset, the configuration default is 2.

The available options are as follows:

  • Configure 2

    Sets Port 1 to the target mode on the following FC HBA cards:

    • NetBackup 5220 - cards in slots 2 and 4

    • NetBackup 5230 and 5330 - cards in slots 5 and 6

    • NetBackup 5240 - cards in slots 5 and 6

    • NetBackup 5340 - cards in slots 5 and 6

  • Configure 4

    Sets Ports 1 and 2 to the target mode on the following FC HBA cards:

    • NetBackup 5220 - cards in slots 2 and 4

    • NetBackup 5230 and 5330 - cards in slots 5 and 6

    • NetBackup 5240 - cards in slots 5 and 6

    • NetBackup 5340 - cards in slots 5 and 6

Changing this option restarts the appliance, but it does not change the state of the SAN Client feature.

By default, the SAN Client feature is disabled on new appliances or on appliances that have been factory reset. If the SAN Client feature is disabled, changes to this setting only mark the ports as ready for target mode use. To enable the SAN Client feature, go to the Settings view and run the FibreTransport SANClient Enable command.

Configure Deduplication Initiator HBAportid

Configure a port as an FC initiator port.

The HBAportid is the slot number(1-6) and port number(1-2) of the HBA port. The format is Slot:Port.

Note:

You can check the current state of the available ports by using the Main> Manage> FibreChannel> Show Ports command before you configure a port.

The following HBA ports may be available:

  • NetBackup 5220 - ports in slot 3

  • NetBackup 5230 - ports in slots 2, 3, 4

  • NetBackup 5330 - ports in slots 2, 3, 6

  • NetBackup 5240 - ports in slots 2, 4, 6

  • NetBackup 5340 - ports in slots 2, 3, 6

FC feature support depends on the particular HBA card configuration of each appliance. For complete information about available ports on your HBA configuration, see the NetBackup Appliance Fibre Channel Guide.

Note:

This command restarts the Deduplication service if the port mode is changed. The service restart causes the ongoing jobs to fail, and then failover to LAN. It is recommended that you cancel or suspend all jobs before you change the port mode.

Configure Deduplication Target HBAportid

Configures a port as an FC target port for Optimized Duplication and Auto Image Replication(AIR).

The HBAportid is the slot number(1-6) and port number(1-2) of the HBA port. The format is Slot:Port.

Note:

You can check the current state of the available ports by using the Main> Manage> FibreChannel> Show Ports command before you configure a port.

The following HBA ports may be available:

  • NetBackup 5220 - ports in slot 3

  • NetBackup 5230 - ports in slots 2, 3, 4

  • NetBackup 5330 - ports in slots 2, 3, 6

  • NetBackup 5240 - ports in slots 2, 4, 6

  • NetBackup 5340 - ports in slots 2, 3, 6

FC feature support depends on the particular HBA card configuration of each appliance. For complete information about available ports on your HBA configuration, see the NetBackup Appliance Fibre Channel Guide.

Note:

This command restarts the Deduplication service if the port mode is changed. The service restart causes the ongoing jobs fail, and then failover to LAN. It is recommended that you cancel or suspend all jobs before you change the port mode.

EXAMPLES

The following is an example of information when you run the Configure Deduplicaton Initiator command.

appliance.FC> Configure Deduplication Initiator 2:2
[Info] Checking the port state...
[Info] This port is currently configured as an FC target port for optimized duplication
						 and replication.
       Are you sure that you want to change it to an FC initiator port? [yes, no](no) yes
[Info] Configuring the port state...
[Info] Restarting the optimized duplication service to complete the change. This may take 
							1 - 2 minutes...
[Info] Port configured successfully as an FC initiator port for optimized duplication.

The following is an example of information when you run the Configure Deduplication Target command.

appliance.FC> Configure Deduplication Target 2:2
[Info] Checking the port state...
[Info] This port is currently configured as an FC initiator port.
       Are you sure that you want to change it to an FC Target port for optimized duplication
       and replication? [yes, no](no) yes
[Info] Configuring the port state...
[Info] Restarting the optimized duplication service to complete the change. This may take 
       1 - 2 minutes...
[Info] Port configured successfully as an FC Target port for optimized duplication 
       and replication.