Class: Google::Apis::ComputeV1::RouterBgpPeer

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RouterBgpPeer

Returns a new instance of RouterBgpPeer.



53314
53315
53316
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53314

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

User-specified flag to indicate which mode to use for advertisement. Corresponds to the JSON property advertiseMode

Returns:

  • (String) 


53144
53145
53146
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53144

def advertise_mode
  @advertise_mode
end

#advertised_groups ⇒ 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. Corresponds to the JSON property advertisedGroups

Returns:

  • (Array<String>) 


53158
53159
53160
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53158

def advertised_groups
  @advertised_groups
end

#advertised_ip_ranges ⇒ Array<Google::Apis::ComputeV1::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. Corresponds to the JSON property advertisedIpRanges

Returns:



53167
53168
53169
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53167

def advertised_ip_ranges
  @advertised_ip_ranges
end

#advertised_route_priority ⇒ Fixnum

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. Corresponds to the JSON property advertisedRoutePriority

Returns:

  • (Fixnum) 


53174
53175
53176
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53174

def advertised_route_priority
  @advertised_route_priority
end

#bfd ⇒ Google::Apis::ComputeV1::RouterBgpPeerBfd

BFD configuration for the BGP peering. Corresponds to the JSON property bfd

Returns:



53179
53180
53181
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53179

def bfd
  @bfd
end

#custom_learned_ip_ranges ⇒ Array<Google::Apis::ComputeV1::RouterBgpPeerCustomLearnedIpRange>

A list of user-defined custom learned route IP address ranges for a BGP session. Corresponds to the JSON property customLearnedIpRanges

Returns:



53185
53186
53187
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53185

def custom_learned_ip_ranges
  @custom_learned_ip_ranges
end

#custom_learned_route_priority ⇒ Fixnum

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. Corresponds to the JSON property customLearnedRoutePriority

Returns:

  • (Fixnum) 


53193
53194
53195
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53193

def custom_learned_route_priority
  @custom_learned_route_priority
end

#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. Corresponds to the JSON property enable

Returns:

  • (String) 


53202
53203
53204
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53202

def enable
  @enable
end

#enable_ipv4 ⇒ Boolean Also known as: enable_ipv4?

Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4. Corresponds to the JSON property enableIpv4

Returns:

  • (Boolean) 


53208
53209
53210
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53208

def enable_ipv4
  @enable_ipv4
end

#enable_ipv6 ⇒ Boolean Also known as: enable_ipv6?

Enable IPv6 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 6. Corresponds to the JSON property enableIpv6

Returns:

  • (Boolean) 


53215
53216
53217
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53215

def enable_ipv6
  @enable_ipv6
end

#export_policies ⇒ Array<String>

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. Corresponds to the JSON property exportPolicies

Returns:

  • (Array<String>) 


53223
53224
53225
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53223

def export_policies
  @export_policies
end

#import_policies ⇒ Array<String>

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. Corresponds to the JSON property importPolicies

Returns:

  • (Array<String>) 


53230
53231
53232
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53230

def import_policies
  @import_policies
end

#interface_name ⇒ String

Name of the interface the BGP peer is associated with. Corresponds to the JSON property interfaceName

Returns:

  • (String) 


53235
53236
53237
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53235

def interface_name
  @interface_name
end

#ip_address ⇒ String

IP address of the interface inside Google Cloud Platform. Corresponds to the JSON property ipAddress

Returns:

  • (String) 


53240
53241
53242
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53240

def ip_address
  @ip_address
end

#ipv4_nexthop_address ⇒ String

IPv4 address of the interface inside Google Cloud Platform. Corresponds to the JSON property ipv4NexthopAddress

Returns:

  • (String) 


53245
53246
53247
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53245

def ipv4_nexthop_address
  @ipv4_nexthop_address
end

#ipv6_nexthop_address ⇒ String

IPv6 address of the interface inside Google Cloud Platform. Corresponds to the JSON property ipv6NexthopAddress

Returns:

  • (String) 


53250
53251
53252
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53250

def ipv6_nexthop_address
  @ipv6_nexthop_address
end

#management_type ⇒ String

