Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::RouterBgpPeer.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#advertise_mode
def advertise_mode() -> ::String
Returns
- (::String) — User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.
#advertise_mode=
def advertise_mode=(value) -> ::String
Parameter
- value (::String) — User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.
Returns
- (::String) — User-specified flag to indicate which mode to use for advertisement. Check the AdvertiseMode enum for the list of possible values.
#advertised_groups
def advertised_groups() -> ::Array<::String>
Returns
- (::Array<::String>) — 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_groups=
def advertised_groups=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — 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.
Returns
- (::Array<::String>) — 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
def advertised_ip_ranges() -> ::Array<::Google::Cloud::Compute::V1::RouterAdvertisedIpRange>
Returns
- (::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_ip_ranges=
def advertised_ip_ranges=(value) -> ::Array<::Google::Cloud::Compute::V1::RouterAdvertisedIpRange>
Parameter
- value (::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.
Returns
- (::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
def advertised_route_priority() -> ::Integer
Returns
- (::Integer) — 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.
#advertised_route_priority=
def advertised_route_priority=(value) -> ::Integer
Parameter
- value (::Integer) — 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.
Returns
- (::Integer) — 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
def bfd() -> ::Google::Cloud::Compute::V1::RouterBgpPeerBfd
Returns
- (::Google::Cloud::Compute::V1::RouterBgpPeerBfd) — BFD configuration for the BGP peering.
#bfd=
def bfd=(value) -> ::Google::Cloud::Compute::V1::RouterBgpPeerBfd
Parameter
- value (::Google::Cloud::Compute::V1::RouterBgpPeerBfd) — BFD configuration for the BGP peering.
Returns
- (::Google::Cloud::Compute::V1::RouterBgpPeerBfd) — BFD configuration for the BGP peering.
#enable
def enable() -> ::String
Returns
- (::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=
def enable=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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
def enable_ipv6() -> ::Boolean
Returns
- (::Boolean) — Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
#enable_ipv6=
def enable_ipv6=(value) -> ::Boolean
Parameter
- value (::Boolean) — Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
Returns
- (::Boolean) — Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.
#interface_name
def interface_name() -> ::String
Returns
- (::String) — Name of the interface the BGP peer is associated with.
#interface_name=
def interface_name=(value) -> ::String
Parameter
- value (::String) — Name of the interface the BGP peer is associated with.
Returns
- (::String) — Name of the interface the BGP peer is associated with.
#ip_address
def ip_address() -> ::String
Returns
- (::String) — IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
#ip_address=
def ip_address=(value) -> ::String
Parameter
- value (::String) — IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
Returns
- (::String) — IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.
#ipv6_nexthop_address
def ipv6_nexthop_address() -> ::String
Returns
- (::String) — IPv6 address of the interface inside Google Cloud Platform.
#ipv6_nexthop_address=
def ipv6_nexthop_address=(value) -> ::String
Parameter
- value (::String) — IPv6 address of the interface inside Google Cloud Platform.
Returns
- (::String) — IPv6 address of the interface inside Google Cloud Platform.
#management_type
def management_type() -> ::String
Returns
- (::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.
#management_type=
def management_type=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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
def md5_authentication_key_name() -> ::String
Returns
- (::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.
#md5_authentication_key_name=
def md5_authentication_key_name=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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
def name() -> ::String
Returns
-
(::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.
#name=
def name=(value) -> ::String
Parameter
-
value (::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.
Returns
-
(::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
def peer_asn() -> ::Integer
Returns
- (::Integer) — Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
#peer_asn=
def peer_asn=(value) -> ::Integer
Parameter
- value (::Integer) — Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
Returns
- (::Integer) — Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.
#peer_ip_address
def peer_ip_address() -> ::String
Returns
- (::String) — IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
#peer_ip_address=
def peer_ip_address=(value) -> ::String
Parameter
- value (::String) — IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
Returns
- (::String) — IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.
#peer_ipv6_nexthop_address
def peer_ipv6_nexthop_address() -> ::String
Returns
- (::String) — IPv6 address of the BGP interface outside Google Cloud Platform.
#peer_ipv6_nexthop_address=
def peer_ipv6_nexthop_address=(value) -> ::String
Parameter
- value (::String) — IPv6 address of the BGP interface outside Google Cloud Platform.
Returns
- (::String) — IPv6 address of the BGP interface outside Google Cloud Platform.
#router_appliance_instance
def router_appliance_instance() -> ::String
Returns
- (::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.
#router_appliance_instance=
def router_appliance_instance=(value) -> ::String
Parameter
- value (::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.
Returns
- (::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.