Class: OCI::Core::Models::CrossConnectMapping
- Inherits:
-
Object
- Object
- OCI::Core::Models::CrossConnectMapping
- Defined in:
- lib/oci/core/models/cross_connect_mapping.rb
Overview
For use with Oracle Cloud Infrastructure FastConnect. Each VirtualCircuit runs on one or more cross-connects or cross-connect groups. A ‘CrossConnectMapping` contains the properties for an individual cross-connect or cross-connect group associated with a given virtual circuit.
The mapping includes information about the cross-connect or cross-connect group, the VLAN, and the BGP peering session.
If you’re a customer who is colocated with Oracle, that means you own both the virtual circuit and the physical connection it runs on (cross-connect or cross-connect group), so you specify all the information in the mapping. There’s one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.
If you’re a provider, then you own the physical connection that the customer’s virtual circuit runs on, so you contribute information about the cross-connect or cross-connect group and VLAN.
Who specifies the BGP peering information in the case of customer connection via provider? If the BGP session goes from Oracle to the provider’s edge router, then the provider also specifies the BGP peering information. If the BGP session instead goes from Oracle to the customer’s edge router, then the customer specifies the BGP peering information. There’s one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.
Every ‘CrossConnectMapping` must have BGP IPv4 peering addresses. BGP IPv6 peering addresses are optional. If BGP IPv6 addresses are provided, the customer can exchange IPv6 routes with Oracle.
Instance Attribute Summary collapse
-
#bgp_md5_auth_key ⇒ String
The key for BGP MD5 authentication.
-
#cross_connect_or_cross_connect_group_id ⇒ String
The OCID of the cross-connect or cross-connect group for this mapping.
-
#customer_bgp_peering_ip ⇒ String
The BGP IPv4 address for the router on the other end of the BGP session from Oracle.
-
#customer_bgp_peering_ipv6 ⇒ String
The BGP IPv6 address for the router on the other end of the BGP session from Oracle.
-
#oracle_bgp_peering_ip ⇒ String
The IPv4 address for Oracle’s end of the BGP session.
-
#oracle_bgp_peering_ipv6 ⇒ String
The IPv6 address for Oracle’s end of the BGP session.
-
#vlan ⇒ Integer
The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CrossConnectMapping
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ CrossConnectMapping
Initializes the object
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 156 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.bgp_md5_auth_key = attributes[:'bgpMd5AuthKey'] if attributes[:'bgpMd5AuthKey'] raise 'You cannot provide both :bgpMd5AuthKey and :bgp_md5_auth_key' if attributes.key?(:'bgpMd5AuthKey') && attributes.key?(:'bgp_md5_auth_key') self.bgp_md5_auth_key = attributes[:'bgp_md5_auth_key'] if attributes[:'bgp_md5_auth_key'] self.cross_connect_or_cross_connect_group_id = attributes[:'crossConnectOrCrossConnectGroupId'] if attributes[:'crossConnectOrCrossConnectGroupId'] raise 'You cannot provide both :crossConnectOrCrossConnectGroupId and :cross_connect_or_cross_connect_group_id' if attributes.key?(:'crossConnectOrCrossConnectGroupId') && attributes.key?(:'cross_connect_or_cross_connect_group_id') self.cross_connect_or_cross_connect_group_id = attributes[:'cross_connect_or_cross_connect_group_id'] if attributes[:'cross_connect_or_cross_connect_group_id'] self.customer_bgp_peering_ip = attributes[:'customerBgpPeeringIp'] if attributes[:'customerBgpPeeringIp'] raise 'You cannot provide both :customerBgpPeeringIp and :customer_bgp_peering_ip' if attributes.key?(:'customerBgpPeeringIp') && attributes.key?(:'customer_bgp_peering_ip') self.customer_bgp_peering_ip = attributes[:'customer_bgp_peering_ip'] if attributes[:'customer_bgp_peering_ip'] self.oracle_bgp_peering_ip = attributes[:'oracleBgpPeeringIp'] if attributes[:'oracleBgpPeeringIp'] raise 'You cannot provide both :oracleBgpPeeringIp and :oracle_bgp_peering_ip' if attributes.key?(:'oracleBgpPeeringIp') && attributes.key?(:'oracle_bgp_peering_ip') self.oracle_bgp_peering_ip = attributes[:'oracle_bgp_peering_ip'] if attributes[:'oracle_bgp_peering_ip'] self.customer_bgp_peering_ipv6 = attributes[:'customerBgpPeeringIpv6'] if attributes[:'customerBgpPeeringIpv6'] raise 'You cannot provide both :customerBgpPeeringIpv6 and :customer_bgp_peering_ipv6' if attributes.key?(:'customerBgpPeeringIpv6') && attributes.key?(:'customer_bgp_peering_ipv6') self.customer_bgp_peering_ipv6 = attributes[:'customer_bgp_peering_ipv6'] if attributes[:'customer_bgp_peering_ipv6'] self.oracle_bgp_peering_ipv6 = attributes[:'oracleBgpPeeringIpv6'] if attributes[:'oracleBgpPeeringIpv6'] raise 'You cannot provide both :oracleBgpPeeringIpv6 and :oracle_bgp_peering_ipv6' if attributes.key?(:'oracleBgpPeeringIpv6') && attributes.key?(:'oracle_bgp_peering_ipv6') self.oracle_bgp_peering_ipv6 = attributes[:'oracle_bgp_peering_ipv6'] if attributes[:'oracle_bgp_peering_ipv6'] self.vlan = attributes[:'vlan'] if attributes[:'vlan'] end |
Instance Attribute Details
#bgp_md5_auth_key ⇒ String
The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don’t use BGP MD5 authentication.
43 44 45 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 43 def bgp_md5_auth_key @bgp_md5_auth_key end |
#cross_connect_or_cross_connect_group_id ⇒ String
The OCID of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).
51 52 53 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 51 def cross_connect_or_cross_connect_group_id @cross_connect_or_cross_connect_group_id end |
#customer_bgp_peering_ip ⇒ String
The BGP IPv4 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer’s edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider’s edge router. Must use a /30 or /31 subnet mask.
There’s one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.
Example: ‘10.0.0.18/31`
64 65 66 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 64 def customer_bgp_peering_ip @customer_bgp_peering_ip end |
#customer_bgp_peering_ipv6 ⇒ String
The BGP IPv6 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer’s edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider’s edge router. Only subnet masks from /64 up to /127 are allowed.
There’s one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.
Example: ‘2001:db8::1/64`
89 90 91 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 89 def customer_bgp_peering_ipv6 @customer_bgp_peering_ipv6 end |
#oracle_bgp_peering_ip ⇒ String
The IPv4 address for Oracle’s end of the BGP session. Must use a /30 or /31 subnet mask. If the session goes from Oracle to a customer’s edge router, the customer specifies this information. If the session goes from Oracle to a provider’s edge router, the provider specifies this.
There’s one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.
Example: ‘10.0.0.19/31`
76 77 78 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 76 def oracle_bgp_peering_ip @oracle_bgp_peering_ip end |
#oracle_bgp_peering_ipv6 ⇒ String
The IPv6 address for Oracle’s end of the BGP session. Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer’s edge router, the customer specifies this information. If the session goes from Oracle to a provider’s edge router, the provider specifies this.
There’s one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.
Example: ‘2001:db8::2/64`
101 102 103 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 101 def oracle_bgp_peering_ipv6 @oracle_bgp_peering_ipv6 end |
#vlan ⇒ Integer
The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).
Example: ‘200`
111 112 113 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 111 def vlan @vlan end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 114 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'bgp_md5_auth_key': :'bgpMd5AuthKey', 'cross_connect_or_cross_connect_group_id': :'crossConnectOrCrossConnectGroupId', 'customer_bgp_peering_ip': :'customerBgpPeeringIp', 'oracle_bgp_peering_ip': :'oracleBgpPeeringIp', 'customer_bgp_peering_ipv6': :'customerBgpPeeringIpv6', 'oracle_bgp_peering_ipv6': :'oracleBgpPeeringIpv6', 'vlan': :'vlan' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
129 130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 129 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'bgp_md5_auth_key': :'String', 'cross_connect_or_cross_connect_group_id': :'String', 'customer_bgp_peering_ip': :'String', 'oracle_bgp_peering_ip': :'String', 'customer_bgp_peering_ipv6': :'String', 'oracle_bgp_peering_ipv6': :'String', 'vlan': :'Integer' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 208 def ==(other) return true if equal?(other) self.class == other.class && bgp_md5_auth_key == other.bgp_md5_auth_key && cross_connect_or_cross_connect_group_id == other.cross_connect_or_cross_connect_group_id && customer_bgp_peering_ip == other.customer_bgp_peering_ip && oracle_bgp_peering_ip == other.oracle_bgp_peering_ip && customer_bgp_peering_ipv6 == other.customer_bgp_peering_ipv6 && oracle_bgp_peering_ipv6 == other.oracle_bgp_peering_ipv6 && vlan == other.vlan end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 244 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
224 225 226 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 224 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
233 234 235 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 233 def hash [bgp_md5_auth_key, cross_connect_or_cross_connect_group_id, customer_bgp_peering_ip, oracle_bgp_peering_ip, customer_bgp_peering_ipv6, oracle_bgp_peering_ipv6, vlan].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
277 278 279 280 281 282 283 284 285 286 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 277 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
271 272 273 |
# File 'lib/oci/core/models/cross_connect_mapping.rb', line 271 def to_s to_hash.to_s end |