Reference documentation and code samples for the Compute V1 Client class RouterBgpPeer.
Generated from protobuf message google.cloud.compute.v1.RouterBgpPeer
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ advertise_mode
string
User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.
↳ advertised_groups
array
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
array< Google\Cloud\Compute\V1\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.
↳ bfd
↳ enable
string
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.
↳ enable_ipv6
bool
Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
↳ interface_name
string
Name of the interface the BGP peer is associated with.
↳ ip_address
string
IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
↳ ipv6_nexthop_address
string
IPv6 address of the interface inside Google Cloud Platform.
↳ management_type
string
[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.
↳ md5_authentication_key_name
string
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
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.
↳ peer_asn
int
Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
↳ peer_ip_address
string
IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
↳ peer_ipv6_nexthop_address
string
IPv6 address of the BGP interface outside Google Cloud Platform.
↳ router_appliance_instance
string
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.
getAdvertiseMode
User-specified flag to indicate which mode to use for advertisement.
Check the AdvertiseMode enum for the list of possible values.
string
hasAdvertiseMode
clearAdvertiseMode
setAdvertiseMode
User-specified flag to indicate which mode to use for advertisement.
Check the AdvertiseMode enum for the list of possible values.
var
string
$this
getAdvertisedGroups
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.
setAdvertisedGroups
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.
var
string[]
$this
getAdvertisedIpRanges
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.
setAdvertisedIpRanges
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.
$this
getAdvertisedRoutePriority
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.
int
hasAdvertisedRoutePriority
clearAdvertisedRoutePriority
setAdvertisedRoutePriority
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.
var
int
$this
getBfd
BFD configuration for the BGP peering.
hasBfd
clearBfd
setBfd
BFD configuration for the BGP peering.
$this
getEnable
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.
string
hasEnable
clearEnable
setEnable
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.
var
string
$this
getEnableIpv6
Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
bool
hasEnableIpv6
clearEnableIpv6
setEnableIpv6
Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
var
bool
$this
getInterfaceName
Name of the interface the BGP peer is associated with.
string
hasInterfaceName
clearInterfaceName
setInterfaceName
Name of the interface the BGP peer is associated with.
var
string
$this
getIpAddress
IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
string
hasIpAddress
clearIpAddress
setIpAddress
IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
var
string
$this
getIpv6NexthopAddress
IPv6 address of the interface inside Google Cloud Platform.
string
hasIpv6NexthopAddress
clearIpv6NexthopAddress
setIpv6NexthopAddress
IPv6 address of the interface inside Google Cloud Platform.
var
string
$this
getManagementType
[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.
string
hasManagementType
clearManagementType
setManagementType
[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.
var
string
$this
getMd5AuthenticationKeyName
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.
string
hasMd5AuthenticationKeyName
clearMd5AuthenticationKeyName
setMd5AuthenticationKeyName
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.
var
string
$this
getName
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.
string
hasName
clearName
setName
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.
var
string
$this
getPeerAsn
Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
int
hasPeerAsn
clearPeerAsn
setPeerAsn
Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
var
int
$this
getPeerIpAddress
IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
string
hasPeerIpAddress
clearPeerIpAddress
setPeerIpAddress
IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
var
string
$this
getPeerIpv6NexthopAddress
IPv6 address of the BGP interface outside Google Cloud Platform.
string
hasPeerIpv6NexthopAddress
clearPeerIpv6NexthopAddress
setPeerIpv6NexthopAddress
IPv6 address of the BGP interface outside Google Cloud Platform.
var
string
$this
getRouterApplianceInstance
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.
string
hasRouterApplianceInstance
clearRouterApplianceInstance
setRouterApplianceInstance
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.
var
string
$this
