gcloud alpha compute routers list-bgp-routes

NAME
gcloud alpha compute routers list-bgp-routes - list routes advertised and learned on individual BGP sessions, both pre- and post-policy evaluation
SYNOPSIS
gcloud alpha 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
(ALPHA)gcloud alpha compute routers list-bgp-routeslists routes advertised and learned on individual BGP sessions, both pre- andpost-policy evaluation.
EXAMPLES
To list inbound BGP routes limited to IPv4 addess family from a routermy-router BGP peermy-bgp-peer in regionus-central1, run:
gcloudalphacomputerouterslist-bgp-routesmy-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_FAMILY must 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_DIRECTION must 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-applied to disable.
--region=REGION
Region of the router to list. If not specified, you might be prompted to selecta region (interactive mode only).

To avoid prompting when this flag is omitted, you can set thecompute/region property:

gcloudconfigsetcompute/regionREGION

A list of regions can be fetched by running:

gcloudcomputeregionslist

To unset the property, run:

gcloudconfigunsetcompute/region

Alternatively, the region can be stored in the environment variableCLOUDSDK_COMPUTE_REGION.

LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filterEXPRESSION to each resource itemto be listed. If the expression evaluatesTrue, then that item islisted. For more details and examples of filter expressions, run $gcloud topic filters. This flaginteracts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit.
--limit=LIMIT
Maximum number of resources to list. The default isunlimited. Thisflag 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 themaximum number of resources per page. The default is determined by the serviceif it supports paging, otherwise it isunlimited (no paging).Paging may be applied before or after--filter and--limit depending on the service.
--sort-by=[FIELD,…]
Comma-separated list of resource field key names to sort by. The default orderis ascending. Prefix a field with ``~´´ for descending order on thatfield. 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 thecommand output to a list of URIs. If this flag is used with--format, the formatting is applied on this URI list. To displayURIs 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 help for details.

NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudcomputerouterslist-bgp-routes
gcloudbetacomputerouterslist-bgp-routes

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-07 UTC.