File: //snap/google-cloud-cli/396/help/man/man1/gcloud_alpha_compute_routers_create.1
.TH "GCLOUD_ALPHA_COMPUTE_ROUTERS_CREATE" 1
.SH "NAME"
.HP
gcloud alpha compute routers create \- create a Compute Engine router
.SH "SYNOPSIS"
.HP
\f5gcloud alpha compute routers create\fR \fINAME\fR (\fB\-\-ncc\-gateway\fR=\fINCC_GATEWAY\fR\ |\ \fB\-\-network\fR=\fINETWORK\fR) [\fB\-\-advertisement\-mode\fR=\fIMODE\fR] [\fB\-\-asn\fR=\fIASN\fR] [\fB\-\-async\fR] [\fB\-\-bgp\-identifier\-range\fR=\fIBGP_IDENTIFIER_RANGE\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-encrypted\-interconnect\-router\fR] [\fB\-\-keepalive\-interval\fR=\fIKEEPALIVE_INTERVAL\fR] [\fB\-\-region\fR=\fIREGION\fR] [\fB\-\-resource\-manager\-tags\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-set\-advertisement\-groups\fR=[\fIGROUP\fR,...]] [\fB\-\-set\-advertisement\-ranges\fR=[\fICIDR_RANGE\fR=\fIDESC\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR \fBgcloud alpha compute routers create\fR is used to create a
router to provide dynamic routing to VPN tunnels and interconnects.
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
\fINAME\fR
Name of the router to create.
.RE
.sp
.SH "REQUIRED FLAGS"
.RS 2m
.TP 2m
Exactly one of these must be specified:
.RS 2m
.TP 2m
\fB\-\-ncc\-gateway\fR=\fINCC_GATEWAY\fR
The NCC gateway for this router.
.TP 2m
\fB\-\-network\fR=\fINETWORK\fR
The network for this router
.RE
.RE
.sp
.SH "OPTIONAL FLAGS"
.RS 2m
.TP 2m
\fB\-\-advertisement\-mode\fR=\fIMODE\fR
The new advertisement mode for this router. \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\-\-asn\fR=\fIASN\fR
The optional BGP autonomous system number (ASN) for this router. 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\-\-async\fR
Return immediately, without waiting for the operation in progress to complete.
.TP 2m
\fB\-\-bgp\-identifier\-range\fR=\fIBGP_IDENTIFIER_RANGE\fR
The range of valid BGP Identifiers for this Router. Must be a link\-local IPv4
range from 169.254.0.0/16, of size at least /30, even if the BGP sessions are
over IPv6. It must not overlap with any IPv4 BGP session ranges. This is
commonly called "router ID" by other vendors.
.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR
An optional description of this router.
.TP 2m
\fB\-\-encrypted\-interconnect\-router\fR
Indicates if a router is dedicated for use with encrypted interconnect
attachments (VLAN attachments).
.TP 2m
\fB\-\-keepalive\-interval\fR=\fIKEEPALIVE_INTERVAL\fR
The interval between BGP keepalive messages that are sent to the peer. If set,
this value must be between 20 and 60 seconds. The default is 20 seconds. See $
gcloud topic datetimes for information on duration formats.
BGP systems exchange keepalive messages to determine whether a link or host has
failed or is no longer available. Hold time is the length of time in seconds
that the BGP session is considered operational without any activity. After the
hold time expires, the session is dropped.
Hold time is three times the interval at which keepalive messages are sent, and
the hold time is the maximum number of seconds allowed to elapse between
successive keepalive messages that BGP receives from a peer. BGP will use the
smaller of either the local hold time value or the peer's hold time value as the
hold time for the BGP connection between the two peers.
.TP 2m
\fB\-\-region\fR=\fIREGION\fR
Region of the router to create. 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\-\-resource\-manager\-tags\fR=[\fIKEY\fR=\fIVALUE\fR,...]
Comma\-separated list of Resource Manager tags to attach to the router.
Key\-value pairs must be provided in the form
tagKeys/{TagKey_Numeric_ID}=tagValues/{TagValue_Numeric_ID}. See Listing tag
keys
(https://cloud.google.com/resource\-manager/docs/tags/tags\-creating\-and\-managing#listing_keys).
.TP 2m
\fB\-\-set\-advertisement\-groups\fR=[\fIGROUP\fR,...]
The list of pre\-defined groups of IP ranges to dynamically advertise on this
router. 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 router. 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.
.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. These variants are also available:
.RS 2m
$ gcloud compute routers create
.RE
.RS 2m
$ gcloud beta compute routers create
.RE