File: //snap/google-cloud-cli/current/help/man/man1/gcloud_alpha_transfer_agent-pools_update.1
.TH "GCLOUD_ALPHA_TRANSFER_AGENT\-POOLS_UPDATE" 1
.SH "NAME"
.HP
gcloud alpha transfer agent\-pools update \- update a Transfer Service agent pool
.SH "SYNOPSIS"
.HP
\f5gcloud alpha transfer agent\-pools update\fR \fINAME\fR [\fB\-\-bandwidth\-limit\fR=\fIBANDWIDTH_LIMIT\fR] [\fB\-\-clear\-bandwidth\-limit\fR] [\fB\-\-clear\-display\-name\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR Update an agent pool.
.SH "EXAMPLES"
To remove the bandwidth limit for agent pool 'foo', run:
.RS 2m
$ gcloud alpha transfer agent\-pools update foo \e
\-\-clear\-bandwidth\-limit
.RE
To remove the display name for agent pool 'foo', run:
.RS 2m
$ gcloud alpha transfer agent\-pools update foo \-\-clear\-display\-name
.RE
To update the bandwidth limit for agent pool 'foo' to 100 MB/s, run:
.RS 2m
$ gcloud alpha transfer agent\-pools update foo \-\-bandwidth\-limit=100
.RE
To update the display name for agent pool 'foo' to 'example name', run:
.RS 2m
$ gcloud alpha transfer agent\-pools update foo \e
\-\-display\-name="example name"
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
\fINAME\fR
A unique, permanent identifier for this pool.
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-bandwidth\-limit\fR=\fIBANDWIDTH_LIMIT\fR
Set how much of your bandwidth to make available to this pool's agents. A
bandwidth limit applies to all agents in a pool and can help prevent the pool's
transfer workload from disrupting other operations that share your bandwidth.
For example, enter '50' to set a bandwidth limit of 50 MB/s. By leaving this
flag unspecified, this flag unspecified, this pool's agents will use all
bandwidth available to them.
.TP 2m
\fB\-\-clear\-bandwidth\-limit\fR
Remove the agent pool's bandwidth limit, which enables the pool's agents to use
all bandwidth available to them.
.TP 2m
\fB\-\-clear\-display\-name\fR
Remove the display name from the agent pool.
.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR
A modifiable name to help you identify this pool. You can include details that
might not fit in the pool's unique full resource name.
.RE
.sp
.SH "GCLOUD WIDE FLAGS"
These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.
Run \fB$ gcloud help\fR for details.
.SH "NOTES"
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. This variant is also available:
.RS 2m
$ gcloud transfer agent\-pools update
.RE