Show / Hide Table of Contents

Class RouterBgpPeer

Inheritance
object
RouterBgpPeer
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Compute.alpha.Data
Assembly: Google.Apis.Compute.alpha.dll
Syntax
public class RouterBgpPeer : IDirectResponseSchema

Properties

AdvertiseMode

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

Declaration
[JsonProperty("advertiseMode")]
public virtual string AdvertiseMode { get; set; }
Property Value
Type Description
string

AdvertisedGroups

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.

Declaration
[JsonProperty("advertisedGroups")]
public virtual IList<string> AdvertisedGroups { get; set; }
Property Value
Type Description
IList<string>

AdvertisedIpRanges

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.

Declaration
[JsonProperty("advertisedIpRanges")]
public virtual IList<RouterAdvertisedIpRange> AdvertisedIpRanges { get; set; }
Property Value
Type Description
IList<RouterAdvertisedIpRange>

AdvertisedRoutePriority

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.

Declaration
[JsonProperty("advertisedRoutePriority")]
public virtual long? AdvertisedRoutePriority { get; set; }
Property Value
Type Description
long?

Bfd

BFD configuration for the BGP peering.

Declaration
[JsonProperty("bfd")]
public virtual RouterBgpPeerBfd Bfd { get; set; }
Property Value
Type Description
RouterBgpPeerBfd

CustomLearnedIpRanges

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

Declaration
[JsonProperty("customLearnedIpRanges")]
public virtual IList<RouterBgpPeerCustomLearnedIpRange> CustomLearnedIpRanges { get; set; }
Property Value
Type Description
IList<RouterBgpPeerCustomLearnedIpRange>

CustomLearnedRoutePriority

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.

Declaration
[JsonProperty("customLearnedRoutePriority")]
public virtual int? CustomLearnedRoutePriority { get; set; }
Property Value
Type Description
int?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Enable

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.

Declaration
[JsonProperty("enable")]
public virtual string Enable { get; set; }
Property Value
Type Description
string

EnableIpv4

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

Declaration
[JsonProperty("enableIpv4")]
public virtual bool? EnableIpv4 { get; set; }
Property Value
Type Description
bool?

EnableIpv6

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

Declaration
[JsonProperty("enableIpv6")]
public virtual bool? EnableIpv6 { get; set; }
Property Value
Type Description
bool?

ExportPolicies

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.

Declaration
[JsonProperty("exportPolicies")]
public virtual IList<string> ExportPolicies { get; set; }
Property Value
Type Description
IList<string>

ImportPolicies

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.

Declaration
[JsonProperty("importPolicies")]
public virtual IList<string> ImportPolicies { get; set; }
Property Value
Type Description
IList<string>

InterfaceName

Name of the interface the BGP peer is associated with.

Declaration
[JsonProperty("interfaceName")]
public virtual string InterfaceName { get; set; }
Property Value
Type Description
string

IpAddress

IP address of the interface inside Google Cloud Platform.

Declaration
[JsonProperty("ipAddress")]
public virtual string IpAddress { get; set; }
Property Value
Type Description
string

Ipv4NexthopAddress

IPv4 address of the interface inside Google Cloud Platform.

Declaration
[JsonProperty("ipv4NexthopAddress")]
public virtual string Ipv4NexthopAddress { get; set; }
Property Value
Type Description
string

Ipv6NexthopAddress

IPv6 address of the interface inside Google Cloud Platform.

Declaration
[JsonProperty("ipv6NexthopAddress")]
public virtual string Ipv6NexthopAddress { get; set; }
Property Value
Type Description
string

ManagementType

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

Declaration
[JsonProperty("managementType")]
public virtual string ManagementType { get; set; }
Property Value
Type Description
string

Md5AuthenticationKeyName

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.

Declaration
[JsonProperty("md5AuthenticationKeyName")]
public virtual string Md5AuthenticationKeyName { get; set; }
Property Value
Type Description
string

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

PeerAsn

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

Declaration
[JsonProperty("peerAsn")]
public virtual long? PeerAsn { get; set; }
Property Value
Type Description
long?

PeerIpAddress

IP address of the BGP interface outside Google Cloud Platform.

Declaration
[JsonProperty("peerIpAddress")]
public virtual string PeerIpAddress { get; set; }
Property Value
Type Description
string

PeerIpv4NexthopAddress

IPv4 address of the BGP interface outside Google Cloud Platform.

Declaration
[JsonProperty("peerIpv4NexthopAddress")]
public virtual string PeerIpv4NexthopAddress { get; set; }
Property Value
Type Description
string

PeerIpv6NexthopAddress

IPv6 address of the BGP interface outside Google Cloud Platform.

Declaration
[JsonProperty("peerIpv6NexthopAddress")]
public virtual string PeerIpv6NexthopAddress { get; set; }
Property Value
Type Description
string

RouterApplianceInstance

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.

Declaration
[JsonProperty("routerApplianceInstance")]
public virtual string RouterApplianceInstance { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX