Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.1.2)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
    6.  
      Removal of nbexecute command
  2. Appendix A. NetBackup Commands
    1.  
      acsd
    2.  
      add_media_server_on_clients
    3.  
      backupdbtrace
    4.  
      backuptrace
    5.  
      bmrc
    6.  
      bmrconfig
    7.  
      bmrepadm
    8.  
      bmrprep
    9.  
      bmrs
    10.  
      bmrsrtadm
    11.  
      bp
    12.  
      bparchive
    13.  
      bpbackup
    14.  
      bpbackupdb
    15.  
      bpcatarc
    16.  
      bpcatlist
    17.  
      bpcatres
    18.  
      bpcatrm
    19.  
      bpcd
    20.  
      bpchangeprimary
    21.  
      bpclient
    22.  
      bpclimagelist
    23.  
      bpclntcmd
    24.  
      bpclusterutil
    25.  
      bpcompatd
    26.  
      bpconfig
    27.  
      bpdbjobs
    28.  
      bpdbm
    29.  
      bpdgclone
    30.  
      bpdown
    31.  
      bpduplicate
    32.  
      bperror
    33.  
      bpexpdate
    34.  
      bpfis
    35.  
      bpflist
    36.  
      bpgetconfig
    37.  
      bpgetdebuglog
    38.  
      bpimage
    39.  
      bpimagelist
    40.  
      bpimmedia
    41.  
      bpimport
    42.  
      bpinst
    43.  
      bpkeyfile
    44.  
      bpkeyutil
    45.  
      bplabel
    46.  
      bplist
    47.  
      bpmedia
    48.  
      bpmedialist
    49.  
      bpminlicense
    50.  
      bpnbat
    51.  
      bpnbaz
    52.  
      bppficorr
    53.  
      bpplcatdrinfo
    54.  
      bpplclients
    55.  
      bppldelete
    56.  
      bpplinclude
    57.  
      bpplinfo
    58.  
      bppllist
    59.  
      bpplsched
    60.  
      bpplschedrep
    61.  
      bpplschedwin
    62.  
      bppolicynew
    63.  
      bpps
    64.  
      bprd
    65.  
      bprecover
    66.  
      bprestore
    67.  
      bpretlevel
    68.  
      bpschedule
    69.  
      bpschedulerep
    70.  
      bpsetconfig
    71.  
      bpstsinfo
    72.  
      bpstuadd
    73.  
      bpstudel
    74.  
      bpstulist
    75.  
      bpsturep
    76.  
      bptestbpcd
    77.  
      bptestnetconn
    78.  
      bptpcinfo
    79.  
      bpup
    80.  
      bpverify
    81.  
      cat_convert
    82.  
      cat_export
    83.  
      cat_import
    84.  
      configurePorts
    85.  
      configureTPCerts
    86.  
      create_nbdb
    87.  
      csconfig cldinstance
    88.  
      csconfig cldprovider
    89.  
      csconfig meter
    90.  
      csconfig throttle
    91.  
      duplicatetrace
    92.  
      importtrace
    93.  
      jbpSA
    94.  
      jnbSA
    95.  
      ltid
    96.  
      manageClientCerts
    97.  
      mklogdir
    98.  
      nbauditreport
    99.  
      nbcatsync
    100.  
      NBCC
    101.  
      NBCCR
    102.  
      nbcertcmd
    103.  
      nbcertupdater
    104.  
      nbcldutil
    105.  
      nbcloudrestore
    106.  
      nbcomponentupdate
    107.  
      nbcplogs
    108.  
      nbdb_admin
    109.  
      nbdb_backup
    110.  
      nbdb_move
    111.  
      nbdb_ping
    112.  
      nbdb_restore
    113.  
      nbdb_unload
    114.  
      nbdbms_start_server
    115.  
      nbdbms_start_stop
    116.  
      nbdc
    117.  
      nbdecommission
    118.  
      nbdelete
    119.  
      nbdeployutil
    120.  
      nbdevconfig
    121.  
      nbdevquery
    122.  
      nbdiscover
    123.  
      nbdna
    124.  
      nbemm
    125.  
      nbemmcmd
    126.  
      nbfindfile
    127.  
      nbfirescan
    128.  
      nbftadm
    129.  
      nbftconfig
    130.  
      nbgetconfig
    131.  
      nbhba
    132.  
      nbholdutil
    133.  
      nbhostidentity
    134.  
      nbhostmgmt
    135.  
      nbhypervtool
    136.  
      nbinstallcmd
    137.  
      nbjm
    138.  
      nbkmsutil
    139.  
      nboraadm
    140.  
      nborair
    141.  
      nbpem
    142.  
      nbpemreq
    143.  
      nbperfchk
    144.  
      nbplupgrade
    145.  
      nbrb
    146.  
      nbrbutil
    147.  
      nbregopsc
    148.  
      nbreplicate
    149.  
      nbrepo
    150.  
      nbrestorevm
    151.  
      nbseccmd
    152.  
      nbsetconfig
    153.  
      nbsnapimport
    154.  
      nbsnapreplicate
    155.  
      nbsqladm
    156.  
      nbstl
    157.  
      nbstlutil
    158.  
      nbstop
    159.  
      nbsu
    160.  
      nbsvrgrp
    161.  
      resilient_clients
    162.  
      restoretrace
    163.  
      stopltid
    164.  
      tl4d
    165.  
      tl8d
    166.  
      tl8cd
    167.  
      tldd
    168.  
      tldcd
    169.  
      tlhd
    170.  
      tlhcd
    171.  
      tlmd
    172.  
      tpautoconf
    173.  
      tpclean
    174.  
      tpconfig
    175.  
      tpext
    176.  
      tpreq
    177.  
      tpunmount
    178.  
      verifytrace
    179.  
      vltadm
    180.  
      vltcontainers
    181.  
      vlteject
    182.  
      vltinject
    183.  
      vltoffsitemedia
    184.  
      vltopmenu
    185.  
      vltrun
    186.  
      vmadd
    187.  
      vmchange
    188.  
      vmcheckxxx
    189.  
      vmd
    190.  
      vmdelete
    191.  
      vmoprcmd
    192.  
      vmphyinv
    193.  
      vmpool
    194.  
      vmquery
    195.  
      vmrule
    196.  
      vmupdate
    197.  
      vnetd
    198.  
      vssat
    199.  
      vwcp_manage
    200.  
      vxlogcfg
    201.  
      vxlogmgr
    202.  
      vxlogview
    203.  
      W2KOption

