Class: OCI::VnMonitoring::Models::IPSecConnection
- Inherits:
-
Object
- Object
- OCI::VnMonitoring::Models::IPSecConnection
- Defined in:
- lib/oci/vn_monitoring/models/ip_sec_connection.rb
Overview
A connection between a DRG and CPE. This connection consists of multiple IPSec tunnels. Creating this connection is one of the steps required when setting up a Site-to-Site VPN.
Important: Each tunnel in an IPSec connection can use either static routing or BGP dynamic routing (see the IPSecConnectionTunnel object's routing
attribute). Originally only static routing was supported and every IPSec connection was required to have at least one static route configured. To maintain backward compatibility in the API when support for BPG dynamic routing was introduced, the API accepts an empty list of static routes if you configure both of the IPSec tunnels to use BGP dynamic routing. If you switch a tunnel's routing from BGP
to STATIC
, you must first ensure that the IPSec connection is configured with at least one valid CIDR block static route. Oracle uses the IPSec connection's static routes when routing a tunnel's traffic only if that tunnel's routing
attribute = STATIC
. Otherwise the static routes are ignored.
For more information about the workflow for setting up an IPSec connection, see Site-to-Site VPN Overview.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze, LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze, LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze, LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- CPE_LOCAL_IDENTIFIER_TYPE_ENUM =
[ CPE_LOCAL_IDENTIFIER_TYPE_IP_ADDRESS = 'IP_ADDRESS'.freeze, CPE_LOCAL_IDENTIFIER_TYPE_HOSTNAME = 'HOSTNAME'.freeze, CPE_LOCAL_IDENTIFIER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- TRANSPORT_TYPE_ENUM =
[ TRANSPORT_TYPE_INTERNET = 'INTERNET'.freeze, TRANSPORT_TYPE_FASTCONNECT = 'FASTCONNECT'.freeze, TRANSPORT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the IPSec connection.
- #cpe_id ⇒ String
-
#cpe_local_identifier ⇒ String
Your identifier for your CPE device.
-
#cpe_local_identifier_type ⇒ String
The type of identifier for your CPE device.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user-friendly name.
-
#drg_id ⇒ String
[Required] The OCID of the DRG.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The IPSec connection's Oracle ID (OCID).
-
#lifecycle_state ⇒ String
[Required] The IPSec connection's current state.
-
#static_routes ⇒ Array<String>
[Required] Static routes to the CPE.
-
#time_created ⇒ DateTime
The date and time the IPSec connection was created, in the format defined by RFC3339.
-
#transport_type ⇒ String
The transport type used for the IPSec connection.
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 = {}) ⇒ IPSecConnection
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 = {}) ⇒ IPSecConnection
Initializes the object
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 205 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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.cpe_id = attributes[:'cpeId'] if attributes[:'cpeId'] raise 'You cannot provide both :cpeId and :cpe_id' if attributes.key?(:'cpeId') && attributes.key?(:'cpe_id') self.cpe_id = attributes[:'cpe_id'] if attributes[:'cpe_id'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.drg_id = attributes[:'drgId'] if attributes[:'drgId'] raise 'You cannot provide both :drgId and :drg_id' if attributes.key?(:'drgId') && attributes.key?(:'drg_id') self.drg_id = attributes[:'drg_id'] if attributes[:'drg_id'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.id = attributes[:'id'] if attributes[:'id'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.cpe_local_identifier = attributes[:'cpeLocalIdentifier'] if attributes[:'cpeLocalIdentifier'] raise 'You cannot provide both :cpeLocalIdentifier and :cpe_local_identifier' if attributes.key?(:'cpeLocalIdentifier') && attributes.key?(:'cpe_local_identifier') self.cpe_local_identifier = attributes[:'cpe_local_identifier'] if attributes[:'cpe_local_identifier'] self.cpe_local_identifier_type = attributes[:'cpeLocalIdentifierType'] if attributes[:'cpeLocalIdentifierType'] raise 'You cannot provide both :cpeLocalIdentifierType and :cpe_local_identifier_type' if attributes.key?(:'cpeLocalIdentifierType') && attributes.key?(:'cpe_local_identifier_type') self.cpe_local_identifier_type = attributes[:'cpe_local_identifier_type'] if attributes[:'cpe_local_identifier_type'] self.static_routes = attributes[:'staticRoutes'] if attributes[:'staticRoutes'] raise 'You cannot provide both :staticRoutes and :static_routes' if attributes.key?(:'staticRoutes') && attributes.key?(:'static_routes') self.static_routes = attributes[:'static_routes'] if attributes[:'static_routes'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.transport_type = attributes[:'transportType'] if attributes[:'transportType'] self.transport_type = "INTERNET" if transport_type.nil? && !attributes.key?(:'transportType') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :transportType and :transport_type' if attributes.key?(:'transportType') && attributes.key?(:'transport_type') self.transport_type = attributes[:'transport_type'] if attributes[:'transport_type'] self.transport_type = "INTERNET" if transport_type.nil? && !attributes.key?(:'transportType') && !attributes.key?(:'transport_type') # rubocop:disable Style/StringLiterals end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the IPSec connection.
55 56 57 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 55 def compartment_id @compartment_id end |
#cpe_id ⇒ String
59 60 61 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 59 def cpe_id @cpe_id end |
#cpe_local_identifier ⇒ String
Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier here must correspond to the value for cpeLocalIdentifierType
.
If you don't provide a value when creating the IPSec connection, the ipAddress
attribute for the Cpe object specified by cpeId
is used as the cpeLocalIdentifier
.
For information about why you'd provide this value, see If Your CPE Is Behind a NAT Device.
Example IP address: 10.0.3.3
Example hostname: cpe.example.com
106 107 108 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 106 def cpe_local_identifier @cpe_local_identifier end |
#cpe_local_identifier_type ⇒ String
The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier
.
112 113 114 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 112 def cpe_local_identifier_type @cpe_local_identifier_type end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
65 66 67 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 65 def @defined_tags end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
71 72 73 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 71 def display_name @display_name end |
#drg_id ⇒ String
[Required] The OCID of the DRG.
75 76 77 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 75 def drg_id @drg_id end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
81 82 83 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 81 def @freeform_tags end |
#id ⇒ String
[Required] The IPSec connection's Oracle ID (OCID).
85 86 87 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 85 def id @id end |
#lifecycle_state ⇒ String
[Required] The IPSec connection's current state.
89 90 91 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 89 def lifecycle_state @lifecycle_state end |
#static_routes ⇒ Array<String>
[Required] Static routes to the CPE. The CIDR must not be a multicast address or class E address.
Used for routing a given IPSec tunnel's traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes.
The CIDR can be either IPv4 or IPv6. IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
Example: 10.0.1.0/24
Example: 2001:db8::/32
130 131 132 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 130 def static_routes @static_routes end |
#time_created ⇒ DateTime
The date and time the IPSec connection was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
137 138 139 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 137 def time_created @time_created end |
#transport_type ⇒ String
The transport type used for the IPSec connection.
142 143 144 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 142 def transport_type @transport_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 145 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'cpe_id': :'cpeId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'drg_id': :'drgId', 'freeform_tags': :'freeformTags', 'id': :'id', 'lifecycle_state': :'lifecycleState', 'cpe_local_identifier': :'cpeLocalIdentifier', 'cpe_local_identifier_type': :'cpeLocalIdentifierType', 'static_routes': :'staticRoutes', 'time_created': :'timeCreated', 'transport_type': :'transportType' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 166 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'cpe_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'drg_id': :'String', 'freeform_tags': :'Hash<String, String>', 'id': :'String', 'lifecycle_state': :'String', 'cpe_local_identifier': :'String', 'cpe_local_identifier_type': :'String', 'static_routes': :'Array<String>', 'time_created': :'DateTime', 'transport_type': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 334 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && cpe_id == other.cpe_id && == other. && display_name == other.display_name && drg_id == other.drg_id && == other. && id == other.id && lifecycle_state == other.lifecycle_state && cpe_local_identifier == other.cpe_local_identifier && cpe_local_identifier_type == other.cpe_local_identifier_type && static_routes == other.static_routes && time_created == other.time_created && transport_type == other.transport_type end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 376 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
356 357 358 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 356 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
365 366 367 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 365 def hash [compartment_id, cpe_id, , display_name, drg_id, , id, lifecycle_state, cpe_local_identifier, cpe_local_identifier_type, static_routes, time_created, transport_type].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
409 410 411 412 413 414 415 416 417 418 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 409 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
403 404 405 |
# File 'lib/oci/vn_monitoring/models/ip_sec_connection.rb', line 403 def to_s to_hash.to_s end |