Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.1.1)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
  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.  
      bppolicynew
    62.  
      bpps
    63.  
      bprd
    64.  
      bprecover
    65.  
      bprestore
    66.  
      bpretlevel
    67.  
      bpschedule
    68.  
      bpschedulerep
    69.  
      bpsetconfig
    70.  
      bpstsinfo
    71.  
      bpstuadd
    72.  
      bpstudel
    73.  
      bpstulist
    74.  
      bpsturep
    75.  
      bptestbpcd
    76.  
      bptestnetconn
    77.  
      bptpcinfo
    78.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configurePorts
    84.  
      create_nbdb
    85.  
      csconfig cldinstance
    86.  
      csconfig cldprovider
    87.  
      csconfig meter
    88.  
      csconfig throttle
    89.  
      duplicatetrace
    90.  
      importtrace
    91.  
      jbpSA
    92.  
      jnbSA
    93.  
      ltid
    94.  
      manageClientCerts
    95.  
      mklogdir
    96.  
      nbauditreport
    97.  
      nbcatsync
    98.  
      NBCC
    99.  
      NBCCR
    100.  
      nbcertcmd
    101.  
      nbcertupdater
    102.  
      nbcldutil
    103.  
      nbcomponentupdate
    104.  
      nbcplogs
    105.  
      nbdb_admin
    106.  
      nbdb_backup
    107.  
      nbdb_move
    108.  
      nbdb_ping
    109.  
      nbdb_restore
    110.  
      nbdb_unload
    111.  
      nbdbms_start_server
    112.  
      nbdbms_start_stop
    113.  
      nbdc
    114.  
      nbdecommission
    115.  
      nbdelete
    116.  
      nbdeployutil
    117.  
      nbdevconfig
    118.  
      nbdevquery
    119.  
      nbdiscover
    120.  
      nbdna
    121.  
      nbemm
    122.  
      nbemmcmd
    123.  
      nbexecute
    124.  
      nbfindfile
    125.  
      nbfirescan
    126.  
      nbftadm
    127.  
      nbftconfig
    128.  
      nbgetconfig
    129.  
      nbhba
    130.  
      nbholdutil
    131.  
      nbhostidentity
    132.  
      nbhostmgmt
    133.  
      nbhypervtool
    134.  
      nbjm
    135.  
      nbkmsutil
    136.  
      nboraadm
    137.  
      nborair
    138.  
      nbpem
    139.  
      nbpemreq
    140.  
      nbperfchk
    141.  
      nbplupgrade
    142.  
      nbrb
    143.  
      nbrbutil
    144.  
      nbregopsc
    145.  
      nbreplicate
    146.  
      nbrestorevm
    147.  
      nbseccmd
    148.  
      nbsetconfig
    149.  
      nbsnapimport
    150.  
      nbsnapreplicate
    151.  
      nbsqladm
    152.  
      nbstl
    153.  
      nbstlutil
    154.  
      nbstop
    155.  
      nbsu
    156.  
      nbsvrgrp
    157.  
      resilient_clients
    158.  
      restoretrace
    159.  
      stopltid
    160.  
      tl4d
    161.  
      tl8d
    162.  
      tl8cd
    163.  
      tldd
    164.  
      tldcd
    165.  
      tlhd
    166.  
      tlhcd
    167.  
      tlmd
    168.  
      tpautoconf
    169.  
      tpclean
    170.  
      tpconfig
    171.  
      tpext
    172.  
      tpreq
    173.  
      tpunmount
    174.  
      verifytrace
    175.  
      vltadm
    176.  
      vltcontainers
    177.  
      vlteject
    178.  
      vltinject
    179.  
      vltoffsitemedia
    180.  
      vltopmenu
    181.  
      vltrun
    182.  
      vmadd
    183.  
      vmchange
    184.  
      vmcheckxxx
    185.  
      vmd
    186.  
      vmdelete
    187.  
      vmoprcmd
    188.  
      vmphyinv
    189.  
      vmpool
    190.  
      vmquery
    191.  
      vmrule
    192.  
      vmupdate
    193.  
      vnetd
    194.  
      vwcp_manage
    195.  
      vxlogcfg
    196.  
      vxlogmgr
    197.  
      vxlogview
    198.  
      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