Output only. [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. Corresponds to the JSON property managementType

Returns:

  • (String) 


53264
53265
53266
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53264

def management_type
  @management_type
end

#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. Corresponds to the JSON property md5AuthenticationKeyName

Returns:

  • (String) 


53271
53272
53273
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53271

def md5_authentication_key_name
  @md5_authentication_key_name
end

#name ⇒ String

Name of this BGP peer. The name must be 1-63 characters long, and comply withRFC1035. 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. Corresponds to the JSON property name

Returns:

  • (String) 


53282
53283
53284
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53282

def name
  @name
end

#peer_asn ⇒ Fixnum

Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value. Corresponds to the JSON property peerAsn

Returns:

  • (Fixnum) 


53288
53289
53290
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53288

def peer_asn
  @peer_asn
end

#peer_ip_address ⇒ String

IP address of the BGP interface outside Google Cloud Platform. Corresponds to the JSON property peerIpAddress

Returns:

  • (String) 


53293
53294
53295
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53293

def peer_ip_address
  @peer_ip_address
end

#peer_ipv4_nexthop_address ⇒ String

IPv4 address of the BGP interface outside Google Cloud Platform. Corresponds to the JSON property peerIpv4NexthopAddress

Returns:

  • (String) 


53298
53299
53300
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53298

def peer_ipv4_nexthop_address
  @peer_ipv4_nexthop_address
end

#peer_ipv6_nexthop_address ⇒ String

IPv6 address of the BGP interface outside Google Cloud Platform. Corresponds to the JSON property peerIpv6NexthopAddress

Returns:

  • (String) 


53303
53304
53305
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53303

def peer_ipv6_nexthop_address
  @peer_ipv6_nexthop_address
end

#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. Corresponds to the JSON property routerApplianceInstance

Returns:

  • (String) 


53312
53313
53314
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53312

def router_appliance_instance
  @router_appliance_instance
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



53319
53320
53321
53322
53323
53324
53325
53326
53327
53328
53329
53330
53331
53332
53333
53334
53335
53336
53337
53338
53339
53340
53341
53342
53343
53344
 
# File 'lib/google/apis/compute_v1/classes.rb', line 53319

def update!(**args)
  @advertise_mode = args[:advertise_mode] if args.key?(:advertise_mode)
  @advertised_groups = args[:advertised_groups] if args.key?(:advertised_groups)
  @advertised_ip_ranges = args[:advertised_ip_ranges] if args.key?(:advertised_ip_ranges)
  @advertised_route_priority = args[:advertised_route_priority] if args.key?(:advertised_route_priority)
  @bfd = args[:bfd] if args.key?(:bfd)
  @custom_learned_ip_ranges = args[:custom_learned_ip_ranges] if args.key?(:custom_learned_ip_ranges)
  @custom_learned_route_priority = args[:custom_learned_route_priority] if args.key?(:custom_learned_route_priority)
  @enable = args[:enable] if args.key?(:enable)
  @enable_ipv4 = args[:enable_ipv4] if args.key?(:enable_ipv4)
  @enable_ipv6 = args[:enable_ipv6] if args.key?(:enable_ipv6)
  @export_policies = args[:export_policies] if args.key?(:export_policies)
  @import_policies = args[:import_policies] if args.key?(:import_policies)
  @interface_name = args[:interface_name] if args.key?(:interface_name)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @ipv4_nexthop_address = args[:ipv4_nexthop_address] if args.key?(:ipv4_nexthop_address)
  @ipv6_nexthop_address = args[:ipv6_nexthop_address] if args.key?(:ipv6_nexthop_address)
  @management_type = args[:management_type] if args.key?(:management_type)
  @md5_authentication_key_name = args[:md5_authentication_key_name] if args.key?(:md5_authentication_key_name)
  @name = args[:name] if args.key?(:name)
  @peer_asn = args[:peer_asn] if args.key?(:peer_asn)
  @peer_ip_address = args[:peer_ip_address] if args.key?(:peer_ip_address)
  @peer_ipv4_nexthop_address = args[:peer_ipv4_nexthop_address] if args.key?(:peer_ipv4_nexthop_address)
  @peer_ipv6_nexthop_address = args[:peer_ipv6_nexthop_address] if args.key?(:peer_ipv6_nexthop_address)
  @router_appliance_instance = args[:router_appliance_instance] if args.key?(:router_appliance_instance)
end