Compute Engine v1 API - Class RouterBgpPeer (2.16.0) 

public sealed class RouterBgpPeer : IMessage<RouterBgpPeer>, IEquatable<RouterBgpPeer>, IDeepCloneable<RouterBgpPeer>, IBufferMessage, IMessage

Inheritance

object > RouterBgpPeer

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

RouterBgpPeer()

public RouterBgpPeer()

RouterBgpPeer(RouterBgpPeer)

public RouterBgpPeer(RouterBgpPeer other)
Parameter
Name Description
other RouterBgpPeer

Properties

AdvertiseMode

public string AdvertiseMode { get; set; }

User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.

Property Value
Type Description
string

AdvertisedGroups

public RepeatedField<string> AdvertisedGroups { get; }

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.

Property Value
Type Description
RepeatedFieldstring

AdvertisedIpRanges

public RepeatedField<RouterAdvertisedIpRange> AdvertisedIpRanges { get; }

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.

Property Value
Type Description
RepeatedFieldRouterAdvertisedIpRange

AdvertisedRoutePriority

public uint AdvertisedRoutePriority { get; set; }

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.

Property Value
Type Description
uint

Bfd

public RouterBgpPeerBfd Bfd { get; set; }

BFD configuration for the BGP peering.

Property Value
Type Description
RouterBgpPeerBfd

CustomLearnedIpRanges

public RepeatedField<RouterBgpPeerCustomLearnedIpRange> CustomLearnedIpRanges { get; }

A list of user-defined custom learned route IP address ranges for a BGP session.

Property Value
Type Description
RepeatedFieldRouterBgpPeerCustomLearnedIpRange

CustomLearnedRoutePriority

public int CustomLearnedRoutePriority { get; set; }

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.

Property Value
Type Description
int

Enable

public string Enable { get; set; }

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.

Property Value
Type Description
string

EnableIpv4

public bool EnableIpv4 { get; set; }

Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.

Property Value
Type Description
bool

EnableIpv6

public bool EnableIpv6 { get; set; }

Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6.

Property Value
Type Description
bool

ExportPolicies

public RepeatedField<string> ExportPolicies { get; }

List of export policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_EXPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.

Property Value
Type Description
RepeatedFieldstring

HasAdvertiseMode

public bool HasAdvertiseMode { get; }

Gets whether the "advertise_mode" field is set

Property Value
Type Description
bool

HasAdvertisedRoutePriority

public bool HasAdvertisedRoutePriority { get; }

Gets whether the "advertised_route_priority" field is set

Property Value
Type Description
bool

HasCustomLearnedRoutePriority

public bool HasCustomLearnedRoutePriority { get; }

Gets whether the "custom_learned_route_priority" field is set

Property Value
Type Description
bool

HasEnable

public bool HasEnable { get; }

Gets whether the "enable" field is set

Property Value
Type Description
bool

HasEnableIpv4

public bool HasEnableIpv4 { get; }

Gets whether the "enable_ipv4" field is set

Property Value
Type Description
bool

HasEnableIpv6

public bool HasEnableIpv6 { get; }

Gets whether the "enable_ipv6" field is set

Property Value
Type Description
bool

HasInterfaceName

public bool HasInterfaceName { get; }

Gets whether the "interface_name" field is set

Property Value
Type Description
bool

HasIpAddress

public bool HasIpAddress { get; }

Gets whether the "ip_address" field is set

Property Value
Type Description
bool

HasIpv4NexthopAddress

public bool HasIpv4NexthopAddress { get; }

Gets whether the "ipv4_nexthop_address" field is set

Property Value
Type Description
bool

HasIpv6NexthopAddress

public bool HasIpv6NexthopAddress { get; }

Gets whether the "ipv6_nexthop_address" field is set

Property Value
Type Description
bool

HasManagementType

public bool HasManagementType { get; }

Gets whether the "management_type" field is set

Property Value
Type Description
bool

HasMd5AuthenticationKeyName

public bool HasMd5AuthenticationKeyName { get; }

Gets whether the "md5_authentication_key_name" field is set

Property Value
Type Description
bool

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type Description
bool

HasPeerAsn

public bool HasPeerAsn { get; }

Gets whether the "peer_asn" field is set

Property Value
Type Description
bool

HasPeerIpAddress

public bool HasPeerIpAddress { get; }

Gets whether the "peer_ip_address" field is set

Property Value
Type Description
bool

HasPeerIpv4NexthopAddress

public bool HasPeerIpv4NexthopAddress { get; }

Gets whether the "peer_ipv4_nexthop_address" field is set

Property Value
Type Description
bool

HasPeerIpv6NexthopAddress

public bool HasPeerIpv6NexthopAddress { get; }

Gets whether the "peer_ipv6_nexthop_address" field is set

Property Value
Type Description
bool

HasRouterApplianceInstance

public bool HasRouterApplianceInstance { get; }

Gets whether the "router_appliance_instance" field is set

Property Value
Type Description
bool

ImportPolicies

public RepeatedField<string> ImportPolicies { get; }

List of import policies applied to this peer, in the order they must be evaluated. The name must correspond to an existing policy that has ROUTE_POLICY_TYPE_IMPORT type. Note that Route Policies are currently available in preview. Please use Beta API to use Route Policies.

Property Value
Type Description
RepeatedFieldstring

InterfaceName

public string InterfaceName { get; set; }

Name of the interface the BGP peer is associated with.

Property Value
Type Description
string

IpAddress

public string IpAddress { get; set; }

IP address of the interface inside Google Cloud Platform.

Property Value
Type Description
string

Ipv4NexthopAddress

public string Ipv4NexthopAddress { get; set; }

IPv4 address of the interface inside Google Cloud Platform.

Property Value
Type Description
string

Ipv6NexthopAddress

public string Ipv6NexthopAddress { get; set; }

IPv6 address of the interface inside Google Cloud Platform.

Property Value
Type Description
string

ManagementType

public string ManagementType { get; set; }

[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.

Property Value
Type Description
string

Md5AuthenticationKeyName

public string Md5AuthenticationKeyName { get; set; }

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.

Property Value
Type Description
string

Name

public string Name { get; set; }

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.

Property Value
Type Description
string

PeerAsn

public uint PeerAsn { get; set; }

Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

Property Value
Type Description
uint

PeerIpAddress

public string PeerIpAddress { get; set; }

IP address of the BGP interface outside Google Cloud Platform.

Property Value
Type Description
string

PeerIpv4NexthopAddress

public string PeerIpv4NexthopAddress { get; set; }

IPv4 address of the BGP interface outside Google Cloud Platform.

Property Value
Type Description
string

PeerIpv6NexthopAddress

public string PeerIpv6NexthopAddress { get; set; }

IPv6 address of the BGP interface outside Google Cloud Platform.

Property Value
Type Description
string

RouterApplianceInstance

public string RouterApplianceInstance { get; set; }

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.

Property Value
Type Description
string