Veritas NetBackup™ Appliance Commands Reference Guide

Last Published:
Product(s): Appliances (4.1)
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 > 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
  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 > UpgradeStatus
    13.  
      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
    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 commands (IPsec)
    1.  
      Network > Security > Configure
    2.  
      Network > Security > Delete
    3.  
      Network > Security > Export
    4.  
      Network > Security > Import
    5.  
      Network > Security > Provision
    6.  
      Network > Security > Refresh
    7.  
      Network > Security > Show
    8.  
      Network > Security > Unconfigure
  18. Appendix Q. Main > Reports commands
    1.  
      Reports > Deduplication
    2.  
      Reports > Process
  19. Appendix R. Main > Settings commands
    1.  
      Settings > Deduplication
    2.  
      Settings > FibreTransport
    3.  
      Settings > iSCSI > Initiator
    4.  
      Settings > iSCSI > Interface
    5.  
      Settings > iSCSI > Target
    6.  
      Settings > LogForwarding
    7.  
      Settings > LifeCycle
    8.  
      Settings > NetBackup
    9.  
      Settings > NetBackup DNAT
    10.  
      Settings > NetBackup NATServers
    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 > AccountStatus
    3.  
      Settings > Security > Authentication > ActiveDirectory
    4.  
      Main > Settings > Security > Authentication > CIFSShare
    5.  
      Settings > Security > Authentication > Kerberos
    6.  
      Settings > Security > Authentication > LDAP
    7.  
      Settings > Security > Authentication > LocalUser
    8.  
      Main > Settings > Security > Certificate
    9.  
      Main > Settings > Security > Certificate > CertificateSigningRequest
    10.  
      Main > Settings > Security > FIPS
    11.  
      Main > Settings > Security > Ports
    12.  
      Main > Settings > Security > STIG
    13.  
      Main > Settings > Security > SecurityLevel
  23. Appendix V. 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 > InfraServices
    12.  
      Support > InstantAccess
    13.  
      Support > iostat
    14.  
      Support > IPMI
    15.  
      Support > KillRemoteCall
    16.  
      Support > LogBrowser
    17.  
      Support > Logs
    18.  
      Support > Maintenance
    19.  
      Support > Messages
    20.  
      Support > NBDNA
    21.  
      Support > nbperfchk
    22.  
      Support > NBSU
    23.  
      Support > Processes
    24.  
      Support > RAID
    25.  
      Support > Reboot
    26.  
      Support > RecoverStorage
    27.  
      Support > Service
    28.  
      Support > ServiceAllowed
    29.  
      Support > ShelfOrdering
    30.  
      Support > Show
    31.  
      Support > Shutdown
    32.  
      Support > Storage ClearReservations
    33.  
      Support > Storage Reset
    34.  
      Support > Storage SanityCheck
    35.  
      Support > System
    36.  
      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.

Note:

If you upgrade to version 4.0 from versions 3.1 through 3.3.0.1, you cannot perform a factory reset and retain the backup data. The backup data cannot be retained because the data format was updated during a previous upgrade. The new data format cannot be reverted and the older software versions cannot recognize the new data format. Therefore, the software version still reverts back to an older version, but all of the data will be removed. If you upgrade to version 4.0 from version 3.0, you can perform a factory reset and retain the backup data, but the software version is not reverted and remains at 4.0.

