- NAME
-
- gcloud compute routers list-bgp-routes - list routes advertised and learned on individual BGP sessions, both pre- and post-policy evaluation
- SYNOPSIS
-
-
gcloud compute routers list-bgp-routesNAME--address-family=ADDRESS_FAMILY--peer=PEER--route-direction=ROUTE_DIRECTION[--destination-range=CIDR_RANGE] [--no-policy-applied] [--region=REGION] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,…]] [--uri] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
gcloud compute routers list-bgp-routeslists routes advertised and learned on individual BGP sessions, both pre- and post-policy evaluation. - EXAMPLES
-
To list inbound BGP routes limited to IPv4 addess family from a router
my-routerBGP peermy-bgp-peerin regionus-central1, run:gcloud compute routers list-bgp-routes my-router --region=us-central1 --address-family=IPV4 --peer=my-bgp-peer --route-direction=INBOUND" - POSITIONAL ARGUMENTS
-
NAME- Name of the router to list.
- REQUIRED FLAGS
-
--address-family=ADDRESS_FAMILY-
Limit results to routes learned for this Address Family Identifier.
ADDRESS_FAMILYmust be one of:IPV4- Interface with IPv4-based BGP.
IPV6- Interface with IPv6-based BGP.
--peer=PEER- Limit results to routes learned from this peer (name).
--route-direction=ROUTE_DIRECTION-
Limit results to routes in this direction.
ROUTE_DIRECTIONmust be one of:INBOUND- Learned routes.
OUTBOUND- Advertised routes.
- FLAGS
-
--destination-range=CIDR_RANGE- Limit results to prefixes.
--policy-applied-
Routes returned are post-policy evaluation. Enabled by default, use
--no-policy-appliedto disable. --region=REGION-
Region of the router to list. 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
property:compute/regiongcloud config set compute/region REGIONA list of regions can be fetched by running:
gcloud compute regions listTo unset the property, run:
gcloud config unset compute/regionAlternatively, the region can be stored in the environment variable
.CLOUDSDK_COMPUTE_REGION
- LIST COMMAND FLAGS
-
--filter=EXPRESSION-
Apply a Boolean filter
EXPRESSIONto each resource item to be listed. If the expression evaluatesTrue, then that item is listed. For more details and examples of filter expressions, run $ gcloud topic filters. This flag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit. --limit=LIMIT-
Maximum number of resources to list. The default is
unlimited. This flag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit. --page-size=PAGE_SIZE-
Some services group resource list output into pages. This flag specifies the
maximum number of resources per page. The default is determined by the service
if it supports paging, otherwise it is
unlimited(no paging). Paging may be applied before or after--filterand--limitdepending on the service. --sort-by=[FIELD,…]-
Comma-separated list of resource field key names to sort by. The default order
is ascending. Prefix a field with ``~´´ for descending order on that
field. This flag interacts with other flags that are applied in this order:
--flatten,--sort-by,--filter,--limit. --uri-
Print a list of resource URIs instead of the default output, and change the
command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs alongside other keys instead, use theuri()transform.
- 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
$ gcloud helpfor details. - NOTES
-
These variants are also available:
gcloud alpha compute routers list-bgp-routesgcloud beta compute routers list-bgp-routes
gcloud compute routers list-bgp-routes
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.