Name

csconfig throttle — the throttle option for the csconfig command sets and fetches the throttling configuration details from the Cloud Connect server.

SYNOPSIS

[-availablebw available_bandwidth][-cshost server_name][-csport service_port][-force][-interval time][-maxconn max_connections][-offtime start_time,end_time,bandwidth_percentage][-providermaxconn max_connections][-readbw read_bandwidth_percentage][-setdefaults][-sserver storage_server_name][-stype storage_server_type][-weekend start_day,end_day,bandwidth_percentage][-worktime start_time,end_day,bandwidth_percentage][-writebw write bandwidth_percentage]

On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/admincmd/

On Windows systems, the directory path to this command is install_path\NetBackup\bin\admincmd\

DESCRIPTION

The csconfig command manages the Cloud Connect configuration settings from a remote or a local computer. The throttle option sets and fetches the throttling configuration details from the Cloud Connect server.

Note:

You cannot provide multi-byte or localized format values for any of the csconfig command's throttle options.

OPTIONS

-availablebw available_bandwidth | -abw

Use this option to specify the amount of bandwidth NetBackup can use for cloud-related activities.

Valid values are positive integers followed by KB or MB (e.g., 200MB). If no units are specified, the value is in bytes.

-cshost server_name | -n

Use this option to connect a remote machine to a Cloud Connect service.

-csport service_port | -p

Use this option to specify the port to connect to, if the service runs on a port other than the default port.

-force | -f

Use this option to force the default values for the throttle parameters.

-interval time | -i

Use this option to specify the sampling throttle time interval in seconds. The valid value range is 0-86400.

-maxconn max_connections |-mxc

This option is the default maximum number of connections for each cloud provider.

-offtime start_time,end_time,bandwidth_percentage | -oft

Use this option to specify the time interval that is considered off time for the cloud connection.

Specify a start time and end time in 24-hour format. For example, 2:00 P.M. is 14:00.

You can indicate how much bandwidth the cloud connection can use in percentage.

The bandwidth percentage value range is 0-100. You can only specify whole numbers for the bandwidth percentage.

-providermaxconn max_connections | -pmc

Use this option to specify the maximum number of connections for a specific provider.

-readbw read_bandwidth_percentage | -rbw

Use this option to specify the percentage of total bandwidth that read operations can use. If there is insufficient bandwidth to transmit the specified amount of data within a few minutes, restore or replication failures may occur due to timeouts. Consider the total load of simultaneous jobs on multiple media servers when you calculate the required bandwidth.

The bandwidth percentage value range is 0-100. You can only specify whole numbers for the bandwidth percentage.

-setdefaults | -def

Use this option to reset all throttling parameters to the default value.

-sserver storage_server_name |-r

Use this option to specify the name of the storage server.

-stype storage_server_type | -t

Use this option to specify the type of storage server.

-weekend start_day,end_day,bandwidth_percentage | -wkd

Use this option to specify the start and stop time for the weekend.

The start day and end day range of values is Monday-Sunday or 1-7.

Note:

You can configure weekdays only in English and in the US calendar format (mmddyy).

You can indicate how much bandwidth the cloud connection can use in percentage.

The bandwidth percentage value range is 0-100. You can only specify whole numbers for the bandwidth percentage.

-worktime start_time,end_time,bandwidth_percentage | -wkt

Use this option to specify the time interval that is considered work time for the cloud connection. Specify a start time and end time in 24-hour format.

The start time and end time range of values is 0-23.

You can indicate how much bandwidth the cloud connection can use in percentage or kilobytes per second. This value determines how much of the available bandwidth is used for cloud operations in this time window.

The bandwidth percentage value range is 0-100. You can only specify whole numbers for the bandwidth percentage.

-writebw write bandwidth_percentage | -wbw

Use this option to specify the percentage of total bandwidth that write operations can use.

If there is insufficient bandwidth to transmit the specified amount of data within a few minutes, backup failures may occur due to timeouts.

Consider the total load of simultaneous jobs on multiple media servers when you calculate the required bandwidth.

The bandwidth percentage value range is 0-100. You can only specify whole numbers for the bandwidth percentage.

EXAMPLES

Example 1: Get the throttling configuration details.

csconfig throttle

Throttling Configuration Details:
        Read Bandwidth Percent         = 100 %
        Write Bandwidth Percent        = 100 %
        Total Available Bandwidth      = 102400 KB/s
        Default Maximum Connections    = 10

        Work Time:
                Start Time             = 8 Hrs
                End Time               = 18 Hrs
                Allocation Bandwidth   = 100 %

        Off Time:
                Start Time             = 18 Hrs
                End Time               = 8 Hrs
                Allocation Bandwidth   = 100 %

        Weekend:
                Start Day              = 6 (Saturday)
                End Day                = 7 (Sunday)
                Allocation Bandwidth   = 100 %

        Sampling Interval              = 0 Sec

Example 2: Set the read bandwidth to 30% and available bandwidth to 2147483648 Bytes = 2GB.

csconfig throttle -readbw 30 -availablebw 2147483648 -f