Class RouterBgpPeer (1.12.0)

Version 1.12.0

• 1.22.0 (latest)
• 1.21.0
• 1.20.1
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

RouterBgpPeer(mapping=None, *, ignore_unknown_fields=False, **kwargs)

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
advertise_mode	str User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values. This field is a member of oneof_ _advertise_mode.
advertised_groups	MutableSequence[str] User-specified list of prefix groups to advertise in custom mode, which currently supports the following option: - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. Check the AdvertisedGroups enum for the list of possible values.
advertised_ip_ranges	MutableSequence[google.cloud.compute_v1.types.RouterAdvertisedIpRange] User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the "bgp" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.
advertised_route_priority	int The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win. This field is a member of oneof_ _advertised_route_priority.
bfd	google.cloud.compute_v1.types.RouterBgpPeerBfd BFD configuration for the BGP peering. This field is a member of oneof_ _bfd.
custom_learned_ip_ranges	MutableSequence[google.cloud.compute_v1.types.RouterBgpPeerCustomLearnedIpRange] A list of user-defined custom learned route IP address ranges for a BGP session.
custom_learned_route_priority	int The user-defined custom learned route priority for a BGP session. This value is applied to all custom learned route ranges for the session. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges. This field is a member of oneof_ _custom_learned_route_priority.
enable	str The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE. Check the Enable enum for the list of possible values. This field is a member of oneof_ _enable.
enable_ipv6	bool Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default. This field is a member of oneof_ _enable_ipv6.
interface_name	str Name of the interface the BGP peer is associated with. This field is a member of oneof_ _interface_name.
ip_address	str IP address of the interface inside Google Cloud Platform. Only IPv4 is supported. This field is a member of oneof_ _ip_address.
ipv6_nexthop_address	str IPv6 address of the interface inside Google Cloud Platform. This field is a member of oneof_ _ipv6_nexthop_address.
management_type	str [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. Check the ManagementType enum for the list of possible values. This field is a member of oneof_ _management_type.
md5_authentication_key_name	str Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035. This field is a member of oneof_ _md5_authentication_key_name.
name	str Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is a member of oneof_ _name.
peer_asn	int Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. This field is a member of oneof_ _peer_asn.
peer_ip_address	str IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. This field is a member of oneof_ _peer_ip_address.
peer_ipv6_nexthop_address	str IPv6 address of the BGP interface outside Google Cloud Platform. This field is a member of oneof_ _peer_ipv6_nexthop_address.
router_appliance_instance	str URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances. The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session. This field is a member of oneof_ _router_appliance_instance.

Classes

AdvertiseMode

AdvertiseMode(value)

User-specified flag to indicate which mode to use for advertisement.

Values: UNDEFINED_ADVERTISE_MODE (0): A value indicating that the enum field is not set. CUSTOM (388595569): No description available. DEFAULT (115302945): No description available.

AdvertisedGroups

AdvertisedGroups(value)

Values: UNDEFINED_ADVERTISED_GROUPS (0): A value indicating that the enum field is not set. ALL_SUBNETS (3622872): Advertise all available subnets (including peer VPC subnets).

Enable

Enable(value)

The status of the BGP peer connection. If set to FALSE, any active session with the peer is terminated and all associated routing information is removed. If set to TRUE, the peer connection can be established with routing information. The default is TRUE.

Values: UNDEFINED_ENABLE (0): A value indicating that the enum field is not set. FALSE (66658563): No description available. TRUE (2583950): No description available.

ManagementType

ManagementType(value)

[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

Values: UNDEFINED_MANAGEMENT_TYPE (0): A value indicating that the enum field is not set. MANAGED_BY_ATTACHMENT (458926411): The BGP peer is automatically created for PARTNER type InterconnectAttachment; Google will automatically create/delete this BGP peer when the PARTNER InterconnectAttachment is created/deleted, and Google will update the ipAddress and peerIpAddress when the PARTNER InterconnectAttachment is provisioned. This type of BGP peer cannot be created or deleted, but can be modified for all fields except for name, ipAddress and peerIpAddress. MANAGED_BY_USER (317294067): Default value, the BGP peer is manually created and managed by user.