RouterBgpPeer

import type { RouterBgpPeer } from "https://googleapis.deno.dev/v1/compute:v1.ts";

interface RouterBgpPeer {

advertisedGroups?: "ALL_SUBNETS"[];

advertisedIpRanges?: RouterAdvertisedIpRange[];

advertisedRoutePriority?: number;

advertiseMode?: "CUSTOM" | "DEFAULT";

bfd?: RouterBgpPeerBfd;

customLearnedIpRanges?: RouterBgpPeerCustomLearnedIpRange[];

customLearnedRoutePriority?: number;

enable?: "FALSE" | "TRUE";

enableIpv4?: boolean;

enableIpv6?: boolean;

exportPolicies?: string[];

importPolicies?: string[];

interfaceName?: string;

ipAddress?: string;

ipv4NexthopAddress?: string;

ipv6NexthopAddress?: string;

managementType?: "MANAGED_BY_ATTACHMENT" | "MANAGED_BY_USER";

md5AuthenticationKeyName?: string;

name?: string;

peerAsn?: number;

peerIpAddress?: string;

peerIpv4NexthopAddress?: string;

peerIpv6NexthopAddress?: string;

routerApplianceInstance?: string;

}

§Properties

advertisedGroups?: "ALL_SUBNETS"[]

[src]

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.

advertisedIpRanges?: RouterAdvertisedIpRange[]

[src]

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.

advertisedRoutePriority?: number

[src]

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.

advertiseMode?: "CUSTOM" | "DEFAULT"

[src]

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

bfd?: RouterBgpPeerBfd

[src]

BFD configuration for the BGP peering.

customLearnedIpRanges?: RouterBgpPeerCustomLearnedIpRange[]

[src]

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

customLearnedRoutePriority?: number

[src]

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.

enable?: "FALSE" | "TRUE"

[src]

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.

enableIpv4?: boolean

[src]

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

enableIpv6?: boolean

[src]

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

exportPolicies?: string[]

[src]

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.

importPolicies?: string[]

[src]

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.

interfaceName?: string

[src]

Name of the interface the BGP peer is associated with.

ipAddress?: string

[src]

IP address of the interface inside Google Cloud Platform.

ipv4NexthopAddress?: string

[src]

IPv4 address of the interface inside Google Cloud Platform.

ipv6NexthopAddress?: string

[src]

IPv6 address of the interface inside Google Cloud Platform.

managementType?: "MANAGED_BY_ATTACHMENT" | "MANAGED_BY_USER"

[src]

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

md5AuthenticationKeyName?: string

[src]

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.

name?: string

[src]

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.

peerAsn?: number

[src]

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

peerIpAddress?: string

[src]

IP address of the BGP interface outside Google Cloud Platform.

peerIpv4NexthopAddress?: string

[src]

IPv4 address of the BGP interface outside Google Cloud Platform.

peerIpv6NexthopAddress?: string

[src]

IPv6 address of the BGP interface outside Google Cloud Platform.

routerApplianceInstance?: string

[src]

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.