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 > Logs — Manage logging setting, view and share logs files.

SYNOPSIS

Browse

Delete Date LogType

GetLevel

ProcessLogLevel Option Action

SetLevel Option Level

Share

VxLogView JobID job_id

VxLogView Minutes minutes_ago

VxLogView Module module_name

Upload JobID jobid case_num

Upload Time start end case_num

DESCRIPTION

Use this command to do the following functions:

  • Browse the appliance log directories and files.

    You can use the Browse command to view the log directories and log files that are configured in your appliance. When you run the Browse command the command prompt changes to LOGROOT/>. From the LOGROOT/ command prompt you can run the following commands to list, view, and change directories:

    • ls - List the directories and files

    • tree - Provides a tree-view of the directories and files.

    • cd DIR - Use to change the directory, where DIR is the directory name. For example, you can use cd ., cd .., and cd -.

    • less FILE - Provides a read-only view of a file. You must enter the letter q or quit to exit this view.

    • exit|quit - Enables you to exit the log shell.

    • help|? - Use either of these two commands to display help.

    From the LOGROOT/> command prompt, you can use the ls command to see the following log directories on the host:

    • APPLIANCE

    • NBU

    • OS

    • PD

    • WEBGUI

    To see the log files from within a log directory, you must change directories to the log directory that contains the log files that you want to view. After you change directories, the same commands that were available under the LOGROOT/ view are available for each of the log directories.

    For example, to see the operating system (OS) log files, you must first enter cd OS at the LOGROOT/> command prompt. The command prompt changes to LOGROOT/OS>/. Then you can enter ls to see the file names. Finally, you can use the less filename command to view a read-only version of the log file.

  • Set the level of debug logs

    Use the SetLevel command to set the NetBackup log level for an appliance component that you choose. The range begins with zero and can differ for each component. A value of zero means that logging is at its lowest level.

    In addition, you can use the GetLevel command to get the NetBackup log level.

  • Export or remove CIFS and NFS shares for the logs.

    Use the Share Open command to export the CIFS and the NFS shares for the logs. The Share Close command removes the CIFS and the NFS shares for the logs.

  • Display debug information from the VxLog files.

    Use the VxLogView command to display log files for specific job or by a set duration of time.

  • Upload the NetBackup log files for your appliance to Support. The files that you send can be based on the job ID, the time that the log files were taken, or the default-based duration.

    If an issue occurs and you decide you need additional support, you should call Veritas Technical Support and open a customer case. The customer support contact assigns a unique customer case number that identifies you, your company information, and your issue. To further help you diagnose the issue, the customer support contact needs to obtain a copy of your appliance log files. You can use the Upload command to send all of the log files that are associated with your appliance to Support.

    The following procedure describes the process that you use to send the log files from your appliance to Technical Support.

To configure your appliance to upload log files using the Logs Upload command

  1. Make sure that you have a customer case number assigned to your issue. If you do not have a case number, contact Technical Support and have a customer case opened and a unique customer case number assigned to your issue. The customer case number is used to create the name of the file that you send to Support. That helps the technical support contact identify the file that you sent.
  2. Log on to your appliance as the administrator.
  3. Enter the Main > Support view.
  4. Type one of the following commands to create a log set for technical support. Depending on the nature of your issue, technical support may ask you to use one of the following commands to create the log set. Each of these commands creates a .tar file that is based on the job ID, a specific start and end time, or a default duration of four hours.
    • Type Logs Upload Jobid jobid case_num.

      This command creates a .tar file that contains log files that are based on the job ID.

    • Type Logs Upload Time start End case_num.

      This command creates a .tar file that contains log files that are based on the default duration of four hours

      Where case_num is the customer case number that was issued to you by your NetBackup Support contact. This number becomes a part of the .tar file name so your Technical Support contact can identify the files that came from your appliance.

      Where jobid is the job ID number that is used to collect the logs.

      Where start and End are the start date and the end date of the logs to collect.

OPTIONS

Browse

Use the show the appliance logs.

Delete Date LogType

Use this command to delete archived log files. Here, Date defines the date until which you want to delete archived log files. LogType is the product name for which you want to delete the archived log files.

The available LogType options are the following:

CoreDump/NetBackup/Puredisk/WEBGUI/ALL

GetLevel

Use to view the current log level settings for the following:

  • NetBackup Legacy

  • NetBackup Unified Debug

  • NetBackup Unified Diagnostic

  • NetBackup VolMgr

  • MSDP

  • AutoSupport

  • VxMS

  • WebGUI

ProcessLogLevel Option Action

Use to set the process log level for specific NetBackup processes.

Where Option is NetBackupUnified, NetBackupLegacy, or MSDP. When you select NetBackupUnified Set or NetBackupUnified SetAll, you must also select either Debug or Diagnostic.

Where Action is Restore, RestoreDefault, Save, Set, SetAll, Show, or ShowAll.

For example, to set this option for NetBackupUnified and set the nbemm process for Debug at a log level of 1, you would enter the following:

ProcessLogLevel NetBackupUnified Set nbemm Debug 1

SetLevel Option Level

Use to set a specific log level.

Where Option is one of the following:

  • NetBackupLegacy

  • NetBackupUnified

  • NetBackup VolMgr

  • MSDP

  • AutoSupport

  • VxMS

  • WebGUI

Where Level is any number from 0 (lowest logging level) to 10 (highest logging level). When you select NetBackupUnified, you must also select either Debug or Diagnostic.

For example, to set the level for NetBackupUnified Diagnostic to a log level of 2, you would enter the following:

SetLevel NetBackupUnified Diagnostic 2

Share

Use to extract the CIFS and the NFS shares for the logs.

For CIFS, you must map the share using the appliance "admin" user's credentials.

VxLogView JobID job_id

Display debug information from the log files by designating a specific job ID as the criteria by which the information is parsed.

Where job_id is the NetBackup job that you determine you want to view from the debug information.

VxLogView Minutes minutes_ago

Display debug information from the log files using time (in minutes) as the criteria by which the information is parsed.

Where minutes_ago is the amount of time, in minutes, used to determine how much of the past debug information to display.

VxLogView Module module_name

Display debug information from the log files by designating a specific logging module as the criteria by which the information is parsed.

Where module_name is the module from which you want to view log files. You can select from the following modules:

All/CallHome/Checkpoint/Common/Config/Database/Hardware/HWMonitor
/Network/RAID/Seeding/SelfTest/Storage/SWUpdate/Commands/CrossHost
/Trace/FTMS/FTDedupTarget/AuthService/TaskService
Upload JobID jobid case_num

Upload log files for the appliance to Support. This command creates a .tar file of the logs using the job ID. Use FTP to upload the file to Support.

Where jobid contains the job ID number that is used to collect the logs. The case_num variable is a unique number filed with Support that identifies the customer and their corresponding log files. The format of this number is ###-###-###

Upload Time start end case_num

Upload the logs based on the default duration. The default duration is four hours. This command creates a .tar file of the logs using the time. Use FTP to upload the file to Support.

Where start is the start date of the log files to send to Support. end is the end date of the log files to send to Support. And case_num is a unique number filed with Support that identifies the customer and their corresponding log files. The format of this number is ###-###-###