.TH "GCLOUD_COMPUTE_ROUTERS_UPDATE\-BGP\-PEER" 1



.SH "NAME"
.HP
gcloud compute routers update\-bgp\-peer \- update a BGP peer on a Compute Engine router



.SH "SYNOPSIS"
.HP
\f5gcloud compute routers update\-bgp\-peer\fR \fINAME\fR \fB\-\-peer\-name\fR=\fIPEER_NAME\fR [\fB\-\-advertised\-route\-priority\fR=\fIADVERTISED_ROUTE_PRIORITY\fR] [\fB\-\-advertisement\-mode\fR=\fIMODE\fR] [\fB\-\-async\fR] [\fB\-\-clear\-md5\-authentication\-key\fR] [\fB\-\-custom\-learned\-route\-priority\fR=\fIPRIORITY\fR] [\fB\-\-[no\-]enable\-ipv4\fR] [\fB\-\-[no\-]enable\-ipv6\fR] [\fB\-\-[no\-]enabled\fR] [\fB\-\-export\-policies\fR=[\fIEXPORT_POLICY\fR,...]] [\fB\-\-import\-policies\fR=[\fIIMPORT_POLICY\fR,...]] [\fB\-\-interface\fR=\fIINTERFACE\fR] [\fB\-\-ip\-address\fR=\fIIP_ADDRESS\fR] [\fB\-\-ipv4\-nexthop\-address\fR=\fIIPV4_NEXTHOP_ADDRESS\fR] [\fB\-\-ipv6\-nexthop\-address\fR=\fIIPV6_NEXTHOP_ADDRESS\fR] [\fB\-\-md5\-authentication\-key\fR=\fIMD5_AUTHENTICATION_KEY\fR] [\fB\-\-peer\-asn\fR=\fIPEER_ASN\fR] [\fB\-\-peer\-ip\-address\fR=\fIPEER_IP_ADDRESS\fR] [\fB\-\-peer\-ipv4\-nexthop\-address\fR=\fIPEER_IPV4_NEXTHOP_ADDRESS\fR] [\fB\-\-peer\-ipv6\-nexthop\-address\fR=\fIPEER_IPV6_NEXTHOP_ADDRESS\fR] [\fB\-\-region\fR=\fIREGION\fR] [\fB\-\-set\-advertisement\-groups\fR=[\fIGROUP\fR,...]] [\fB\-\-set\-advertisement\-ranges\fR=[\fICIDR_RANGE\fR=\fIDESC\fR,...]] [\fB\-\-set\-custom\-learned\-route\-ranges\fR=[\fICIDR_RANGE\fR,...]] [\fB\-\-add\-advertisement\-groups\fR=[\fIGROUP\fR,...]\ |\ \fB\-\-add\-advertisement\-ranges\fR=[\fICIDR_RANGE\fR=\fIDESC\fR,...]\ |\ \fB\-\-remove\-advertisement\-groups\fR=[\fIGROUP\fR,...]\ |\ \fB\-\-remove\-advertisement\-ranges\fR=[\fICIDR_RANGE\fR,...]] [\fB\-\-add\-custom\-learned\-route\-ranges\fR=[\fICIDR_RANGE\fR,...]\ |\ \fB\-\-remove\-custom\-learned\-route\-ranges\fR=[\fICIDR_RANGE\fR,...]] [\fB\-\-bfd\-min\-receive\-interval\fR=\fIBFD_MIN_RECEIVE_INTERVAL\fR\ \fB\-\-bfd\-min\-transmit\-interval\fR=\fIBFD_MIN_TRANSMIT_INTERVAL\fR\ \fB\-\-bfd\-multiplier\fR=\fIBFD_MULTIPLIER\fR\ \fB\-\-bfd\-session\-initialization\-mode\fR=\fIBFD_SESSION_INITIALIZATION_MODE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fBgcloud compute routers update\-bgp\-peer\fR is used to update a BGP peer on a
Compute Engine router.



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fINAME\fR

Name of the router to operate on.


.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-peer\-name\fR=\fIPEER_NAME\fR

The name of the new BGP peer being updated.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-advertised\-route\-priority\fR=\fIADVERTISED_ROUTE_PRIORITY\fR

The priority of routes advertised to this BGP peer. In the case where there is
more than one matching route of maximum length, the routes with lowest priority
value win. 0 <= priority <= 65535. If not specified, will use Google\-managed
priorities.

.TP 2m
\fB\-\-advertisement\-mode\fR=\fIMODE\fR

The new advertisement mode for this peer. \fIMODE\fR must be one of:

.RS 2m
.TP 2m
\fBCUSTOM\fR
Custom (user\-configured) BGP advertisements.
.TP 2m
\fBDEFAULT\fR
Default (Google\-managed) BGP advertisements.
.RE
.sp


.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-clear\-md5\-authentication\-key\fR

If specified, remove MD5 authentication from the BGP peer.

.TP 2m
\fB\-\-custom\-learned\-route\-priority\fR=\fIPRIORITY\fR

An integral value \f50\fR <= priority <= \f565535\fR, to be applied to all
custom learned route IP address ranges for this peer. If not specified, a
Google\-managed priority value of 100 is used. The routes with the lowest
priority value win.

.TP 2m
\fB\-\-[no\-]enable\-ipv4\fR

If IPv4 is enabled, the peer connection can be established with IPv4 route
exchange. If disabled, no IPv4 route exchange is allowed on any active session.
Use \fB\-\-enable\-ipv4\fR to enable and \fB\-\-no\-enable\-ipv4\fR to disable.

.TP 2m
\fB\-\-[no\-]enable\-ipv6\fR

If IPv6 is enabled, the peer connection can be established with IPv6 route
exchange. If disabled, no IPv6 route exchange is allowed on any active session.
Use \fB\-\-enable\-ipv6\fR to enable and \fB\-\-no\-enable\-ipv6\fR to disable.

.TP 2m
\fB\-\-[no\-]enabled\fR

If enabled, the peer connection can be established with routing information. If
disabled, any active session with the peer is terminated and all associated
routing information is removed. Use \fB\-\-enabled\fR to enable and
\fB\-\-no\-enabled\fR to disable.

.TP 2m
\fB\-\-export\-policies\fR=[\fIEXPORT_POLICY\fR,...]

Comma\-separated list of export policies. Passing an empty string removes all
export policies.

.TP 2m
\fB\-\-import\-policies\fR=[\fIIMPORT_POLICY\fR,...]

Comma\-separated list of import policies. Passing an empty string removes all
import policies.

.TP 2m
\fB\-\-interface\fR=\fIINTERFACE\fR

The name of the interface for this BGP peer.

.TP 2m
\fB\-\-ip\-address\fR=\fIIP_ADDRESS\fR

The address of the Cloud Router interface for this BGP peer. Must be a
link\-local IPv4 address in the range 169.254.0.0/16 or an ULA IPv6 address in
the range fdff:1::/64. It must also be in the same subnet as the interface
address of the peer router.

.TP 2m
\fB\-\-ipv4\-nexthop\-address\fR=\fIIPV4_NEXTHOP_ADDRESS\fR

If IPv4 route exchange is enabled for IPv6\-based BGP, the IPv4 next hop address
of the Cloud Router interface for this BGP peer. Ignored otherwise. Must be a
Google owned link\-local IPv4 address in the range 169.254.0.0/16 and must
belong to the same subnet as the interface address of the peer router.

.TP 2m
\fB\-\-ipv6\-nexthop\-address\fR=\fIIPV6_NEXTHOP_ADDRESS\fR

If IPv6 route exchange is enabled for IPv4\-based BGP, the IPv6 next hop address
of the Cloud Router interface for this BGP peer. Ignored otherwise. Must be a
Google owned global unicast IPv6 address belonging to the range
2600:2d00:0:2:0:0:0:0/64 or 2600:2d00:0:3:0:0:0:0/64 and must belong to same
subnet as the interface address of the peer router.

.TP 2m
\fB\-\-md5\-authentication\-key\fR=\fIMD5_AUTHENTICATION_KEY\fR

The MD5 authentication key for this BGP peer. Maximum length is 80 characters.
Can contain only printable ASCII characters.

.TP 2m
\fB\-\-peer\-asn\fR=\fIPEER_ASN\fR

The BGP autonomous system number (ASN) for this BGP peer. Must be a 16\-bit or
32\-bit private ASN as defined in https://tools.ietf.org/html/rfc6996, for
example \f5\-\-asn=64512\fR.

.TP 2m
\fB\-\-peer\-ip\-address\fR=\fIPEER_IP_ADDRESS\fR

The address of the peer router. Must be a link\-local IPv4 address in the range
169.254.0.0/16 or an ULA IPv6 address in the range fdff:1::/64.

.TP 2m
\fB\-\-peer\-ipv4\-nexthop\-address\fR=\fIPEER_IPV4_NEXTHOP_ADDRESS\fR

If IPv4 route exchange is enabled for IPv6\-based BGP, the IPv4 next hop address
of the peer router. Ignored otherwise. Must be a Google owned link\-local IPv4
address in the range 169.254.0.0/16.

.TP 2m
\fB\-\-peer\-ipv6\-nexthop\-address\fR=\fIPEER_IPV6_NEXTHOP_ADDRESS\fR

If IPv6 route exchange is enabled for IPv4\-based BGP, the IPv6 next hop address
of the peer router. Ignored otherwise. Must be a Google owned global unicast
IPv6 address belonging to the range 2600:2d00:0:2:0:0:0:0/64 or
2600:2d00:0:3:0:0:0:0/64.

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

Region of the router to operate on. If not specified, you might be prompted to
select a region (interactive mode only).

To avoid prompting when this flag is omitted, you can set the
\f5\fIcompute/region\fR\fR property:

.RS 2m
$ gcloud config set compute/region REGION
.RE

A list of regions can be fetched by running:

.RS 2m
$ gcloud compute regions list
.RE

To unset the property, run:

.RS 2m
$ gcloud config unset compute/region
.RE

Alternatively, the region can be stored in the environment variable
\f5\fICLOUDSDK_COMPUTE_REGION\fR\fR.

.TP 2m
\fB\-\-set\-advertisement\-groups\fR=[\fIGROUP\fR,...]

The list of pre\-defined groups of IP ranges to dynamically advertise on this
peer. This list can only be specified in custom advertisement mode.

\fIGROUP\fR must be (only one value is supported):

.RS 2m
.TP 2m
\fBALL_SUBNETS\fR
Automatically advertise all available subnets. This excludes any routes learned
for subnets that use VPC Network Peering.
.RE
.sp


.TP 2m
\fB\-\-set\-advertisement\-ranges\fR=[\fICIDR_RANGE\fR=\fIDESC\fR,...]

The list of individual IP ranges, in CIDR format, to dynamically advertise on
this peer. Each IP range can (optionally) be given a text description DESC. For
example, to advertise a specific range, use
\f5\-\-set\-advertisement\-ranges=192.168.10.0/24\fR. To store a description
with the range, use
\f5\-\-set\-advertisement\-ranges=192.168.10.0/24=my\-networks\fR. This list can
only be specified in custom advertisement mode.

.TP 2m
\fB\-\-set\-custom\-learned\-route\-ranges\fR=[\fICIDR_RANGE\fR,...]

The list of user\-defined custom learned route IP address ranges for this peer.
This list is a comma separated IP address ranges such as
\f51.2.3.4\fR,\f56.7.0.0/16\fR,\f52001:db8:abcd:12::/64\fR where each IP address
range must be a valid CIDR\-formatted prefix. If an IP address is provided
without a subnet mask, it is interpreted as a /32 singular IP address range for
IPv4, and /128 for IPv6.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-add\-advertisement\-groups\fR=[\fIGROUP\fR,...]

A list of pre\-defined groups of IP ranges to dynamically advertise on this
peer. This list is appended to any existing advertisements. This field can only
be specified in custom advertisement mode.

\fIGROUP\fR must be (only one value is supported):

.RS 2m
.TP 2m
\fBALL_SUBNETS\fR
Automatically advertise all available subnets. This excludes any routes learned
for subnets that use VPC Network Peering.
.RE
.sp


.TP 2m
\fB\-\-add\-advertisement\-ranges\fR=[\fICIDR_RANGE\fR=\fIDESC\fR,...]

A list of individual IP ranges, in CIDR format, to dynamically advertise on this
peer. This list is appended to any existing advertisements. Each IP range can
(optionally) be given a text description DESC. For example, to advertise a
specific range, use \f5\-\-advertisement\-ranges=192.168.10.0/24\fR. To store a
description with the range, use
\f5\-\-advertisement\-ranges=192.168.10.0/24=my\-networks\fR. This list can only
be specified in custom advertisement mode.

.TP 2m
\fB\-\-remove\-advertisement\-groups\fR=[\fIGROUP\fR,...]

A list of pre\-defined groups of IP ranges to remove from dynamic advertisement
on this peer. Each group in the list must exist in the current set of custom
advertisements. This field can only be specified in custom advertisement mode.

\fIGROUP\fR must be (only one value is supported):

.RS 2m
.TP 2m
\fBALL_SUBNETS\fR
Automatically advertise all available subnets. This excludes any routes learned
for subnets that use VPC Network Peering.
.RE
.sp


.TP 2m
\fB\-\-remove\-advertisement\-ranges\fR=[\fICIDR_RANGE\fR,...]

A list of individual IP ranges, in CIDR format, to remove from dynamic
advertisement on this peer. Each IP range in the list must exist in the current
set of custom advertisements. This field can only be specified in custom
advertisement mode.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-add\-custom\-learned\-route\-ranges\fR=[\fICIDR_RANGE\fR,...]

A list of user\-defined custom learned route IP address ranges to be added to
this peer. This list is a comma separated IP address ranges such as
\f51.2.3.4\fR,\f56.7.0.0/16\fR,\f52001:db8:abcd:12::/64\fR where each IP address
range must be a valid CIDR\-formatted prefix. If an IP address is provided
without a subnet mask, it is interpreted as a /32 singular IP address range for
IPv4, and /128 for IPv6.

.TP 2m
\fB\-\-remove\-custom\-learned\-route\-ranges\fR=[\fICIDR_RANGE\fR,...]

A list of user\-defined custom learned route IP address ranges to be removed
from this peer. This list is a comma separated IP address ranges such as
\f51.2.3.4\fR,\f56.7.0.0/16\fR,\f52001:db8:abcd:12::/64\fR where each IP address
range must be a valid CIDR\-formatted prefix. If an IP address is provided
without a subnet mask, it is interpreted as a /32 singular IP address range for
IPv4, and /128 for IPv6.

.RE
.sp
.TP 2m

Arguments to update BFD (Bidirectional Forwarding Detection) settings:


.RS 2m
.TP 2m
\fB\-\-bfd\-min\-receive\-interval\fR=\fIBFD_MIN_RECEIVE_INTERVAL\fR

The minimum receive interval between BFD control packets. The default is 1000
milliseconds. See $ gcloud topic datetimes for information on duration formats.

.TP 2m
\fB\-\-bfd\-min\-transmit\-interval\fR=\fIBFD_MIN_TRANSMIT_INTERVAL\fR

The minimum transmit interval between BFD control packets. The default is 1000
milliseconds. See $ gcloud topic datetimes for information on duration formats.

.TP 2m
\fB\-\-bfd\-multiplier\fR=\fIBFD_MULTIPLIER\fR

The number of consecutive BFD control packets that must be missed before BFD
declares that a peer is unavailable.

.TP 2m
\fB\-\-bfd\-session\-initialization\-mode\fR=\fIBFD_SESSION_INITIALIZATION_MODE\fR

The BFD session initialization mode for this BGP peer. Must be one of:

ACTIVE \- The Cloud Router will initiate the BFD session for this BGP peer.

PASSIVE \- The Cloud Router will wait for the peer router to initiate the BFD
session for this BGP peer.

DISABLED \- BFD is disabled for this BGP peer.

\fIBFD_SESSION_INITIALIZATION_MODE\fR must be one of:

.RS 2m
.TP 2m
\fBACTIVE\fR
The Cloud Router will initiate the BFD session for this BGP peer.
.TP 2m
\fBDISABLED\fR
BFD is disabled for this BGP peer.
.TP 2m
\fBPASSIVE\fR
The Cloud Router will wait for the peer router to initiate the BFD session for
this BGP peer.
.RE
.sp



.RE
.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"

These variants are also available:

.RS 2m
$ gcloud alpha compute routers update\-bgp\-peer
.RE

.RS 2m
$ gcloud beta compute routers update\-bgp\-peer
.RE