For appliance nodes in a 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 questions that follow, before the factory reset begins:

    [Info] Disable interrupt (CTRL-C), quit, and suspend signals.

    [Info] The IPMI sysadmin user and its associated password, status, and permissions have been reset to the default values.

    Appliance Factory Reset

    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 primary server
    5) Networking configuration (optionally retain)
    6) Storage configuration and backup data (optionally retain)
    7) Fibre Transport Deduplication target port configuration
    
    - [Info] Successfully copied /usr/openv/netbackup/bp.conf to /cat/conf.
    - [Info] Running factory reset validation...please wait (approx 2 mins)
    - [Info] Successfully copied /usr/openv/netbackup/bp.conf to /cat/conf.
    - [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
     >> WARNING: You are trying to reset the system back to an older software version.
        The backup data cannot be preserved because the data format was updated
        during a previous upgrade. The new data format cannot be reverted and the
        older software version cannot recognize the new data format.
        ALL DATA WILL BE REMOVED!!! Do you want to continue with the factory reset
        without preserving the 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) 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  | Version before factory reset   | Version after factory reset    |
    |------------+--------------------------------+--------------------------------|
    |n40-h129    | NetBackup 8.2 Appliance 3.2    | NetBackup 9.0 Appliance 4.0    |
    +------------------------------------------------------------------------------+
  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/no) yes

    The following summary messages appear as the factory reset continues:

    Performing factory reset. This operation could take 15-20 mins.
    Please wait...
    - [Info] Skipping NetBackup configuration reset for primary server 'n40-h129'.
    - [Info] PERFORMING APPLIANCE RESET TO FACTORY STATE
    - [Info] Delete checkpoints (type: NON_FACT) succeeded
    - [Info] Successfully copied /usr/openv/netbackup/bp.conf to /cat/conf.
    - [Info] Reset of the appliance to FACTORY STATE successful.
    - [Info] Stopping NetBackup processes... (6 mins approx)
    - [Info] Moving NetBackup Appliance Directory to n40-h129...
    - [Info] Acquired lock on the storage.
    - [Info] Resetting the storage configuration...
    - [Info] Checking whether the 'MSDP' partition exists...
    - [Info] Initiating deletion of 'MSDP' storage partition...
    - [Info] Removing the mount point for the 'MSDP' partition '0'...
    - [Info] Deleting the 'MSDP' partition '0'...
    - [Info] Checking whether the 'NetBackup Catalog' partition exists...
    - [Info] Initiating deletion of 'NetBackup Catalog' storage partition...
    - [Info] Removing the mount point for the 'NetBackup Catalog' partition '0'...
    - [Info] Deleting the 'NetBackup Catalog' partition '0'...
    - [Info] Checking whether the 'Share' partition exists...
    - [Info] The 'Share' partition does not exist.
    - [Info] Checking whether the 'MSDP Catalog' partition exists...
    - [Info] Initiating deletion of 'MSDP Catalog' storage partition...
    - [Info] Removing the mount point for the 'MSDP Catalog' partition '0'...
    - [Info] Deleting the 'MSDP Catalog' partition '0'...
    - [Info] Checking whether the 'Configuration' partition exists...
    - [Info] Initiating deletion of 'Configuration' storage partition...
    - [Info] Removing the mount point for the 'Configuration' partition '0'...
    - [Info] Deleting the 'Configuration' partition '0'...
    - [Info] Checking whether the 'NetBackup VxUpdate Repository' partition exists...
    - [Info] Initiating deletion of 'NetBackup VxUpdate Repository' storage partition...
    - [Info] Removing the mount point for the 'NetBackup VxUpdate Repository' partition '0'...
    - [Info] Deleting the 'NetBackup VxUpdate Repository' partition '0'...
    - [Info] Checking whether the 'AdvancedDisk' partition exists...
    - [Info] Initiating deletion of 'AdvancedDisk' storage partition...
    - [Info] Removing the mount point for the 'AdvancedDisk' partition '0'...
    - [Info] Deleting the 'AdvancedDisk' partition '0'...
    - [Info] Checking whether the 'NetBackup Cloud Catalyst Cache' partition exists...
    - [Info] The 'NetBackup Cloud Catalyst Cache' partition does not exist.
    - [Info] Optimized Share Reserve does not exist.
    - [Info] Removing the storage configuration...
    - [Info] Starting NetBackup processes... (6 min approx)
    - [Info] Successfully started NetBackup services.
      Rebooting the appliance now...
    - [Info] Rebooting appliance to complete the reset. Please reconnect to the appliance
      shell menu to continue using this appliance.
    
    Broadcast message from root@n40-h129 (pts/1) (Sun Jan 12 17:55:22 2020):
    
    The system is going down for reboot NOW!