Important Update: Cohesity Products Documentation
All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.
NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpcleanrestore
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureMQ
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- msdpcldutil
- msdpimgutil
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcmdrun
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdb2adutl
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbepicfile
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhsmcmd
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nblogparser
- nbmariadb
- nbmysql
- nbmlb
- nborair
- nboracmd
- nbpem
- nbpemreq
- nbmariadb
- nbmlb
- nbperfchk
- nbpgsql
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbshvault
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqlcmd
- nbsqlite
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tiermover
- tldd
- tldcd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- 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][-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.
- -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