Veritas NetBackup™ Appliance Commands Reference Guide

Last Published:
Product(s): Appliances (5.3)
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 > AutoFix
    3.  
      Manage > HighAvailability > GetAssetTag
    4.  
      Manage > HighAvailability > RemoveNode
    5.  
      Manage > HighAvailability > Setup
    6.  
      Manage > HighAvailability > Status
    7.  
      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
  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 > AllowSelfService
    2.  
      Manage > NetBackupCLI > Create
    3.  
      Manage > NetBackupCLI > Delete
    4.  
      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 > UpgradeReadinessCheck
    13.  
      Manage > Software > UpgradeStatus
    14.  
      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
  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 > Monitor commands
    1.  
      Monitor > Beacon
    2.  
      Monitor > Hardware
    3.  
      Monitor > MemoryStatus
    4.  
      Monitor > NetBackup
    5.  
      Monitor > NetworkStatus
    6.  
      Monitor > SDCS
    7.  
      Monitor > Top
    8.  
      Monitor > Uptime
    9.  
      Monitor > Who
  15. Appendix N. 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
  16. Appendix O. Main > Network > Security commands (DeviceCert)
    1.  
      Network > Security > Export
    2.  
      Network > Security > Import
  17. Appendix P. Main > Reports commands
    1.  
      Reports > Deduplication
    2.  
      Reports > Process
  18. Appendix Q. Main > Settings commands
    1.  
      Settings > Deduplication
    2.  
      Settings > FibreTransport
    3.  
      Settings > iSCSI > Initiator
    4.  
      Settings > iSCSI > Interface
    5.  
      Settings > iSCSI > Target
    6.  
      Settings > LifeCycle
    7.  
      Settings > LogForwarding
    8.  
      Settings > NetBackup
    9.  
      Settings > NetBackup DNAT
    10.  
      Settings > NetBackup NATServers
    11.  
      Settings > Password
    12.  
      Settings > Share
    13.  
      Settings > SNMP
    14.  
      Settings > Sysctl
    15.  
      Settings > SystemLocale
  19. Appendix R. Main > Settings > Alerts commands
    1.  
      Settings > Alerts > CallHome
    2.  
      Settings > Alerts > Email
    3.  
      Settings > Alerts > Hardware
    4.  
      Settings > Alerts > SNMP
    5.  
      Settings > Alerts > Transmission
  20. Appendix S. Main > Settings > Notifications view commands
    1.  
      Settings > Notifications > LoginBanner
  21. Appendix T. Main > Settings > Security commands
    1.  
      Settings > Security > Antimalware
    2.  
      Settings > Security > Authorization
    3.  
      Settings > Security > Authentication > AccountStatus
    4.  
      Settings > Security > Authentication > ActiveDirectory
    5.  
      Main > Settings > Security > Authentication > CIFSShare
    6.  
      Settings > Security > Authentication > LDAP
    7.  
      Settings > Security > Authentication > LocalUser
    8.  
      Settings > Security > Authentication > MFA
    9.  
      Settings > Security > Authentication > SingleSignOn
    10.  
      Settings > Security > Authentication > SmartCard > SSH
    11.  
      Settings > Security > Authentication > SmartCard
    12.  
      Main > Settings > Security > Certificate
    13.  
      Main > Settings > Security > Certificate > CertificateSigningRequest
    14.  
      Main > Settings > Security > FIPS
    15.  
      Settings > Security > NetworkAccessControl
    16.  
      Main > Settings > Security > PasswordAge
    17.  
      Main > Settings > Security > Ports
    18.  
      Main > Settings > Security > SecurityLevel
    19.  
      Main > Settings > Security > Sessions
    20.  
      Main > Settings > Security > STIG
  22. Appendix U. 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 > ImportISO
    12.  
      Support > InfraServices
    13.  
      Support > InstantAccess
    14.  
      Support > iostat
    15.  
      Support > IPMI
    16.  
      Support > KillRemoteCall
    17.  
      Support > LogBrowser
    18.  
      Support > Logs
    19.  
      Support > Maintenance
    20.  
      Support > Messages
    21.  
      Support > NBDNA
    22.  
      Support > Nbperfchk
    23.  
      Support > NBSU
    24.  
      Support > Processes
    25.  
      Support > RAID
    26.  
      Support > Reboot
    27.  
      Support > RecoverStorage
    28.  
      Support > Service
    29.  
      Support > ShelfOrdering
    30.  
      Support > SHMCLI
    31.  
      Support > Show
    32.  
      Support > Shutdown
    33.  
      Support > Storage ClearReservations
    34.  
      Support > Storage SanityCheck
    35.  
      Support > Storage Show
    36.  
      Support > System
    37.  
      Support > Test

Name

Main > Support > Nbperfchk — Measures a disk array's read and write speeds.

SYNOPSIS

Nbperfchk help

Nbperfchk run

DESCRIPTION

The Nbperfchk command measures the read speed and write speed of a disk array. You can use this command to test the read speed and the write speed of the disks that host deduplicated data. For example, you can measure the speeds of the disks that host deduplicated data as follows:

  • In a PureDisk storage pool, use this command to measure the speed of disks attached to the content router.

  • In a NetBackup media server deduplication pool (MSDP), use this command to measure the speed of the disks attached to the media server. The media server can be running any operating system that Veritas supports for media servers and MSDPs.

Note:

Veritas recommends that you work with a Veritas Technical Support staff member when you run this command and interpret its results. Veritas recommends a minimum disk performance level of 130 MB/sec for deduplicated read and write operations.

The nbperfchk command is functionally equivalent to the obsolete camel command that was available from Veritas as a downloadable program but was not associated with any specific product release. The camel command is available internally from the Veritas Technical Support website as HOWTO47457.

The Nbperfchk utility enables you to write a test file to a disk, read back that test file, and observe the read speeds attained during the read operation. You can use the results from nbperfchk to make sure that the ReadBufferSize parameter is set appropriately in your backup environment. The ReadBufferSize parameter resides in the [CRDataStore] section of the contentrouter.cfg file. You can use this command as follows:

  • Use the following command to write data to the disks:

    Nbperfchk -i inputpath -o outputpath -s filesize -syncend

  • Use the following command to read data from the disks:

    Nbperfchk -i inputpath -o outputpath -bs buffersize

OPTIONS

-bs buffersize

Specify the read buffer size to use when nbperfchk runs. For example, 64k or 128k.

-n number-of-buffers

Specify the number-of-buffers to include in the report. The default is 255.

-s size

Specify a file size that is equal to or larger than the combined memory size of your computer, plus the amount in the disk array. A file of this size ensures that the data is written to disk and not to a buffer.

-i inputpath

Specify the full path to an input file. The nbperfchk command reads this file and generates information about the read speed when this file is read to disk.

For example, you can specify the following to read in a file that contains all zero characters (0x00) from the /dev/zero:

-o outputpath

Specify the full path to an output file. The nbperfchk command creates this file.

For example, on writes, specify the path to the output file that you want to create. On reads, specify -o NUL to discard all the output as it is generated.

-directio

Specify to use unbuffered direct input/output.

-syncend

The syncend parameter flushes the buffer and writes all data to disk.

-ri interval

Specify the reporting interval in seconds. The default is 3.

-rc

Specify to create the report without linefeeds.

-rp

Specify to include buffer states in the report.

-nr

Turn off or suppress progress reporting

-q

Set reporting to quiet (no reporting).

PROCEDURES

To analyze nbperfchk results and adjust the ReadBufferSize parameter setting

  1. Log in as the root user (UNIX) or the administrator (Windows) on the computer that hosts the content router.

    In PureDisk environments, log into the storage pool authority node or storage pool authority appliance.

    In NetBackup environments, log into the media server.

  2. Change to a test directory.
  3. Type the Nbperfchk command in the following format to write a large test file to the content router:
    nbperfchk -i inputpath -o outputpath -s filesize -syncend

    For example, the following command writes a 64 GB data file that contains all zeros to the e drive:

    nbperfchk -i zero: -o e:\data1 -s 64g -syncend
    
  4. Type the Nbperfchk command in the following format to read the test file and observe the read speeds in the Nbperfchk output:
    nbperfchk -i inputpath -o NUL -bs buffersize

    Example 1. To observe several read speeds with several buffer sizes, type the following series of commands:

    nbperfchk -i e:\data1 -bs 64k -o NUL
    nbperfchk -i e:\data1 -bs 128k -o NUL
    nbperfchk -i e:\data1 -bs 256k -o NUL

    Example 2. The following nbperfchk command reads back the data in file data1 and uses a buffer size of 1024 K:

    C:\Users\administrator.mymediaserver\Desktop>nbperfchk -i e:\data1 -bs 1024k -o NUL
         195 MB @   65.3 MB/sec,      194 MB @   64.9 MB/sec
         295 MB @   49.4 MB/sec,      100 MB @   33.5 MB/sec
         403 MB @   44.8 MB/sec,      108 MB @   35.8 MB/sec
         505 MB @   42.1 MB/sec,      102 MB @   34.1 MB/sec
         599 MB @   40.0 MB/sec,       94 MB @   31.3 MB/sec
         705 MB @   39.2 MB/sec,      106 MB @   35.5 MB/sec
         821 MB @   39.2 MB/sec,      116 MB @   38.8 MB/sec
         943 MB @   39.4 MB/sec,      122 MB @   40.8 MB/sec
        1024 MB @   40.1 MB/sec

    Observe the following when you analyze the data:

    • The left two columns show the amount of data read and the average read speed.

    • The final line shows the overall read speed. This is the most important line in this output because it shows you how fast the total read occurred with the buffer size you specified.

    • The right two columns show the average read speed in the last 3 seconds of each read. Unless these numbers vary drastically from read to read, you can disregard the right two columns.

  5. Analyze your read speeds and adjust the ReadBufferSize parameter if necessary.

    Your operating system, your disk speeds, and the ReadBufferSize parameter setting all affect restore and rehydration performance.

    Veritas recommends that you type several nbperfchk commands and increase the size of the argument to the -bs parameter each time. Example 1 in step 4 shows this method. If you can enter ever-increasing arguments to the -bs parameter, you can probably increase the size of the ReadBufferSize parameter in the [CRDataStore] section of the contentrouter.cfg file.

    By default, ReadBufferSize=65536, which is 64K. Veritas testing shows that ReadBufferSize=1048576, which is 1024 X 1024, or 1M, offers good performance on most Windows systems. On most UNIX systems, Veritas testing shows that ReadBufferSize=65536 (the default) offers good performance.

    For information about how to edit NetBackup configuration files, see your NetBackup documentation.

    For information about how to edit PureDisk configuration files, see the PureDisk Administrator's Guide.