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 > Support > FactoryReset — Reset the appliance to factory default settings.

SYNOPSIS

FactoryReset

FactoryReset ResetAll

DESCRIPTION

Use this command to reset the appliance to the factory default settings. If you changed the default factory-set password, this command resets it back to the default value.

For nodes in an appliance high availability (HA) setup, you must first remove the node from the HA setup and disconnect its Ethernet and Fibre Channel (FC) cables before a factory reset.

Note:

If you attempt to run a factory reset or initiate a rollback to a non-HA checkpoint on a node in an HA setup, the HA setup can malfunction.

Before a factory reset on any HA node, perform the following tasks in the order as they appear:

  • On the node that you do not want to remove, run the following command to remove the other node from the HA setup:

    Manage > High Availability > Remove Node HostName

    Where HostName is the host name of the node you want to remove.

  • Disconnect the Ethernet cables and the FC cables from the removed node.

  • After completing the previous tasks, you can run the FactoryReset command.

    Note:

    If you do not remove the node from the HA setup and disconnect the Ethernet and FC cables before a factory reset, the command fails. An error message appears to remind you to perform the previous tasks and then try the factory reset again.

OPTIONS

FactoryReset

Use this command to reset the appliance to the factory default settings.

FactoryReset ResetAll

Use this command to reset the appliance factory installed image in non-interactive mode.

EXAMPLES

To begin a factory reset from the appliance shell menu

  1. Open an SSH session and log on to the appliance as an administrator.
  2. Enter Main_Menu > Support > FactoryReset. This command shows the following messages and requires you to answer the following questions before the factory reset begins.
    Appliance factory reset will reset the entire system to the factory 
    installed image. The appliance will have the following components
    reset to the factory restored settings/image:
    1) Appliance Operating System
    2) Appliance Software
    3) NetBackup Software
    4) Tape media configuration on the master server
    5) Networking configuration
    6) Storage configuration and backup data (optionally retain)
    
    - [Info] Running factory reset validation...please wait (approx 2 mins)
    - [Info] Factory reset validation successful.
    
    RESET NETWORK CONFIGURATION [Optional]
            -- Resets the IP and routing configuration.
            -- Resets the DNS configuration.
     >> Do you want to reset the network configuration? [yes/no] (yes) no
    
    RESET STORAGE CONFIGURATION and BACKUP DATA [Optional]
            -- Removes all the images on the AdvancedDisk and MSDP storage pools.
            -- Resets the storage partitions.
            -- Resets storage expansion units, if any.
     >> Do you want to delete images and reset backup data? [yes/no] (yes)
     >> Resetting the storage configuration will remove all backup
        data on the storage partitions and any connected expansion
        units. This is not reversible. Are you sure you want to
        reset storage configuration? [yes/no] (yes)
     >> A reboot of the appliance is required to complete the factory reset. 
        Reboot automatically after reset? [yes/no] (no) yes
     >> Automatically rebooting after the reset will not provide you with an
        opportunity to review the progress/final status of the reset. Are you sure
        you would like to automatically reboot? [yes/no] (no) yes
  3. After you respond to these questions, the following summary information is shown:
    FACTORY RESET SUMMARY
    ---------------------
    Reset Appliance OS, software configuration          : [YES]
    Reset Appliance network configuration               : [NO]
    Reset Appliance storage configuration (REMOVE DATA) : [YES]
    Auto reboot after reset?                            : [YES]
    
    Appliance will make the following version changes:
    
    +------------------------------------------------------------------------------+
    | Appliance  |        Current Version         |        Reverted Version        |
    |------------+--------------------------------+--------------------------------|
    |v49         |NetBackup 7.6.0.1 Appliance     |NetBackup 7.6.0.1 Appliance     |
    |            |2.6.0.1                         |2.6.0.1                         |
    +------------------------------------------------------------------------------+
  4. The following warning appears. If you want to begin the factory reset operation, enter Yes.
    WARNING: an Appliance Factory reset cannot be reversed!
    Continue with factory reset? yes

    The following summary messages appear as the factory reset continues:

    - [Info] PERFORMING APPLIANCE RESET TO FACTORY STATE ON : abc123.example.com
    - [Info] Delete checkpoints (type: NON_FACT) succeeded
    - [Info] Reset of the appliance to FACTORY STATE successful.
    - [Info] Stopping NetBackup processes... (6 mins approx)
    - [Info] Moving NetBackup Appliance Directory to ce-win21-urmi1...
    - [Info] Acquired lock on the storage.
    - [Info] Resetting the storage configuration...
    - [Info] Checking whether the 'MSDP' storage partition exists...
    - [Info] Initiating deletion of 'MSDP' storage partition...
    - [Info] Unmounting the 'MSDP' partition '0'...
    - [Info] Deleting the 'MSDP' partition '0'...
    - [Info] Checking whether the 'Catalog' storage partition exists...
    - [Info] Initiating deletion of 'Catalog' storage partition...
    - [Info] Unmounting the 'Catalog' partition '0'...
    - [Info] Deleting the 'Catalog' partition '0'...
    - [Info] Checking whether the 'Configuration' storage partition exists...
    - [Info] Initiating deletion of 'Configuration' storage partition...
    - [Info] Unmounting the 'Configuration' partition '0'...
    - [Info] Deleting the 'Configuration' partition '0'...
    - [Info] Checking whether the 'AdvancedDisk' storage partition exists...
    - [Info] Initiating deletion of 'AdvancedDisk' storage partition...
    - [Info] Unmounting the 'AdvancedDisk' partition '0'...
    - [Info] Deleting the 'AdvancedDisk' partition '0'...
    - [Info] Removing the storage configuration...
    - [Warning] Failed to query SCSI device '/dev/system/root'.
    
    - [Warning] Failed to query SCSI device '/dev/system/root'.
     >> A reboot of the appliance is required to complete the factory reset.
        Reboot now?[yes/no] (no)yes
    Rebooting the appliance now...
    - [Info] Rebooting abc123.example.com...
    
    Broadcast message from root (Mon Nov 25 11:56:39 2013):
    
    The system is going down for reboot NOW!
    - [Info] Rebooting appliance to complete the reset.
      Please reconnect to the Appliance shell menu to continue using this appliance