oraclebmc 1.2.4 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (186) hide show
  1. checksums.yaml +4 -4
  2. data/{README.md → README_BMCS.md} +21 -26
  3. data/lib/oraclebmc.rb +1 -19
  4. metadata +16 -259
  5. data/lib/oraclebmc/api_client.rb +0 -306
  6. data/lib/oraclebmc/config.rb +0 -80
  7. data/lib/oraclebmc/config_file_loader.rb +0 -85
  8. data/lib/oraclebmc/core/blockstorage_client.rb +0 -460
  9. data/lib/oraclebmc/core/compute_client.rb +0 -1267
  10. data/lib/oraclebmc/core/core.rb +0 -112
  11. data/lib/oraclebmc/core/models/attach_i_scsi_volume_details.rb +0 -137
  12. data/lib/oraclebmc/core/models/attach_vnic_details.rb +0 -144
  13. data/lib/oraclebmc/core/models/attach_volume_details.rb +0 -165
  14. data/lib/oraclebmc/core/models/capture_console_history_details.rb +0 -120
  15. data/lib/oraclebmc/core/models/console_history.rb +0 -213
  16. data/lib/oraclebmc/core/models/cpe.rb +0 -169
  17. data/lib/oraclebmc/core/models/create_cpe_details.rb +0 -145
  18. data/lib/oraclebmc/core/models/create_cross_connect_details.rb +0 -204
  19. data/lib/oraclebmc/core/models/create_cross_connect_group_details.rb +0 -133
  20. data/lib/oraclebmc/core/models/create_dhcp_details.rb +0 -153
  21. data/lib/oraclebmc/core/models/create_drg_attachment_details.rb +0 -142
  22. data/lib/oraclebmc/core/models/create_drg_details.rb +0 -131
  23. data/lib/oraclebmc/core/models/create_image_details.rb +0 -159
  24. data/lib/oraclebmc/core/models/create_internet_gateway_details.rb +0 -153
  25. data/lib/oraclebmc/core/models/create_ip_sec_connection_details.rb +0 -168
  26. data/lib/oraclebmc/core/models/create_private_ip_details.rb +0 -173
  27. data/lib/oraclebmc/core/models/create_route_table_details.rb +0 -153
  28. data/lib/oraclebmc/core/models/create_security_list_details.rb +0 -164
  29. data/lib/oraclebmc/core/models/create_subnet_details.rb +0 -257
  30. data/lib/oraclebmc/core/models/create_vcn_details.rb +0 -171
  31. data/lib/oraclebmc/core/models/create_virtual_circuit_details.rb +0 -260
  32. data/lib/oraclebmc/core/models/create_vnic_details.rb +0 -214
  33. data/lib/oraclebmc/core/models/create_volume_backup_details.rb +0 -133
  34. data/lib/oraclebmc/core/models/create_volume_details.rb +0 -170
  35. data/lib/oraclebmc/core/models/cross_connect.rb +0 -235
  36. data/lib/oraclebmc/core/models/cross_connect_group.rb +0 -187
  37. data/lib/oraclebmc/core/models/cross_connect_location.rb +0 -134
  38. data/lib/oraclebmc/core/models/cross_connect_mapping.rb +0 -190
  39. data/lib/oraclebmc/core/models/cross_connect_port_speed_shape.rb +0 -137
  40. data/lib/oraclebmc/core/models/cross_connect_status.rb +0 -200
  41. data/lib/oraclebmc/core/models/dhcp_dns_option.rb +0 -171
  42. data/lib/oraclebmc/core/models/dhcp_option.rb +0 -135
  43. data/lib/oraclebmc/core/models/dhcp_options.rb +0 -208
  44. data/lib/oraclebmc/core/models/dhcp_search_domain_option.rb +0 -141
  45. data/lib/oraclebmc/core/models/drg.rb +0 -186
  46. data/lib/oraclebmc/core/models/drg_attachment.rb +0 -208
  47. data/lib/oraclebmc/core/models/egress_security_rule.rb +0 -198
  48. data/lib/oraclebmc/core/models/export_image_details.rb +0 -134
  49. data/lib/oraclebmc/core/models/export_image_via_object_storage_tuple_details.rb +0 -150
  50. data/lib/oraclebmc/core/models/export_image_via_object_storage_uri_details.rb +0 -130
  51. data/lib/oraclebmc/core/models/fast_connect_provider_service.rb +0 -145
  52. data/lib/oraclebmc/core/models/i_scsi_volume_attachment.rb +0 -212
  53. data/lib/oraclebmc/core/models/icmp_options.rb +0 -131
  54. data/lib/oraclebmc/core/models/image.rb +0 -245
  55. data/lib/oraclebmc/core/models/image_source_details.rb +0 -134
  56. data/lib/oraclebmc/core/models/image_source_via_object_storage_tuple_details.rb +0 -150
  57. data/lib/oraclebmc/core/models/image_source_via_object_storage_uri_details.rb +0 -128
  58. data/lib/oraclebmc/core/models/ingress_security_rule.rb +0 -198
  59. data/lib/oraclebmc/core/models/instance.rb +0 -307
  60. data/lib/oraclebmc/core/models/instance_credentials.rb +0 -131
  61. data/lib/oraclebmc/core/models/internet_gateway.rb +0 -210
  62. data/lib/oraclebmc/core/models/ip_sec_connection.rb +0 -223
  63. data/lib/oraclebmc/core/models/ip_sec_connection_device_config.rb +0 -153
  64. data/lib/oraclebmc/core/models/ip_sec_connection_device_status.rb +0 -156
  65. data/lib/oraclebmc/core/models/launch_instance_details.rb +0 -336
  66. data/lib/oraclebmc/core/models/letter_of_authority.rb +0 -194
  67. data/lib/oraclebmc/core/models/port_range.rb +0 -133
  68. data/lib/oraclebmc/core/models/private_ip.rb +0 -248
  69. data/lib/oraclebmc/core/models/route_rule.rb +0 -135
  70. data/lib/oraclebmc/core/models/route_table.rb +0 -208
  71. data/lib/oraclebmc/core/models/security_list.rb +0 -219
  72. data/lib/oraclebmc/core/models/shape.rb +0 -122
  73. data/lib/oraclebmc/core/models/subnet.rb +0 -351
  74. data/lib/oraclebmc/core/models/tcp_options.rb +0 -135
  75. data/lib/oraclebmc/core/models/tunnel_config.rb +0 -151
  76. data/lib/oraclebmc/core/models/tunnel_status.rb +0 -178
  77. data/lib/oraclebmc/core/models/udp_options.rb +0 -135
  78. data/lib/oraclebmc/core/models/update_cpe_details.rb +0 -122
  79. data/lib/oraclebmc/core/models/update_cross_connect_details.rb +0 -138
  80. data/lib/oraclebmc/core/models/update_cross_connect_group_details.rb +0 -122
  81. data/lib/oraclebmc/core/models/update_dhcp_details.rb +0 -132
  82. data/lib/oraclebmc/core/models/update_drg_attachment_details.rb +0 -122
  83. data/lib/oraclebmc/core/models/update_drg_details.rb +0 -122
  84. data/lib/oraclebmc/core/models/update_image_details.rb +0 -124
  85. data/lib/oraclebmc/core/models/update_instance_details.rb +0 -124
  86. data/lib/oraclebmc/core/models/update_internet_gateway_details.rb +0 -133
  87. data/lib/oraclebmc/core/models/update_ip_sec_connection_details.rb +0 -122
  88. data/lib/oraclebmc/core/models/update_private_ip_details.rb +0 -157
  89. data/lib/oraclebmc/core/models/update_route_table_details.rb +0 -133
  90. data/lib/oraclebmc/core/models/update_security_list_details.rb +0 -144
  91. data/lib/oraclebmc/core/models/update_subnet_details.rb +0 -122
  92. data/lib/oraclebmc/core/models/update_vcn_details.rb +0 -122
  93. data/lib/oraclebmc/core/models/update_virtual_circuit_details.rb +0 -240
  94. data/lib/oraclebmc/core/models/update_vnic_details.rb +0 -144
  95. data/lib/oraclebmc/core/models/update_volume_backup_details.rb +0 -122
  96. data/lib/oraclebmc/core/models/update_volume_details.rb +0 -122
  97. data/lib/oraclebmc/core/models/vcn.rb +0 -276
  98. data/lib/oraclebmc/core/models/virtual_circuit.rb +0 -395
  99. data/lib/oraclebmc/core/models/virtual_circuit_bandwidth_shape.rb +0 -137
  100. data/lib/oraclebmc/core/models/vnic.rb +0 -287
  101. data/lib/oraclebmc/core/models/vnic_attachment.rb +0 -250
  102. data/lib/oraclebmc/core/models/volume.rb +0 -210
  103. data/lib/oraclebmc/core/models/volume_attachment.rb +0 -246
  104. data/lib/oraclebmc/core/models/volume_backup.rb +0 -235
  105. data/lib/oraclebmc/core/util.rb +0 -1
  106. data/lib/oraclebmc/core/virtual_network_client.rb +0 -3419
  107. data/lib/oraclebmc/errors.rb +0 -80
  108. data/lib/oraclebmc/global_context.rb +0 -21
  109. data/lib/oraclebmc/identity/identity.rb +0 -51
  110. data/lib/oraclebmc/identity/identity_client.rb +0 -1983
  111. data/lib/oraclebmc/identity/models/add_user_to_group_details.rb +0 -131
  112. data/lib/oraclebmc/identity/models/api_key.rb +0 -211
  113. data/lib/oraclebmc/identity/models/availability_domain.rb +0 -131
  114. data/lib/oraclebmc/identity/models/compartment.rb +0 -211
  115. data/lib/oraclebmc/identity/models/create_api_key_details.rb +0 -120
  116. data/lib/oraclebmc/identity/models/create_compartment_details.rb +0 -145
  117. data/lib/oraclebmc/identity/models/create_group_details.rb +0 -144
  118. data/lib/oraclebmc/identity/models/create_identity_provider_details.rb +0 -212
  119. data/lib/oraclebmc/identity/models/create_idp_group_mapping_details.rb +0 -133
  120. data/lib/oraclebmc/identity/models/create_policy_details.rb +0 -173
  121. data/lib/oraclebmc/identity/models/create_region_subscription_details.rb +0 -127
  122. data/lib/oraclebmc/identity/models/create_saml2_identity_provider_details.rb +0 -154
  123. data/lib/oraclebmc/identity/models/create_swift_password_details.rb +0 -121
  124. data/lib/oraclebmc/identity/models/create_user_details.rb +0 -144
  125. data/lib/oraclebmc/identity/models/group.rb +0 -211
  126. data/lib/oraclebmc/identity/models/identity_provider.rb +0 -256
  127. data/lib/oraclebmc/identity/models/idp_group_mapping.rb +0 -220
  128. data/lib/oraclebmc/identity/models/policy.rb +0 -237
  129. data/lib/oraclebmc/identity/models/region.rb +0 -141
  130. data/lib/oraclebmc/identity/models/region_subscription.rb +0 -178
  131. data/lib/oraclebmc/identity/models/saml2_identity_provider.rb +0 -180
  132. data/lib/oraclebmc/identity/models/swift_password.rb +0 -226
  133. data/lib/oraclebmc/identity/models/tenancy.rb +0 -158
  134. data/lib/oraclebmc/identity/models/ui_password.rb +0 -187
  135. data/lib/oraclebmc/identity/models/update_compartment_details.rb +0 -120
  136. data/lib/oraclebmc/identity/models/update_group_details.rb +0 -120
  137. data/lib/oraclebmc/identity/models/update_identity_provider_details.rb +0 -160
  138. data/lib/oraclebmc/identity/models/update_idp_group_mapping_details.rb +0 -131
  139. data/lib/oraclebmc/identity/models/update_policy_details.rb +0 -148
  140. data/lib/oraclebmc/identity/models/update_saml2_identity_provider_details.rb +0 -145
  141. data/lib/oraclebmc/identity/models/update_state_details.rb +0 -121
  142. data/lib/oraclebmc/identity/models/update_swift_password_details.rb +0 -120
  143. data/lib/oraclebmc/identity/models/update_user_details.rb +0 -120
  144. data/lib/oraclebmc/identity/models/user.rb +0 -217
  145. data/lib/oraclebmc/identity/models/user_group_membership.rb +0 -209
  146. data/lib/oraclebmc/identity/util.rb +0 -1
  147. data/lib/oraclebmc/internal/internal.rb +0 -11
  148. data/lib/oraclebmc/internal/util.rb +0 -69
  149. data/lib/oraclebmc/load_balancer/load_balancer.rb +0 -46
  150. data/lib/oraclebmc/load_balancer/load_balancer_client.rb +0 -1281
  151. data/lib/oraclebmc/load_balancer/models/backend.rb +0 -220
  152. data/lib/oraclebmc/load_balancer/models/backend_details.rb +0 -206
  153. data/lib/oraclebmc/load_balancer/models/backend_set.rb +0 -179
  154. data/lib/oraclebmc/load_balancer/models/backend_set_details.rb +0 -165
  155. data/lib/oraclebmc/load_balancer/models/certificate.rb +0 -167
  156. data/lib/oraclebmc/load_balancer/models/certificate_details.rb +0 -203
  157. data/lib/oraclebmc/load_balancer/models/create_backend_details.rb +0 -206
  158. data/lib/oraclebmc/load_balancer/models/create_backend_set_details.rb +0 -178
  159. data/lib/oraclebmc/load_balancer/models/create_certificate_details.rb +0 -203
  160. data/lib/oraclebmc/load_balancer/models/create_listener_details.rb +0 -174
  161. data/lib/oraclebmc/load_balancer/models/create_load_balancer_details.rb +0 -219
  162. data/lib/oraclebmc/load_balancer/models/health_checker.rb +0 -223
  163. data/lib/oraclebmc/load_balancer/models/health_checker_details.rb +0 -222
  164. data/lib/oraclebmc/load_balancer/models/ip_address.rb +0 -139
  165. data/lib/oraclebmc/load_balancer/models/listener.rb +0 -174
  166. data/lib/oraclebmc/load_balancer/models/listener_details.rb +0 -160
  167. data/lib/oraclebmc/load_balancer/models/load_balancer.rb +0 -280
  168. data/lib/oraclebmc/load_balancer/models/load_balancer_policy.rb +0 -120
  169. data/lib/oraclebmc/load_balancer/models/load_balancer_protocol.rb +0 -120
  170. data/lib/oraclebmc/load_balancer/models/load_balancer_shape.rb +0 -120
  171. data/lib/oraclebmc/load_balancer/models/session_persistence_configuration_details.rb +0 -141
  172. data/lib/oraclebmc/load_balancer/models/ssl_configuration.rb +0 -153
  173. data/lib/oraclebmc/load_balancer/models/ssl_configuration_details.rb +0 -153
  174. data/lib/oraclebmc/load_balancer/models/update_backend_details.rb +0 -178
  175. data/lib/oraclebmc/load_balancer/models/update_backend_set_details.rb +0 -165
  176. data/lib/oraclebmc/load_balancer/models/update_health_checker_details.rb +0 -221
  177. data/lib/oraclebmc/load_balancer/models/update_listener_details.rb +0 -160
  178. data/lib/oraclebmc/load_balancer/models/update_load_balancer_details.rb +0 -123
  179. data/lib/oraclebmc/load_balancer/models/work_request.rb +0 -229
  180. data/lib/oraclebmc/load_balancer/models/work_request_error.rb +0 -145
  181. data/lib/oraclebmc/load_balancer/util.rb +0 -55
  182. data/lib/oraclebmc/regions.rb +0 -41
  183. data/lib/oraclebmc/response.rb +0 -86
  184. data/lib/oraclebmc/signer.rb +0 -119
  185. data/lib/oraclebmc/version.rb +0 -5
  186. data/lib/oraclebmc/waiter.rb +0 -111
@@ -1,235 +0,0 @@
1
- # Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
2
-
3
- require 'date'
4
-
5
- module OracleBMC
6
- class Core::Models::VolumeBackup
7
-
8
- LIFECYCLE_STATE_ENUM = [LIFECYCLE_STATE_CREATING = 'CREATING',
9
- LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE',
10
- LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
11
- LIFECYCLE_STATE_TERMINATED = 'TERMINATED',
12
- LIFECYCLE_STATE_FAULTY = 'FAULTY',
13
- LIFECYCLE_STATE_REQUEST_RECEIVED = 'REQUEST_RECEIVED',
14
- LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
15
-
16
- # The OCID of the compartment that contains the volume backup.
17
- # @return [String]
18
- attr_accessor :compartment_id
19
-
20
- # A user-friendly name for the volume backup. Does not have to be unique and it's changeable.
21
- # Avoid entering confidential information.
22
- #
23
- # @return [String]
24
- attr_accessor :display_name
25
-
26
- # The OCID of the volume backup.
27
- # @return [String]
28
- attr_accessor :id
29
-
30
- # The current state of a volume backup.
31
- # @return [String]
32
- attr_accessor :lifecycle_state
33
-
34
- # The size of the volume, in MBs.
35
- #
36
- # @return [Integer]
37
- attr_accessor :size_in_m_bs
38
-
39
- # The date and time the volume backup was created. This is the time the actual point-in-time image
40
- # of the volume data was taken. Format defined by RFC3339.
41
- #
42
- # @return [DateTime]
43
- attr_accessor :time_created
44
-
45
- # The date and time the request to create the volume backup was received. Format defined by RFC3339.
46
- #
47
- # @return [DateTime]
48
- attr_accessor :time_request_received
49
-
50
- # The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space
51
- # consumed on the volume and whether the backup is full or incremental.
52
- #
53
- # @return [Integer]
54
- attr_accessor :unique_size_in_mbs
55
-
56
- # The OCID of the volume.
57
- # @return [String]
58
- attr_accessor :volume_id
59
-
60
-
61
- # Initializes the object
62
- # @param [Hash] attributes Model attributes in the form of hash
63
- def initialize(attributes = {})
64
- return unless attributes.is_a?(Hash)
65
-
66
- # convert string to symbol for hash key
67
- attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
68
-
69
- if attributes[:'compartmentId']
70
- self.compartment_id = attributes[:'compartmentId']
71
- end
72
-
73
- if attributes[:'displayName']
74
- self.display_name = attributes[:'displayName']
75
- end
76
-
77
- if attributes[:'id']
78
- self.id = attributes[:'id']
79
- end
80
-
81
- if attributes[:'lifecycleState']
82
- self.lifecycle_state = attributes[:'lifecycleState']
83
- end
84
-
85
- if attributes[:'sizeInMBs']
86
- self.size_in_m_bs = attributes[:'sizeInMBs']
87
- end
88
-
89
- if attributes[:'timeCreated']
90
- self.time_created = attributes[:'timeCreated']
91
- end
92
-
93
- if attributes[:'timeRequestReceived']
94
- self.time_request_received = attributes[:'timeRequestReceived']
95
- end
96
-
97
- if attributes[:'uniqueSizeInMbs']
98
- self.unique_size_in_mbs = attributes[:'uniqueSizeInMbs']
99
- end
100
-
101
- if attributes[:'volumeId']
102
- self.volume_id = attributes[:'volumeId']
103
- end
104
-
105
- end
106
-
107
- # Custom attribute writer method checking allowed values (enum).
108
- # @param [Object] lifecycle_state Object to be assigned
109
- def lifecycle_state=(lifecycle_state)
110
- if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state)
111
- @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE
112
- else
113
- @lifecycle_state = lifecycle_state
114
- end
115
- end
116
-
117
- # Checks equality by comparing each attribute.
118
- # @param [Object] other_object to be compared
119
- def ==(other_object)
120
- return true if self.equal?(other_object)
121
- self.class == other_object.class &&
122
- compartment_id == other_object.compartment_id &&
123
- display_name == other_object.display_name &&
124
- id == other_object.id &&
125
- lifecycle_state == other_object.lifecycle_state &&
126
- size_in_m_bs == other_object.size_in_m_bs &&
127
- time_created == other_object.time_created &&
128
- time_request_received == other_object.time_request_received &&
129
- unique_size_in_mbs == other_object.unique_size_in_mbs &&
130
- volume_id == other_object.volume_id
131
- end
132
-
133
- # @see the `==` method
134
- # @param [Object] other_object to be compared
135
- def eql?(other_object)
136
- self == other_object
137
- end
138
-
139
- # Calculates hash code according to all attributes.
140
- # @return [Fixnum] Hash code
141
- def hash
142
- [compartment_id, display_name, id, lifecycle_state, size_in_m_bs, time_created, time_request_received, unique_size_in_mbs, volume_id].hash
143
- end
144
-
145
- # Builds the object from hash
146
- # @param [Hash] attributes Model attributes in the form of hash
147
- # @return [Object] Returns the model itself
148
- def build_from_hash(attributes)
149
- return nil unless attributes.is_a?(Hash)
150
- self.class.swagger_types.each_pair do |key, type|
151
- if type =~ /^Array<(.*)>/i
152
- # check to ensure the input is an array given that the the attribute
153
- # is documented as an array but the input is not
154
- if attributes[self.class.attribute_map[key]].is_a?(Array)
155
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| OracleBMC::Internal::Util.convert_to_type($1, v) } )
156
- end
157
- elsif !attributes[self.class.attribute_map[key]].nil?
158
- self.send("#{key}=", OracleBMC::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]))
159
- end # or else data not found in attributes(hash), not an issue as the data can be optional
160
- end
161
-
162
- self
163
- end
164
-
165
- # Returns the string representation of the object
166
- # @return [String] String presentation of the object
167
- def to_s
168
- to_hash.to_s
169
- end
170
-
171
- # Returns the object in the form of hash
172
- # @return [Hash] Returns the object in the form of hash
173
- def to_hash
174
- hash = {}
175
- self.class.attribute_map.each_pair do |attr, param|
176
- value = self.send(attr)
177
- next if value.nil?
178
- hash[param] = _to_hash(value)
179
- end
180
- hash
181
- end
182
-
183
- private
184
-
185
- # Outputs non-array value in the form of hash
186
- # For object, use to_hash. Otherwise, just return the value
187
- # @param [Object] value Any valid value
188
- # @return [Hash] Returns the value in the form of hash
189
- def _to_hash(value)
190
- if value.is_a?(Array)
191
- value.compact.map{ |v| _to_hash(v) }
192
- elsif value.is_a?(Hash)
193
- {}.tap do |hash|
194
- value.each { |k, v| hash[k] = _to_hash(v) }
195
- end
196
- elsif value.respond_to? :to_hash
197
- value.to_hash
198
- else
199
- value
200
- end
201
- end
202
-
203
-
204
-
205
- # Attribute mapping from ruby-style variable name to JSON key.
206
- def self.attribute_map
207
- {
208
- :'compartment_id' => :'compartmentId',
209
- :'display_name' => :'displayName',
210
- :'id' => :'id',
211
- :'lifecycle_state' => :'lifecycleState',
212
- :'size_in_m_bs' => :'sizeInMBs',
213
- :'time_created' => :'timeCreated',
214
- :'time_request_received' => :'timeRequestReceived',
215
- :'unique_size_in_mbs' => :'uniqueSizeInMbs',
216
- :'volume_id' => :'volumeId'
217
- }
218
- end
219
-
220
- # Attribute type mapping.
221
- def self.swagger_types
222
- {
223
- :'compartment_id' => :'String',
224
- :'display_name' => :'String',
225
- :'id' => :'String',
226
- :'lifecycle_state' => :'String',
227
- :'size_in_m_bs' => :'Integer',
228
- :'time_created' => :'DateTime',
229
- :'time_request_received' => :'DateTime',
230
- :'unique_size_in_mbs' => :'Integer',
231
- :'volume_id' => :'String'
232
- }
233
- end
234
- end
235
- end
@@ -1 +0,0 @@
1
- # Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
@@ -1,3419 +0,0 @@
1
- # Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
2
-
3
- require "uri"
4
- require "logger"
5
-
6
- module OracleBMC
7
-
8
- class Core::VirtualNetworkClient
9
-
10
- # Client used to make HTTP requests.
11
- # @return [OracleBMC::ApiClient]
12
- attr_reader :api_client
13
-
14
- # Fully qualified endpoint URL
15
- # @return [String]
16
- attr_reader :endpoint
17
-
18
- # The region, which will usually correspond to a value in {OracleBMC::Regions::REGION_ENUM}.
19
- # @return [String]
20
- attr_accessor :region
21
-
22
- # Creates a new VirtualNetworkClient.
23
- # If a config is not specified, then the global OracleBMC.config will be used.
24
- #
25
- # A region must be specified in either the config or the region parameter. If specified
26
- # in both, then the region parameter will be used.
27
- #
28
- # @param [Config] config A Config object.
29
- # @param [String] region A region used to determine the service endpoint. This will usually
30
- # correspond to a value in {OracleBMC::Regions::REGION_ENUM}, but may be an arbitrary string.
31
- #
32
- def initialize(config:nil, region:nil)
33
- config ||= OracleBMC.config
34
- signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase)
35
- @api_client = ApiClient.new(config, signer)
36
-
37
- region ||= config.region
38
- self.region = region
39
- end
40
-
41
- # Set the region that will be used to determine the service endpoint.
42
- # This will usually correspond to a value in {OracleBMC::Regions::REGION_ENUM},
43
- # but may be an arbitrary string.
44
- def region=(r)
45
- @region = r
46
-
47
- fail 'A region must be specified.' unless @region
48
-
49
- @endpoint = OracleBMC::Regions.get_service_endpoint(@region, :VirtualNetworkClient) + '/20160918'
50
- logger.info "VirtualNetworkClient endpoint set to '#{endpoint}'." if logger
51
- end
52
-
53
- # @return [Logger] The logger for this client. May be nil.
54
- def logger
55
- @api_client.config.logger
56
- end
57
-
58
-
59
- # Creates a new virtual Customer-Premises Equipment (CPE) object in the specified compartment. For
60
- # more information, see [Managing IPSec VPNs](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPsec.htm).
61
- #
62
- # For the purposes of access control, you must provide the OCID of the compartment where you want
63
- # the CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec
64
- # connection or other Networking Service components. If you're not sure which compartment to
65
- # use, put the CPE in the same compartment as the DRG. For more information about
66
- # compartments and access control, see [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
67
- # For information about OCIDs, see [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
68
- #
69
- # You must provide the public IP address of your on-premise router. See
70
- # [Configuring Your On-Premise Router](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/configuringCPE.htm).
71
- #
72
- # You may optionally specify a *display name* for the CPE, otherwise a default is provided. It does not have to
73
- # be unique, and you can change it. Avoid entering confidential information.
74
- #
75
- # @param [CreateCpeDetails] create_cpe_details Details for creating a CPE.
76
- # @param [Hash] opts the optional parameters
77
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
78
- # server error without risk of executing that same action again. Retry tokens expire after 24
79
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
80
- # has been deleted and purged from the system, then a retry of the original creation request
81
- # may be rejected).
82
- #
83
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Cpe
84
- def create_cpe(create_cpe_details, opts = {})
85
- logger.debug "Calling operation VirtualNetworkClient#create_cpe." if logger
86
-
87
- fail "Missing the required parameter 'create_cpe_details' when calling create_cpe." if create_cpe_details.nil?
88
-
89
- path = "/cpes"
90
-
91
- # Query Params
92
- query_params = {}
93
-
94
- # Header Params
95
- header_params = {}
96
- header_params['accept'] = 'application/json'
97
- header_params['content-type'] = 'application/json'
98
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
99
-
100
- post_body = @api_client.object_to_http_body(create_cpe_details)
101
-
102
- return @api_client.call_api(
103
- :POST,
104
- path,
105
- endpoint,
106
- :header_params => header_params,
107
- :query_params => query_params,
108
- :body => post_body,
109
- :return_type => 'OracleBMC::Core::Models::Cpe')
110
- end
111
-
112
- # Creates a new cross-connect. Oracle recommends you create each cross-connect in a
113
- # {CrossConnectGroup} so you can use link aggregation
114
- # with the connection.
115
- #
116
- # After creating the `CrossConnect` object, you need to go the FastConnect location
117
- # and request to have the physical cable installed. For more information, see
118
- # [FastConnect Overview](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).
119
- #
120
- # For the purposes of access control, you must provide the OCID of the
121
- # compartment where you want the cross-connect to reside. If you're
122
- # not sure which compartment to use, put the cross-connect in the
123
- # same compartment with your VCN. For more information about
124
- # compartments and access control, see
125
- # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
126
- # For information about OCIDs, see
127
- # [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
128
- #
129
- # You may optionally specify a *display name* for the cross-connect.
130
- # It does not have to be unique, and you can change it. Avoid entering confidential information.
131
- #
132
- # @param [CreateCrossConnectDetails] create_cross_connect_details Details to create a CrossConnect
133
- # @param [Hash] opts the optional parameters
134
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
135
- # server error without risk of executing that same action again. Retry tokens expire after 24
136
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
137
- # has been deleted and purged from the system, then a retry of the original creation request
138
- # may be rejected).
139
- #
140
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::CrossConnect
141
- def create_cross_connect(create_cross_connect_details, opts = {})
142
- logger.debug "Calling operation VirtualNetworkClient#create_cross_connect." if logger
143
-
144
- fail "Missing the required parameter 'create_cross_connect_details' when calling create_cross_connect." if create_cross_connect_details.nil?
145
-
146
- path = "/crossConnects"
147
-
148
- # Query Params
149
- query_params = {}
150
-
151
- # Header Params
152
- header_params = {}
153
- header_params['accept'] = 'application/json'
154
- header_params['content-type'] = 'application/json'
155
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
156
-
157
- post_body = @api_client.object_to_http_body(create_cross_connect_details)
158
-
159
- return @api_client.call_api(
160
- :POST,
161
- path,
162
- endpoint,
163
- :header_params => header_params,
164
- :query_params => query_params,
165
- :body => post_body,
166
- :return_type => 'OracleBMC::Core::Models::CrossConnect')
167
- end
168
-
169
- # Creates a new cross-connect group to use with Oracle Bare Metal Cloud Services
170
- # FastConnect. For more information, see
171
- # [FastConnect Overview](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).
172
- #
173
- # For the purposes of access control, you must provide the OCID of the
174
- # compartment where you want the cross-connect group to reside. If you're
175
- # not sure which compartment to use, put the cross-connect group in the
176
- # same compartment with your VCN. For more information about
177
- # compartments and access control, see
178
- # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
179
- # For information about OCIDs, see
180
- # [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
181
- #
182
- # You may optionally specify a *display name* for the cross-connect group.
183
- # It does not have to be unique, and you can change it. Avoid entering confidential information.
184
- #
185
- # @param [CreateCrossConnectGroupDetails] create_cross_connect_group_details Details to create a CrossConnectGroup
186
- # @param [Hash] opts the optional parameters
187
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
188
- # server error without risk of executing that same action again. Retry tokens expire after 24
189
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
190
- # has been deleted and purged from the system, then a retry of the original creation request
191
- # may be rejected).
192
- #
193
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::CrossConnectGroup
194
- def create_cross_connect_group(create_cross_connect_group_details, opts = {})
195
- logger.debug "Calling operation VirtualNetworkClient#create_cross_connect_group." if logger
196
-
197
- fail "Missing the required parameter 'create_cross_connect_group_details' when calling create_cross_connect_group." if create_cross_connect_group_details.nil?
198
-
199
- path = "/crossConnectGroups"
200
-
201
- # Query Params
202
- query_params = {}
203
-
204
- # Header Params
205
- header_params = {}
206
- header_params['accept'] = 'application/json'
207
- header_params['content-type'] = 'application/json'
208
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
209
-
210
- post_body = @api_client.object_to_http_body(create_cross_connect_group_details)
211
-
212
- return @api_client.call_api(
213
- :POST,
214
- path,
215
- endpoint,
216
- :header_params => header_params,
217
- :query_params => query_params,
218
- :body => post_body,
219
- :return_type => 'OracleBMC::Core::Models::CrossConnectGroup')
220
- end
221
-
222
- # Creates a new set of DHCP options for the specified VCN. For more information, see
223
- # {DhcpOptions}.
224
- #
225
- # For the purposes of access control, you must provide the OCID of the compartment where you want the set of
226
- # DHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN,
227
- # subnets, or other Networking Service components. If you're not sure which compartment to use, put the set
228
- # of DHCP options in the same compartment as the VCN. For more information about compartments and access control, see
229
- # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see
230
- # [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
231
- #
232
- # You may optionally specify a *display name* for the set of DHCP options, otherwise a default is provided.
233
- # It does not have to be unique, and you can change it. Avoid entering confidential information.
234
- #
235
- # @param [CreateDhcpDetails] create_dhcp_details Request object for creating a new set of DHCP options.
236
- # @param [Hash] opts the optional parameters
237
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
238
- # server error without risk of executing that same action again. Retry tokens expire after 24
239
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
240
- # has been deleted and purged from the system, then a retry of the original creation request
241
- # may be rejected).
242
- #
243
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::DhcpOptions
244
- def create_dhcp_options(create_dhcp_details, opts = {})
245
- logger.debug "Calling operation VirtualNetworkClient#create_dhcp_options." if logger
246
-
247
- fail "Missing the required parameter 'create_dhcp_details' when calling create_dhcp_options." if create_dhcp_details.nil?
248
-
249
- path = "/dhcps"
250
-
251
- # Query Params
252
- query_params = {}
253
-
254
- # Header Params
255
- header_params = {}
256
- header_params['accept'] = 'application/json'
257
- header_params['content-type'] = 'application/json'
258
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
259
-
260
- post_body = @api_client.object_to_http_body(create_dhcp_details)
261
-
262
- return @api_client.call_api(
263
- :POST,
264
- path,
265
- endpoint,
266
- :header_params => header_params,
267
- :query_params => query_params,
268
- :body => post_body,
269
- :return_type => 'OracleBMC::Core::Models::DhcpOptions')
270
- end
271
-
272
- # Creates a new Dynamic Routing Gateway (DRG) in the specified compartment. For more information,
273
- # see [Managing Dynamic Routing Gateways (DRGs)](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDRGs.htm).
274
- #
275
- # For the purposes of access control, you must provide the OCID of the compartment where you want
276
- # the DRG to reside. Notice that the DRG doesn't have to be in the same compartment as the VCN,
277
- # the DRG attachment, or other Networking Service components. If you're not sure which compartment
278
- # to use, put the DRG in the same compartment as the VCN. For more information about compartments
279
- # and access control, see [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
280
- # For information about OCIDs, see [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
281
- #
282
- # You may optionally specify a *display name* for the DRG, otherwise a default is provided.
283
- # It does not have to be unique, and you can change it. Avoid entering confidential information.
284
- #
285
- # @param [CreateDrgDetails] create_drg_details Details for creating a DRG.
286
- # @param [Hash] opts the optional parameters
287
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
288
- # server error without risk of executing that same action again. Retry tokens expire after 24
289
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
290
- # has been deleted and purged from the system, then a retry of the original creation request
291
- # may be rejected).
292
- #
293
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Drg
294
- def create_drg(create_drg_details, opts = {})
295
- logger.debug "Calling operation VirtualNetworkClient#create_drg." if logger
296
-
297
- fail "Missing the required parameter 'create_drg_details' when calling create_drg." if create_drg_details.nil?
298
-
299
- path = "/drgs"
300
-
301
- # Query Params
302
- query_params = {}
303
-
304
- # Header Params
305
- header_params = {}
306
- header_params['accept'] = 'application/json'
307
- header_params['content-type'] = 'application/json'
308
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
309
-
310
- post_body = @api_client.object_to_http_body(create_drg_details)
311
-
312
- return @api_client.call_api(
313
- :POST,
314
- path,
315
- endpoint,
316
- :header_params => header_params,
317
- :query_params => query_params,
318
- :body => post_body,
319
- :return_type => 'OracleBMC::Core::Models::Drg')
320
- end
321
-
322
- # Attaches the specified DRG to the specified VCN. A VCN can be attached to only one DRG at a time,
323
- # and vice versa. The response includes a `DrgAttachment` object with its own OCID. For more
324
- # information about DRGs, see
325
- # [Managing Dynamic Routing Gateways (DRGs)](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDRGs.htm).
326
- #
327
- # You may optionally specify a *display name* for the attachment, otherwise a default is provided.
328
- # It does not have to be unique, and you can change it. Avoid entering confidential information.
329
- #
330
- # For the purposes of access control, the DRG attachment is automatically placed into the same compartment
331
- # as the VCN. For more information about compartments and access control, see
332
- # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
333
- #
334
- # @param [CreateDrgAttachmentDetails] create_drg_attachment_details Details for creating a `DrgAttachment`.
335
- # @param [Hash] opts the optional parameters
336
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
337
- # server error without risk of executing that same action again. Retry tokens expire after 24
338
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
339
- # has been deleted and purged from the system, then a retry of the original creation request
340
- # may be rejected).
341
- #
342
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::DrgAttachment
343
- def create_drg_attachment(create_drg_attachment_details, opts = {})
344
- logger.debug "Calling operation VirtualNetworkClient#create_drg_attachment." if logger
345
-
346
- fail "Missing the required parameter 'create_drg_attachment_details' when calling create_drg_attachment." if create_drg_attachment_details.nil?
347
-
348
- path = "/drgAttachments"
349
-
350
- # Query Params
351
- query_params = {}
352
-
353
- # Header Params
354
- header_params = {}
355
- header_params['accept'] = 'application/json'
356
- header_params['content-type'] = 'application/json'
357
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
358
-
359
- post_body = @api_client.object_to_http_body(create_drg_attachment_details)
360
-
361
- return @api_client.call_api(
362
- :POST,
363
- path,
364
- endpoint,
365
- :header_params => header_params,
366
- :query_params => query_params,
367
- :body => post_body,
368
- :return_type => 'OracleBMC::Core::Models::DrgAttachment')
369
- end
370
-
371
- # Creates a new Internet Gateway for the specified VCN. For more information, see
372
- # [Managing Internet Gateways](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIGs.htm).
373
- #
374
- # For the purposes of access control, you must provide the OCID of the compartment where you want the Internet
375
- # Gateway to reside. Notice that the Internet Gateway doesn't have to be in the same compartment as the VCN or
376
- # other Networking Service components. If you're not sure which compartment to use, put the Internet
377
- # Gateway in the same compartment with the VCN. For more information about compartments and access control, see
378
- # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see
379
- # [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
380
- #
381
- # You may optionally specify a *display name* for the Internet Gateway, otherwise a default is provided. It
382
- # does not have to be unique, and you can change it. Avoid entering confidential information.
383
- #
384
- # For traffic to flow between a subnet and an Internet Gateway, you must create a route rule accordingly in
385
- # the subnet's route table (e.g., 0.0.0.0/0 > Internet Gateway). See
386
- # {#update_route_table update_route_table}.
387
- #
388
- # You must specify whether the Internet Gateway is enabled when you create it. If it's disabled, that means no
389
- # traffic will flow to/from the internet even if there's a route rule that enables that traffic. You can later
390
- # use {#update_internet_gateway update_internet_gateway} to easily disable/enable
391
- # the gateway without changing the route rule.
392
- #
393
- # @param [CreateInternetGatewayDetails] create_internet_gateway_details Details for creating a new Internet Gateway.
394
- # @param [Hash] opts the optional parameters
395
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
396
- # server error without risk of executing that same action again. Retry tokens expire after 24
397
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
398
- # has been deleted and purged from the system, then a retry of the original creation request
399
- # may be rejected).
400
- #
401
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::InternetGateway
402
- def create_internet_gateway(create_internet_gateway_details, opts = {})
403
- logger.debug "Calling operation VirtualNetworkClient#create_internet_gateway." if logger
404
-
405
- fail "Missing the required parameter 'create_internet_gateway_details' when calling create_internet_gateway." if create_internet_gateway_details.nil?
406
-
407
- path = "/internetGateways"
408
-
409
- # Query Params
410
- query_params = {}
411
-
412
- # Header Params
413
- header_params = {}
414
- header_params['accept'] = 'application/json'
415
- header_params['content-type'] = 'application/json'
416
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
417
-
418
- post_body = @api_client.object_to_http_body(create_internet_gateway_details)
419
-
420
- return @api_client.call_api(
421
- :POST,
422
- path,
423
- endpoint,
424
- :header_params => header_params,
425
- :query_params => query_params,
426
- :body => post_body,
427
- :return_type => 'OracleBMC::Core::Models::InternetGateway')
428
- end
429
-
430
- # Creates a new IPSec connection between the specified DRG and CPE. For more information, see
431
- # [Managing IPSec Connections](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPsec.htm).
432
- #
433
- # In the request, you must include at least one static route to the CPE object (you're allowed a maximum
434
- # of 10). For example: 10.0.8.0/16.
435
- #
436
- # For the purposes of access control, you must provide the OCID of the compartment where you want the
437
- # IPSec connection to reside. Notice that the IPSec connection doesn't have to be in the same compartment
438
- # as the DRG, CPE, or other Networking Service components. If you're not sure which compartment to
439
- # use, put the IPSec connection in the same compartment as the DRG. For more information about
440
- # compartments and access control, see
441
- # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
442
- # For information about OCIDs, see [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
443
- #
444
- # You may optionally specify a *display name* for the IPSec connection, otherwise a default is provided.
445
- # It does not have to be unique, and you can change it. Avoid entering confidential information.
446
- #
447
- # After creating the IPSec connection, you need to configure your on-premise router
448
- # with tunnel-specific information returned by
449
- # {#get_ip_sec_connection_device_config get_ip_sec_connection_device_config}.
450
- # For each tunnel, that operation gives you the IP address of Oracle's VPN headend and the shared secret
451
- # (i.e., the pre-shared key). For more information, see
452
- # [Configuring Your On-Premise Router](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/configuringCPE.htm).
453
- #
454
- # To get the status of the tunnels (whether they're up or down), use
455
- # {#get_ip_sec_connection_device_status get_ip_sec_connection_device_status}.
456
- #
457
- # @param [CreateIPSecConnectionDetails] create_ip_sec_connection_details Details for creating an `IPSecConnection`.
458
- # @param [Hash] opts the optional parameters
459
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
460
- # server error without risk of executing that same action again. Retry tokens expire after 24
461
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
462
- # has been deleted and purged from the system, then a retry of the original creation request
463
- # may be rejected).
464
- #
465
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::IPSecConnection
466
- def create_ip_sec_connection(create_ip_sec_connection_details, opts = {})
467
- logger.debug "Calling operation VirtualNetworkClient#create_ip_sec_connection." if logger
468
-
469
- fail "Missing the required parameter 'create_ip_sec_connection_details' when calling create_ip_sec_connection." if create_ip_sec_connection_details.nil?
470
-
471
- path = "/ipsecConnections"
472
-
473
- # Query Params
474
- query_params = {}
475
-
476
- # Header Params
477
- header_params = {}
478
- header_params['accept'] = 'application/json'
479
- header_params['content-type'] = 'application/json'
480
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
481
-
482
- post_body = @api_client.object_to_http_body(create_ip_sec_connection_details)
483
-
484
- return @api_client.call_api(
485
- :POST,
486
- path,
487
- endpoint,
488
- :header_params => header_params,
489
- :query_params => query_params,
490
- :body => post_body,
491
- :return_type => 'OracleBMC::Core::Models::IPSecConnection')
492
- end
493
-
494
- # Creates a secondary private IP for the specified VNIC.
495
- # For more information about secondary private IPs, see
496
- # [Managing IP Addresses](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingIPaddresses.htm).
497
- #
498
- # @param [CreatePrivateIpDetails] create_private_ip_details Create private IP details.
499
- # @param [Hash] opts the optional parameters
500
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
501
- # server error without risk of executing that same action again. Retry tokens expire after 24
502
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
503
- # has been deleted and purged from the system, then a retry of the original creation request
504
- # may be rejected).
505
- #
506
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::PrivateIp
507
- def create_private_ip(create_private_ip_details, opts = {})
508
- logger.debug "Calling operation VirtualNetworkClient#create_private_ip." if logger
509
-
510
- fail "Missing the required parameter 'create_private_ip_details' when calling create_private_ip." if create_private_ip_details.nil?
511
-
512
- path = "/privateIps"
513
-
514
- # Query Params
515
- query_params = {}
516
-
517
- # Header Params
518
- header_params = {}
519
- header_params['accept'] = 'application/json'
520
- header_params['content-type'] = 'application/json'
521
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
522
-
523
- post_body = @api_client.object_to_http_body(create_private_ip_details)
524
-
525
- return @api_client.call_api(
526
- :POST,
527
- path,
528
- endpoint,
529
- :header_params => header_params,
530
- :query_params => query_params,
531
- :body => post_body,
532
- :return_type => 'OracleBMC::Core::Models::PrivateIp')
533
- end
534
-
535
- # Creates a new route table for the specified VCN. In the request you must also include at least one route
536
- # rule for the new route table. For information on the number of rules you can have in a route table, see
537
- # [Service Limits](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/servicelimits.htm). For general information about route
538
- # tables in your VCN, see [Managing Route Tables](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm).
539
- #
540
- # For the purposes of access control, you must provide the OCID of the compartment where you want the route
541
- # table to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets,
542
- # or other Networking Service components. If you're not sure which compartment to use, put the route
543
- # table in the same compartment as the VCN. For more information about compartments and access control, see
544
- # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see
545
- # [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
546
- #
547
- # You may optionally specify a *display name* for the route table, otherwise a default is provided.
548
- # It does not have to be unique, and you can change it. Avoid entering confidential information.
549
- #
550
- # @param [CreateRouteTableDetails] create_route_table_details Details for creating a new route table.
551
- # @param [Hash] opts the optional parameters
552
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
553
- # server error without risk of executing that same action again. Retry tokens expire after 24
554
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
555
- # has been deleted and purged from the system, then a retry of the original creation request
556
- # may be rejected).
557
- #
558
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::RouteTable
559
- def create_route_table(create_route_table_details, opts = {})
560
- logger.debug "Calling operation VirtualNetworkClient#create_route_table." if logger
561
-
562
- fail "Missing the required parameter 'create_route_table_details' when calling create_route_table." if create_route_table_details.nil?
563
-
564
- path = "/routeTables"
565
-
566
- # Query Params
567
- query_params = {}
568
-
569
- # Header Params
570
- header_params = {}
571
- header_params['accept'] = 'application/json'
572
- header_params['content-type'] = 'application/json'
573
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
574
-
575
- post_body = @api_client.object_to_http_body(create_route_table_details)
576
-
577
- return @api_client.call_api(
578
- :POST,
579
- path,
580
- endpoint,
581
- :header_params => header_params,
582
- :query_params => query_params,
583
- :body => post_body,
584
- :return_type => 'OracleBMC::Core::Models::RouteTable')
585
- end
586
-
587
- # Creates a new security list for the specified VCN. For more information
588
- # about security lists, see [Security Lists](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm).
589
- # For information on the number of rules you can have in a security list, see
590
- # [Service Limits](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/servicelimits.htm).
591
- #
592
- # For the purposes of access control, you must provide the OCID of the compartment where you want the security
593
- # list to reside. Notice that the security list doesn't have to be in the same compartment as the VCN, subnets,
594
- # or other Networking Service components. If you're not sure which compartment to use, put the security
595
- # list in the same compartment as the VCN. For more information about compartments and access control, see
596
- # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see
597
- # [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
598
- #
599
- # You may optionally specify a *display name* for the security list, otherwise a default is provided.
600
- # It does not have to be unique, and you can change it. Avoid entering confidential information.
601
- #
602
- # @param [CreateSecurityListDetails] create_security_list_details Details regarding the security list to create.
603
- # @param [Hash] opts the optional parameters
604
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
605
- # server error without risk of executing that same action again. Retry tokens expire after 24
606
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
607
- # has been deleted and purged from the system, then a retry of the original creation request
608
- # may be rejected).
609
- #
610
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::SecurityList
611
- def create_security_list(create_security_list_details, opts = {})
612
- logger.debug "Calling operation VirtualNetworkClient#create_security_list." if logger
613
-
614
- fail "Missing the required parameter 'create_security_list_details' when calling create_security_list." if create_security_list_details.nil?
615
-
616
- path = "/securityLists"
617
-
618
- # Query Params
619
- query_params = {}
620
-
621
- # Header Params
622
- header_params = {}
623
- header_params['accept'] = 'application/json'
624
- header_params['content-type'] = 'application/json'
625
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
626
-
627
- post_body = @api_client.object_to_http_body(create_security_list_details)
628
-
629
- return @api_client.call_api(
630
- :POST,
631
- path,
632
- endpoint,
633
- :header_params => header_params,
634
- :query_params => query_params,
635
- :body => post_body,
636
- :return_type => 'OracleBMC::Core::Models::SecurityList')
637
- end
638
-
639
- # Creates a new subnet in the specified VCN. You can't change the size of the subnet after creation,
640
- # so it's important to think about the size of subnets you need before creating them.
641
- # For more information, see [Managing Subnets](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingsubnets.htm).
642
- # For information on the number of subnets you can have in a VCN, see
643
- # [Service Limits](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/servicelimits.htm).
644
- #
645
- # For the purposes of access control, you must provide the OCID of the compartment where you want the subnet
646
- # to reside. Notice that the subnet doesn't have to be in the same compartment as the VCN, route tables, or
647
- # other Networking Service components. If you're not sure which compartment to use, put the subnet in
648
- # the same compartment as the VCN. For more information about compartments and access control, see
649
- # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs,
650
- # see [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
651
- #
652
- # You may optionally associate a route table with the subnet. If you don't, the subnet will use the
653
- # VCN's default route table. For more information about route tables, see
654
- # [Managing Route Tables](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm).
655
- #
656
- # You may optionally associate a security list with the subnet. If you don't, the subnet will use the
657
- # VCN's default security list. For more information about security lists, see
658
- # [Security Lists](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/securitylists.htm).
659
- #
660
- # You may optionally associate a set of DHCP options with the subnet. If you don't, the subnet will use the
661
- # VCN's default set. For more information about DHCP options, see
662
- # [Managing DHCP Options](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingDHCP.htm).
663
- #
664
- # You may optionally specify a *display name* for the subnet, otherwise a default is provided.
665
- # It does not have to be unique, and you can change it. Avoid entering confidential information.
666
- #
667
- # You can also add a DNS label for the subnet, which is required if you want the Internet and
668
- # VCN Resolver to resolve hostnames for instances in the subnet. For more information, see
669
- # [DNS in Your Virtual Cloud Network](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
670
- #
671
- # @param [CreateSubnetDetails] create_subnet_details Details for creating a subnet.
672
- # @param [Hash] opts the optional parameters
673
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
674
- # server error without risk of executing that same action again. Retry tokens expire after 24
675
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
676
- # has been deleted and purged from the system, then a retry of the original creation request
677
- # may be rejected).
678
- #
679
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Subnet
680
- def create_subnet(create_subnet_details, opts = {})
681
- logger.debug "Calling operation VirtualNetworkClient#create_subnet." if logger
682
-
683
- fail "Missing the required parameter 'create_subnet_details' when calling create_subnet." if create_subnet_details.nil?
684
-
685
- path = "/subnets"
686
-
687
- # Query Params
688
- query_params = {}
689
-
690
- # Header Params
691
- header_params = {}
692
- header_params['accept'] = 'application/json'
693
- header_params['content-type'] = 'application/json'
694
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
695
-
696
- post_body = @api_client.object_to_http_body(create_subnet_details)
697
-
698
- return @api_client.call_api(
699
- :POST,
700
- path,
701
- endpoint,
702
- :header_params => header_params,
703
- :query_params => query_params,
704
- :body => post_body,
705
- :return_type => 'OracleBMC::Core::Models::Subnet')
706
- end
707
-
708
- # Creates a new Virtual Cloud Network (VCN). For more information, see
709
- # [Managing Virtual Cloud Networks (VCNs)](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVCNs.htm).
710
- #
711
- # For the VCN you must specify a single, contiguous IPv4 CIDR block. Oracle recommends using one of the
712
- # private IP address ranges specified in [RFC 1918](https://tools.ietf.org/html/rfc1918) (10.0.0.0/8,
713
- # 172.16/12, and 192.168/16). Example: 172.16.0.0/16. The CIDR block can range from /16 to /30, and it
714
- # must not overlap with your on-premise network. You can't change the size of the VCN after creation.
715
- #
716
- # For the purposes of access control, you must provide the OCID of the compartment where you want the VCN to
717
- # reside. Consult an Oracle Bare Metal Cloud Services administrator in your organization if you're not sure which
718
- # compartment to use. Notice that the VCN doesn't have to be in the same compartment as the subnets or other
719
- # Networking Service components. For more information about compartments and access control, see
720
- # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm). For information about OCIDs, see
721
- # [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
722
- #
723
- # You may optionally specify a *display name* for the VCN, otherwise a default is provided. It does not have to
724
- # be unique, and you can change it. Avoid entering confidential information.
725
- #
726
- # You can also add a DNS label for the VCN, which is required if you want the instances to use the
727
- # Interent and VCN Resolver option for DNS in the VCN. For more information, see
728
- # [DNS in Your Virtual Cloud Network](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/dns.htm).
729
- #
730
- # The VCN automatically comes with a default route table, default security list, and default set of DHCP options.
731
- # The OCID for each is returned in the response. You can't delete these default objects, but you can change their
732
- # contents (i.e., route rules, etc.)
733
- #
734
- # The VCN and subnets you create are not accessible until you attach an Internet Gateway or set up an IPSec VPN
735
- # or FastConnect. For more information, see
736
- # [Overview of the Networking Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/overview.htm).
737
- #
738
- # @param [CreateVcnDetails] create_vcn_details Details for creating a new VCN.
739
- # @param [Hash] opts the optional parameters
740
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
741
- # server error without risk of executing that same action again. Retry tokens expire after 24
742
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
743
- # has been deleted and purged from the system, then a retry of the original creation request
744
- # may be rejected).
745
- #
746
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Vcn
747
- def create_vcn(create_vcn_details, opts = {})
748
- logger.debug "Calling operation VirtualNetworkClient#create_vcn." if logger
749
-
750
- fail "Missing the required parameter 'create_vcn_details' when calling create_vcn." if create_vcn_details.nil?
751
-
752
- path = "/vcns"
753
-
754
- # Query Params
755
- query_params = {}
756
-
757
- # Header Params
758
- header_params = {}
759
- header_params['accept'] = 'application/json'
760
- header_params['content-type'] = 'application/json'
761
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
762
-
763
- post_body = @api_client.object_to_http_body(create_vcn_details)
764
-
765
- return @api_client.call_api(
766
- :POST,
767
- path,
768
- endpoint,
769
- :header_params => header_params,
770
- :query_params => query_params,
771
- :body => post_body,
772
- :return_type => 'OracleBMC::Core::Models::Vcn')
773
- end
774
-
775
- # Creates a new virtual circuit to use with Oracle Bare Metal Cloud
776
- # Services FastConnect. For more information, see
777
- # [FastConnect Overview](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).
778
- #
779
- # For the purposes of access control, you must provide the OCID of the
780
- # compartment where you want the virtual circuit to reside. If you're
781
- # not sure which compartment to use, put the virtual circuit in the
782
- # same compartment with the DRG it's using. For more information about
783
- # compartments and access control, see
784
- # [Overview of the IAM Service](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
785
- # For information about OCIDs, see
786
- # [Resource Identifiers](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/identifiers.htm).
787
- #
788
- # You may optionally specify a *display name* for the virtual circuit.
789
- # It does not have to be unique, and you can change it. Avoid entering confidential information.
790
- #
791
- # **Important:** When creating a virtual circuit, you specify a DRG for
792
- # the traffic to flow through. Make sure you attach the DRG to your
793
- # VCN and confirm the VCN's routing sends traffic to the DRG. Otherwise
794
- # traffic will not flow. For more information, see
795
- # [Managing Route Tables](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm).
796
- #
797
- # @param [CreateVirtualCircuitDetails] create_virtual_circuit_details Details to create a VirtualCircuit.
798
- # @param [Hash] opts the optional parameters
799
- # @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case of a timeout or
800
- # server error without risk of executing that same action again. Retry tokens expire after 24
801
- # hours, but can be invalidated before then due to conflicting operations (e.g., if a resource
802
- # has been deleted and purged from the system, then a retry of the original creation request
803
- # may be rejected).
804
- #
805
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::VirtualCircuit
806
- def create_virtual_circuit(create_virtual_circuit_details, opts = {})
807
- logger.debug "Calling operation VirtualNetworkClient#create_virtual_circuit." if logger
808
-
809
- fail "Missing the required parameter 'create_virtual_circuit_details' when calling create_virtual_circuit." if create_virtual_circuit_details.nil?
810
-
811
- path = "/virtualCircuits"
812
-
813
- # Query Params
814
- query_params = {}
815
-
816
- # Header Params
817
- header_params = {}
818
- header_params['accept'] = 'application/json'
819
- header_params['content-type'] = 'application/json'
820
- header_params[:'opc-retry-token'] = opts[:'opc_retry_token'] if opts[:'opc_retry_token']
821
-
822
- post_body = @api_client.object_to_http_body(create_virtual_circuit_details)
823
-
824
- return @api_client.call_api(
825
- :POST,
826
- path,
827
- endpoint,
828
- :header_params => header_params,
829
- :query_params => query_params,
830
- :body => post_body,
831
- :return_type => 'OracleBMC::Core::Models::VirtualCircuit')
832
- end
833
-
834
- # Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous
835
- # operation; the CPE's `lifecycleState` will change to TERMINATING temporarily until the CPE is completely
836
- # removed.
837
- #
838
- # @param [String] cpe_id The OCID of the CPE.
839
- # @param [Hash] opts the optional parameters
840
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
841
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
842
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
843
- #
844
- # @return [Response] A Response object with data of type nil
845
- def delete_cpe(cpe_id, opts = {})
846
- logger.debug "Calling operation VirtualNetworkClient#delete_cpe." if logger
847
-
848
- fail "Missing the required parameter 'cpe_id' when calling delete_cpe." if cpe_id.nil?
849
-
850
- path = "/cpes/{cpeId}".sub('{cpeId}', cpe_id.to_s)
851
-
852
- # Query Params
853
- query_params = {}
854
-
855
- # Header Params
856
- header_params = {}
857
- header_params['accept'] = 'application/json'
858
- header_params['content-type'] = 'application/json'
859
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
860
-
861
- post_body = nil
862
-
863
- return @api_client.call_api(
864
- :DELETE,
865
- path,
866
- endpoint,
867
- :header_params => header_params,
868
- :query_params => query_params,
869
- :body => post_body)
870
- end
871
-
872
- # Deletes the specified cross-connect. It must not be mapped to a
873
- # {VirtualCircuit}.
874
- #
875
- # @param [String] cross_connect_id The OCID of the cross-connect.
876
- # @param [Hash] opts the optional parameters
877
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
878
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
879
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
880
- #
881
- # @return [Response] A Response object with data of type nil
882
- def delete_cross_connect(cross_connect_id, opts = {})
883
- logger.debug "Calling operation VirtualNetworkClient#delete_cross_connect." if logger
884
-
885
- fail "Missing the required parameter 'cross_connect_id' when calling delete_cross_connect." if cross_connect_id.nil?
886
-
887
- path = "/crossConnects/{crossConnectId}".sub('{crossConnectId}', cross_connect_id.to_s)
888
-
889
- # Query Params
890
- query_params = {}
891
-
892
- # Header Params
893
- header_params = {}
894
- header_params['accept'] = 'application/json'
895
- header_params['content-type'] = 'application/json'
896
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
897
-
898
- post_body = nil
899
-
900
- return @api_client.call_api(
901
- :DELETE,
902
- path,
903
- endpoint,
904
- :header_params => header_params,
905
- :query_params => query_params,
906
- :body => post_body)
907
- end
908
-
909
- # Deletes the specified cross-connect group. It must not contain any
910
- # cross-connects, and it cannot be mapped to a
911
- # {VirtualCircuit}.
912
- #
913
- # @param [String] cross_connect_group_id The OCID of the cross-connect group.
914
- # @param [Hash] opts the optional parameters
915
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
916
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
917
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
918
- #
919
- # @return [Response] A Response object with data of type nil
920
- def delete_cross_connect_group(cross_connect_group_id, opts = {})
921
- logger.debug "Calling operation VirtualNetworkClient#delete_cross_connect_group." if logger
922
-
923
- fail "Missing the required parameter 'cross_connect_group_id' when calling delete_cross_connect_group." if cross_connect_group_id.nil?
924
-
925
- path = "/crossConnectGroups/{crossConnectGroupId}".sub('{crossConnectGroupId}', cross_connect_group_id.to_s)
926
-
927
- # Query Params
928
- query_params = {}
929
-
930
- # Header Params
931
- header_params = {}
932
- header_params['accept'] = 'application/json'
933
- header_params['content-type'] = 'application/json'
934
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
935
-
936
- post_body = nil
937
-
938
- return @api_client.call_api(
939
- :DELETE,
940
- path,
941
- endpoint,
942
- :header_params => header_params,
943
- :query_params => query_params,
944
- :body => post_body)
945
- end
946
-
947
- # Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a
948
- # VCN's default set of DHCP options.
949
- #
950
- # This is an asynchronous operation; the state of the set of options will switch to TERMINATING temporarily
951
- # until the set is completely removed.
952
- #
953
- # @param [String] dhcp_id The OCID for the set of DHCP options.
954
- # @param [Hash] opts the optional parameters
955
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
956
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
957
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
958
- #
959
- # @return [Response] A Response object with data of type nil
960
- def delete_dhcp_options(dhcp_id, opts = {})
961
- logger.debug "Calling operation VirtualNetworkClient#delete_dhcp_options." if logger
962
-
963
- fail "Missing the required parameter 'dhcp_id' when calling delete_dhcp_options." if dhcp_id.nil?
964
-
965
- path = "/dhcps/{dhcpId}".sub('{dhcpId}', dhcp_id.to_s)
966
-
967
- # Query Params
968
- query_params = {}
969
-
970
- # Header Params
971
- header_params = {}
972
- header_params['accept'] = 'application/json'
973
- header_params['content-type'] = 'application/json'
974
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
975
-
976
- post_body = nil
977
-
978
- return @api_client.call_api(
979
- :DELETE,
980
- path,
981
- endpoint,
982
- :header_params => header_params,
983
- :query_params => query_params,
984
- :body => post_body)
985
- end
986
-
987
- # Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise
988
- # network. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous
989
- # operation; the DRG's `lifecycleState` will change to TERMINATING temporarily until the DRG is completely
990
- # removed.
991
- #
992
- # @param [String] drg_id The OCID of the DRG.
993
- # @param [Hash] opts the optional parameters
994
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
995
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
996
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
997
- #
998
- # @return [Response] A Response object with data of type nil
999
- def delete_drg(drg_id, opts = {})
1000
- logger.debug "Calling operation VirtualNetworkClient#delete_drg." if logger
1001
-
1002
- fail "Missing the required parameter 'drg_id' when calling delete_drg." if drg_id.nil?
1003
-
1004
- path = "/drgs/{drgId}".sub('{drgId}', drg_id.to_s)
1005
-
1006
- # Query Params
1007
- query_params = {}
1008
-
1009
- # Header Params
1010
- header_params = {}
1011
- header_params['accept'] = 'application/json'
1012
- header_params['content-type'] = 'application/json'
1013
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
1014
-
1015
- post_body = nil
1016
-
1017
- return @api_client.call_api(
1018
- :DELETE,
1019
- path,
1020
- endpoint,
1021
- :header_params => header_params,
1022
- :query_params => query_params,
1023
- :body => post_body)
1024
- end
1025
-
1026
- # Detaches a DRG from a VCN by deleting the corresponding `DrgAttachment`. This is an asynchronous
1027
- # operation; the attachment's `lifecycleState` will change to DETACHING temporarily until the attachment
1028
- # is completely removed.
1029
- #
1030
- # @param [String] drg_attachment_id The OCID of the DRG attachment.
1031
- # @param [Hash] opts the optional parameters
1032
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
1033
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
1034
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
1035
- #
1036
- # @return [Response] A Response object with data of type nil
1037
- def delete_drg_attachment(drg_attachment_id, opts = {})
1038
- logger.debug "Calling operation VirtualNetworkClient#delete_drg_attachment." if logger
1039
-
1040
- fail "Missing the required parameter 'drg_attachment_id' when calling delete_drg_attachment." if drg_attachment_id.nil?
1041
-
1042
- path = "/drgAttachments/{drgAttachmentId}".sub('{drgAttachmentId}', drg_attachment_id.to_s)
1043
-
1044
- # Query Params
1045
- query_params = {}
1046
-
1047
- # Header Params
1048
- header_params = {}
1049
- header_params['accept'] = 'application/json'
1050
- header_params['content-type'] = 'application/json'
1051
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
1052
-
1053
- post_body = nil
1054
-
1055
- return @api_client.call_api(
1056
- :DELETE,
1057
- path,
1058
- endpoint,
1059
- :header_params => header_params,
1060
- :query_params => query_params,
1061
- :body => post_body)
1062
- end
1063
-
1064
- # Deletes the specified Internet Gateway. The Internet Gateway does not have to be disabled, but
1065
- # there must not be a route table that lists it as a target.
1066
- #
1067
- # This is an asynchronous operation; the gateway's `lifecycleState` will change to TERMINATING temporarily
1068
- # until the gateway is completely removed.
1069
- #
1070
- # @param [String] ig_id The OCID of the Internet Gateway.
1071
- # @param [Hash] opts the optional parameters
1072
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
1073
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
1074
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
1075
- #
1076
- # @return [Response] A Response object with data of type nil
1077
- def delete_internet_gateway(ig_id, opts = {})
1078
- logger.debug "Calling operation VirtualNetworkClient#delete_internet_gateway." if logger
1079
-
1080
- fail "Missing the required parameter 'ig_id' when calling delete_internet_gateway." if ig_id.nil?
1081
-
1082
- path = "/internetGateways/{igId}".sub('{igId}', ig_id.to_s)
1083
-
1084
- # Query Params
1085
- query_params = {}
1086
-
1087
- # Header Params
1088
- header_params = {}
1089
- header_params['accept'] = 'application/json'
1090
- header_params['content-type'] = 'application/json'
1091
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
1092
-
1093
- post_body = nil
1094
-
1095
- return @api_client.call_api(
1096
- :DELETE,
1097
- path,
1098
- endpoint,
1099
- :header_params => header_params,
1100
- :query_params => query_params,
1101
- :body => post_body)
1102
- end
1103
-
1104
- # Deletes the specified IPSec connection. If your goal is to disable the IPSec VPN between your VCN and
1105
- # on-premise network, it's easiest to simply detach the DRG but keep all the IPSec VPN components intact.
1106
- # If you were to delete all the components and then later need to create an IPSec VPN again, you would
1107
- # need to configure your on-premise router again with the new information returned from
1108
- # {#create_ip_sec_connection create_ip_sec_connection}.
1109
- #
1110
- # This is an asynchronous operation; the connection's `lifecycleState` will change to TERMINATING temporarily
1111
- # until the connection is completely removed.
1112
- #
1113
- # @param [String] ipsc_id The OCID of the IPSec connection.
1114
- # @param [Hash] opts the optional parameters
1115
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
1116
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
1117
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
1118
- #
1119
- # @return [Response] A Response object with data of type nil
1120
- def delete_ip_sec_connection(ipsc_id, opts = {})
1121
- logger.debug "Calling operation VirtualNetworkClient#delete_ip_sec_connection." if logger
1122
-
1123
- fail "Missing the required parameter 'ipsc_id' when calling delete_ip_sec_connection." if ipsc_id.nil?
1124
-
1125
- path = "/ipsecConnections/{ipscId}".sub('{ipscId}', ipsc_id.to_s)
1126
-
1127
- # Query Params
1128
- query_params = {}
1129
-
1130
- # Header Params
1131
- header_params = {}
1132
- header_params['accept'] = 'application/json'
1133
- header_params['content-type'] = 'application/json'
1134
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
1135
-
1136
- post_body = nil
1137
-
1138
- return @api_client.call_api(
1139
- :DELETE,
1140
- path,
1141
- endpoint,
1142
- :header_params => header_params,
1143
- :query_params => query_params,
1144
- :body => post_body)
1145
- end
1146
-
1147
- # Unassigns and deletes the specified private IP. You must
1148
- # specify the object's OCID. The private IP address is returned to
1149
- # the subnet's pool of available addresses.
1150
- #
1151
- # This operation cannot be used with primary private IPs, which are
1152
- # automatically unassigned and deleted when the VNIC is terminated.
1153
- #
1154
- # @param [String] private_ip_id The private IP's OCID.
1155
- # @param [Hash] opts the optional parameters
1156
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
1157
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
1158
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
1159
- #
1160
- # @return [Response] A Response object with data of type nil
1161
- def delete_private_ip(private_ip_id, opts = {})
1162
- logger.debug "Calling operation VirtualNetworkClient#delete_private_ip." if logger
1163
-
1164
- fail "Missing the required parameter 'private_ip_id' when calling delete_private_ip." if private_ip_id.nil?
1165
-
1166
- path = "/privateIps/{privateIpId}".sub('{privateIpId}', private_ip_id.to_s)
1167
-
1168
- # Query Params
1169
- query_params = {}
1170
-
1171
- # Header Params
1172
- header_params = {}
1173
- header_params['accept'] = 'application/json'
1174
- header_params['content-type'] = 'application/json'
1175
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
1176
-
1177
- post_body = nil
1178
-
1179
- return @api_client.call_api(
1180
- :DELETE,
1181
- path,
1182
- endpoint,
1183
- :header_params => header_params,
1184
- :query_params => query_params,
1185
- :body => post_body)
1186
- end
1187
-
1188
- # Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a
1189
- # VCN's default route table.
1190
- #
1191
- # This is an asynchronous operation; the route table's `lifecycleState` will change to TERMINATING temporarily
1192
- # until the route table is completely removed.
1193
- #
1194
- # @param [String] rt_id The OCID of the route table.
1195
- # @param [Hash] opts the optional parameters
1196
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
1197
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
1198
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
1199
- #
1200
- # @return [Response] A Response object with data of type nil
1201
- def delete_route_table(rt_id, opts = {})
1202
- logger.debug "Calling operation VirtualNetworkClient#delete_route_table." if logger
1203
-
1204
- fail "Missing the required parameter 'rt_id' when calling delete_route_table." if rt_id.nil?
1205
-
1206
- path = "/routeTables/{rtId}".sub('{rtId}', rt_id.to_s)
1207
-
1208
- # Query Params
1209
- query_params = {}
1210
-
1211
- # Header Params
1212
- header_params = {}
1213
- header_params['accept'] = 'application/json'
1214
- header_params['content-type'] = 'application/json'
1215
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
1216
-
1217
- post_body = nil
1218
-
1219
- return @api_client.call_api(
1220
- :DELETE,
1221
- path,
1222
- endpoint,
1223
- :header_params => header_params,
1224
- :query_params => query_params,
1225
- :body => post_body)
1226
- end
1227
-
1228
- # Deletes the specified security list, but only if it's not associated with a subnet. You can't delete
1229
- # a VCN's default security list.
1230
- #
1231
- # This is an asynchronous operation; the security list's `lifecycleState` will change to TERMINATING temporarily
1232
- # until the security list is completely removed.
1233
- #
1234
- # @param [String] security_list_id The OCID of the security list.
1235
- # @param [Hash] opts the optional parameters
1236
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
1237
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
1238
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
1239
- #
1240
- # @return [Response] A Response object with data of type nil
1241
- def delete_security_list(security_list_id, opts = {})
1242
- logger.debug "Calling operation VirtualNetworkClient#delete_security_list." if logger
1243
-
1244
- fail "Missing the required parameter 'security_list_id' when calling delete_security_list." if security_list_id.nil?
1245
-
1246
- path = "/securityLists/{securityListId}".sub('{securityListId}', security_list_id.to_s)
1247
-
1248
- # Query Params
1249
- query_params = {}
1250
-
1251
- # Header Params
1252
- header_params = {}
1253
- header_params['accept'] = 'application/json'
1254
- header_params['content-type'] = 'application/json'
1255
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
1256
-
1257
- post_body = nil
1258
-
1259
- return @api_client.call_api(
1260
- :DELETE,
1261
- path,
1262
- endpoint,
1263
- :header_params => header_params,
1264
- :query_params => query_params,
1265
- :body => post_body)
1266
- end
1267
-
1268
- # Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous
1269
- # operation; the subnet's `lifecycleState` will change to TERMINATING temporarily. If there are any
1270
- # instances in the subnet, the state will instead change back to AVAILABLE.
1271
- #
1272
- # @param [String] subnet_id The OCID of the subnet.
1273
- # @param [Hash] opts the optional parameters
1274
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
1275
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
1276
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
1277
- #
1278
- # @return [Response] A Response object with data of type nil
1279
- def delete_subnet(subnet_id, opts = {})
1280
- logger.debug "Calling operation VirtualNetworkClient#delete_subnet." if logger
1281
-
1282
- fail "Missing the required parameter 'subnet_id' when calling delete_subnet." if subnet_id.nil?
1283
-
1284
- path = "/subnets/{subnetId}".sub('{subnetId}', subnet_id.to_s)
1285
-
1286
- # Query Params
1287
- query_params = {}
1288
-
1289
- # Header Params
1290
- header_params = {}
1291
- header_params['accept'] = 'application/json'
1292
- header_params['content-type'] = 'application/json'
1293
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
1294
-
1295
- post_body = nil
1296
-
1297
- return @api_client.call_api(
1298
- :DELETE,
1299
- path,
1300
- endpoint,
1301
- :header_params => header_params,
1302
- :query_params => query_params,
1303
- :body => post_body)
1304
- end
1305
-
1306
- # Deletes the specified VCN. The VCN must be empty and have no attached gateways. This is an asynchronous
1307
- # operation; the VCN's `lifecycleState` will change to TERMINATING temporarily until the VCN is completely
1308
- # removed.
1309
- #
1310
- # @param [String] vcn_id The OCID of the VCN.
1311
- # @param [Hash] opts the optional parameters
1312
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
1313
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
1314
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
1315
- #
1316
- # @return [Response] A Response object with data of type nil
1317
- def delete_vcn(vcn_id, opts = {})
1318
- logger.debug "Calling operation VirtualNetworkClient#delete_vcn." if logger
1319
-
1320
- fail "Missing the required parameter 'vcn_id' when calling delete_vcn." if vcn_id.nil?
1321
-
1322
- path = "/vcns/{vcnId}".sub('{vcnId}', vcn_id.to_s)
1323
-
1324
- # Query Params
1325
- query_params = {}
1326
-
1327
- # Header Params
1328
- header_params = {}
1329
- header_params['accept'] = 'application/json'
1330
- header_params['content-type'] = 'application/json'
1331
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
1332
-
1333
- post_body = nil
1334
-
1335
- return @api_client.call_api(
1336
- :DELETE,
1337
- path,
1338
- endpoint,
1339
- :header_params => header_params,
1340
- :query_params => query_params,
1341
- :body => post_body)
1342
- end
1343
-
1344
- # Deletes the specified virtual circuit.
1345
- #
1346
- # **Important:** If you're using FastConnect via a provider,
1347
- # make sure to also terminate the connection with
1348
- # the provider, or else the provider may continue to bill you.
1349
- #
1350
- # @param [String] virtual_circuit_id The OCID of the virtual circuit.
1351
- # @param [Hash] opts the optional parameters
1352
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
1353
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
1354
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
1355
- #
1356
- # @return [Response] A Response object with data of type nil
1357
- def delete_virtual_circuit(virtual_circuit_id, opts = {})
1358
- logger.debug "Calling operation VirtualNetworkClient#delete_virtual_circuit." if logger
1359
-
1360
- fail "Missing the required parameter 'virtual_circuit_id' when calling delete_virtual_circuit." if virtual_circuit_id.nil?
1361
-
1362
- path = "/virtualCircuits/{virtualCircuitId}".sub('{virtualCircuitId}', virtual_circuit_id.to_s)
1363
-
1364
- # Query Params
1365
- query_params = {}
1366
-
1367
- # Header Params
1368
- header_params = {}
1369
- header_params['accept'] = 'application/json'
1370
- header_params['content-type'] = 'application/json'
1371
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
1372
-
1373
- post_body = nil
1374
-
1375
- return @api_client.call_api(
1376
- :DELETE,
1377
- path,
1378
- endpoint,
1379
- :header_params => header_params,
1380
- :query_params => query_params,
1381
- :body => post_body)
1382
- end
1383
-
1384
- # Gets the specified CPE's information.
1385
- # @param [String] cpe_id The OCID of the CPE.
1386
- # @param [Hash] opts the optional parameters
1387
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Cpe
1388
- def get_cpe(cpe_id, opts = {})
1389
- logger.debug "Calling operation VirtualNetworkClient#get_cpe." if logger
1390
-
1391
- fail "Missing the required parameter 'cpe_id' when calling get_cpe." if cpe_id.nil?
1392
-
1393
- path = "/cpes/{cpeId}".sub('{cpeId}', cpe_id.to_s)
1394
-
1395
- # Query Params
1396
- query_params = {}
1397
-
1398
- # Header Params
1399
- header_params = {}
1400
- header_params['accept'] = 'application/json'
1401
- header_params['content-type'] = 'application/json'
1402
-
1403
- post_body = nil
1404
-
1405
- return @api_client.call_api(
1406
- :GET,
1407
- path,
1408
- endpoint,
1409
- :header_params => header_params,
1410
- :query_params => query_params,
1411
- :body => post_body,
1412
- :return_type => 'OracleBMC::Core::Models::Cpe')
1413
- end
1414
-
1415
- # Gets the specified cross-connect's information.
1416
- # @param [String] cross_connect_id The OCID of the cross-connect.
1417
- # @param [Hash] opts the optional parameters
1418
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::CrossConnect
1419
- def get_cross_connect(cross_connect_id, opts = {})
1420
- logger.debug "Calling operation VirtualNetworkClient#get_cross_connect." if logger
1421
-
1422
- fail "Missing the required parameter 'cross_connect_id' when calling get_cross_connect." if cross_connect_id.nil?
1423
-
1424
- path = "/crossConnects/{crossConnectId}".sub('{crossConnectId}', cross_connect_id.to_s)
1425
-
1426
- # Query Params
1427
- query_params = {}
1428
-
1429
- # Header Params
1430
- header_params = {}
1431
- header_params['accept'] = 'application/json'
1432
- header_params['content-type'] = 'application/json'
1433
-
1434
- post_body = nil
1435
-
1436
- return @api_client.call_api(
1437
- :GET,
1438
- path,
1439
- endpoint,
1440
- :header_params => header_params,
1441
- :query_params => query_params,
1442
- :body => post_body,
1443
- :return_type => 'OracleBMC::Core::Models::CrossConnect')
1444
- end
1445
-
1446
- # Gets the specified cross-connect group's information.
1447
- # @param [String] cross_connect_group_id The OCID of the cross-connect group.
1448
- # @param [Hash] opts the optional parameters
1449
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::CrossConnectGroup
1450
- def get_cross_connect_group(cross_connect_group_id, opts = {})
1451
- logger.debug "Calling operation VirtualNetworkClient#get_cross_connect_group." if logger
1452
-
1453
- fail "Missing the required parameter 'cross_connect_group_id' when calling get_cross_connect_group." if cross_connect_group_id.nil?
1454
-
1455
- path = "/crossConnectGroups/{crossConnectGroupId}".sub('{crossConnectGroupId}', cross_connect_group_id.to_s)
1456
-
1457
- # Query Params
1458
- query_params = {}
1459
-
1460
- # Header Params
1461
- header_params = {}
1462
- header_params['accept'] = 'application/json'
1463
- header_params['content-type'] = 'application/json'
1464
-
1465
- post_body = nil
1466
-
1467
- return @api_client.call_api(
1468
- :GET,
1469
- path,
1470
- endpoint,
1471
- :header_params => header_params,
1472
- :query_params => query_params,
1473
- :body => post_body,
1474
- :return_type => 'OracleBMC::Core::Models::CrossConnectGroup')
1475
- end
1476
-
1477
- # Gets the Letter of Authority for the specified cross-connect.
1478
- # @param [String] cross_connect_id The OCID of the cross-connect.
1479
- # @param [Hash] opts the optional parameters
1480
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::LetterOfAuthority
1481
- def get_cross_connect_letter_of_authority(cross_connect_id, opts = {})
1482
- logger.debug "Calling operation VirtualNetworkClient#get_cross_connect_letter_of_authority." if logger
1483
-
1484
- fail "Missing the required parameter 'cross_connect_id' when calling get_cross_connect_letter_of_authority." if cross_connect_id.nil?
1485
-
1486
- path = "/crossConnects/{crossConnectId}/letterOfAuthority".sub('{crossConnectId}', cross_connect_id.to_s)
1487
-
1488
- # Query Params
1489
- query_params = {}
1490
-
1491
- # Header Params
1492
- header_params = {}
1493
- header_params['accept'] = 'application/json'
1494
- header_params['content-type'] = 'application/json'
1495
-
1496
- post_body = nil
1497
-
1498
- return @api_client.call_api(
1499
- :GET,
1500
- path,
1501
- endpoint,
1502
- :header_params => header_params,
1503
- :query_params => query_params,
1504
- :body => post_body,
1505
- :return_type => 'OracleBMC::Core::Models::LetterOfAuthority')
1506
- end
1507
-
1508
- # Gets the status of the specified cross-connect.
1509
- #
1510
- # @param [String] cross_connect_id The OCID of the cross-connect.
1511
- # @param [Hash] opts the optional parameters
1512
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::CrossConnectStatus
1513
- def get_cross_connect_status(cross_connect_id, opts = {})
1514
- logger.debug "Calling operation VirtualNetworkClient#get_cross_connect_status." if logger
1515
-
1516
- fail "Missing the required parameter 'cross_connect_id' when calling get_cross_connect_status." if cross_connect_id.nil?
1517
-
1518
- path = "/crossConnects/{crossConnectId}/status".sub('{crossConnectId}', cross_connect_id.to_s)
1519
-
1520
- # Query Params
1521
- query_params = {}
1522
-
1523
- # Header Params
1524
- header_params = {}
1525
- header_params['accept'] = 'application/json'
1526
- header_params['content-type'] = 'application/json'
1527
-
1528
- post_body = nil
1529
-
1530
- return @api_client.call_api(
1531
- :GET,
1532
- path,
1533
- endpoint,
1534
- :header_params => header_params,
1535
- :query_params => query_params,
1536
- :body => post_body,
1537
- :return_type => 'OracleBMC::Core::Models::CrossConnectStatus')
1538
- end
1539
-
1540
- # Gets the specified set of DHCP options.
1541
- # @param [String] dhcp_id The OCID for the set of DHCP options.
1542
- # @param [Hash] opts the optional parameters
1543
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::DhcpOptions
1544
- def get_dhcp_options(dhcp_id, opts = {})
1545
- logger.debug "Calling operation VirtualNetworkClient#get_dhcp_options." if logger
1546
-
1547
- fail "Missing the required parameter 'dhcp_id' when calling get_dhcp_options." if dhcp_id.nil?
1548
-
1549
- path = "/dhcps/{dhcpId}".sub('{dhcpId}', dhcp_id.to_s)
1550
-
1551
- # Query Params
1552
- query_params = {}
1553
-
1554
- # Header Params
1555
- header_params = {}
1556
- header_params['accept'] = 'application/json'
1557
- header_params['content-type'] = 'application/json'
1558
-
1559
- post_body = nil
1560
-
1561
- return @api_client.call_api(
1562
- :GET,
1563
- path,
1564
- endpoint,
1565
- :header_params => header_params,
1566
- :query_params => query_params,
1567
- :body => post_body,
1568
- :return_type => 'OracleBMC::Core::Models::DhcpOptions')
1569
- end
1570
-
1571
- # Gets the specified DRG's information.
1572
- # @param [String] drg_id The OCID of the DRG.
1573
- # @param [Hash] opts the optional parameters
1574
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Drg
1575
- def get_drg(drg_id, opts = {})
1576
- logger.debug "Calling operation VirtualNetworkClient#get_drg." if logger
1577
-
1578
- fail "Missing the required parameter 'drg_id' when calling get_drg." if drg_id.nil?
1579
-
1580
- path = "/drgs/{drgId}".sub('{drgId}', drg_id.to_s)
1581
-
1582
- # Query Params
1583
- query_params = {}
1584
-
1585
- # Header Params
1586
- header_params = {}
1587
- header_params['accept'] = 'application/json'
1588
- header_params['content-type'] = 'application/json'
1589
-
1590
- post_body = nil
1591
-
1592
- return @api_client.call_api(
1593
- :GET,
1594
- path,
1595
- endpoint,
1596
- :header_params => header_params,
1597
- :query_params => query_params,
1598
- :body => post_body,
1599
- :return_type => 'OracleBMC::Core::Models::Drg')
1600
- end
1601
-
1602
- # Gets the information for the specified `DrgAttachment`.
1603
- # @param [String] drg_attachment_id The OCID of the DRG attachment.
1604
- # @param [Hash] opts the optional parameters
1605
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::DrgAttachment
1606
- def get_drg_attachment(drg_attachment_id, opts = {})
1607
- logger.debug "Calling operation VirtualNetworkClient#get_drg_attachment." if logger
1608
-
1609
- fail "Missing the required parameter 'drg_attachment_id' when calling get_drg_attachment." if drg_attachment_id.nil?
1610
-
1611
- path = "/drgAttachments/{drgAttachmentId}".sub('{drgAttachmentId}', drg_attachment_id.to_s)
1612
-
1613
- # Query Params
1614
- query_params = {}
1615
-
1616
- # Header Params
1617
- header_params = {}
1618
- header_params['accept'] = 'application/json'
1619
- header_params['content-type'] = 'application/json'
1620
-
1621
- post_body = nil
1622
-
1623
- return @api_client.call_api(
1624
- :GET,
1625
- path,
1626
- endpoint,
1627
- :header_params => header_params,
1628
- :query_params => query_params,
1629
- :body => post_body,
1630
- :return_type => 'OracleBMC::Core::Models::DrgAttachment')
1631
- end
1632
-
1633
- # Gets the specified Internet Gateway's information.
1634
- # @param [String] ig_id The OCID of the Internet Gateway.
1635
- # @param [Hash] opts the optional parameters
1636
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::InternetGateway
1637
- def get_internet_gateway(ig_id, opts = {})
1638
- logger.debug "Calling operation VirtualNetworkClient#get_internet_gateway." if logger
1639
-
1640
- fail "Missing the required parameter 'ig_id' when calling get_internet_gateway." if ig_id.nil?
1641
-
1642
- path = "/internetGateways/{igId}".sub('{igId}', ig_id.to_s)
1643
-
1644
- # Query Params
1645
- query_params = {}
1646
-
1647
- # Header Params
1648
- header_params = {}
1649
- header_params['accept'] = 'application/json'
1650
- header_params['content-type'] = 'application/json'
1651
-
1652
- post_body = nil
1653
-
1654
- return @api_client.call_api(
1655
- :GET,
1656
- path,
1657
- endpoint,
1658
- :header_params => header_params,
1659
- :query_params => query_params,
1660
- :body => post_body,
1661
- :return_type => 'OracleBMC::Core::Models::InternetGateway')
1662
- end
1663
-
1664
- # Gets the specified IPSec connection's basic information, including the static routes for the
1665
- # on-premise router. If you want the status of the connection (whether it's up or down), use
1666
- # {#get_ip_sec_connection_device_status get_ip_sec_connection_device_status}.
1667
- #
1668
- # @param [String] ipsc_id The OCID of the IPSec connection.
1669
- # @param [Hash] opts the optional parameters
1670
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::IPSecConnection
1671
- def get_ip_sec_connection(ipsc_id, opts = {})
1672
- logger.debug "Calling operation VirtualNetworkClient#get_ip_sec_connection." if logger
1673
-
1674
- fail "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection." if ipsc_id.nil?
1675
-
1676
- path = "/ipsecConnections/{ipscId}".sub('{ipscId}', ipsc_id.to_s)
1677
-
1678
- # Query Params
1679
- query_params = {}
1680
-
1681
- # Header Params
1682
- header_params = {}
1683
- header_params['accept'] = 'application/json'
1684
- header_params['content-type'] = 'application/json'
1685
-
1686
- post_body = nil
1687
-
1688
- return @api_client.call_api(
1689
- :GET,
1690
- path,
1691
- endpoint,
1692
- :header_params => header_params,
1693
- :query_params => query_params,
1694
- :body => post_body,
1695
- :return_type => 'OracleBMC::Core::Models::IPSecConnection')
1696
- end
1697
-
1698
- # Gets the configuration information for the specified IPSec connection. For each tunnel, the
1699
- # response includes the IP address of Oracle's VPN headend and the shared secret.
1700
- #
1701
- # @param [String] ipsc_id The OCID of the IPSec connection.
1702
- # @param [Hash] opts the optional parameters
1703
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::IPSecConnectionDeviceConfig
1704
- def get_ip_sec_connection_device_config(ipsc_id, opts = {})
1705
- logger.debug "Calling operation VirtualNetworkClient#get_ip_sec_connection_device_config." if logger
1706
-
1707
- fail "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_device_config." if ipsc_id.nil?
1708
-
1709
- path = "/ipsecConnections/{ipscId}/deviceConfig".sub('{ipscId}', ipsc_id.to_s)
1710
-
1711
- # Query Params
1712
- query_params = {}
1713
-
1714
- # Header Params
1715
- header_params = {}
1716
- header_params['accept'] = 'application/json'
1717
- header_params['content-type'] = 'application/json'
1718
-
1719
- post_body = nil
1720
-
1721
- return @api_client.call_api(
1722
- :GET,
1723
- path,
1724
- endpoint,
1725
- :header_params => header_params,
1726
- :query_params => query_params,
1727
- :body => post_body,
1728
- :return_type => 'OracleBMC::Core::Models::IPSecConnectionDeviceConfig')
1729
- end
1730
-
1731
- # Gets the status of the specified IPSec connection (whether it's up or down).
1732
- #
1733
- # @param [String] ipsc_id The OCID of the IPSec connection.
1734
- # @param [Hash] opts the optional parameters
1735
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::IPSecConnectionDeviceStatus
1736
- def get_ip_sec_connection_device_status(ipsc_id, opts = {})
1737
- logger.debug "Calling operation VirtualNetworkClient#get_ip_sec_connection_device_status." if logger
1738
-
1739
- fail "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_device_status." if ipsc_id.nil?
1740
-
1741
- path = "/ipsecConnections/{ipscId}/deviceStatus".sub('{ipscId}', ipsc_id.to_s)
1742
-
1743
- # Query Params
1744
- query_params = {}
1745
-
1746
- # Header Params
1747
- header_params = {}
1748
- header_params['accept'] = 'application/json'
1749
- header_params['content-type'] = 'application/json'
1750
-
1751
- post_body = nil
1752
-
1753
- return @api_client.call_api(
1754
- :GET,
1755
- path,
1756
- endpoint,
1757
- :header_params => header_params,
1758
- :query_params => query_params,
1759
- :body => post_body,
1760
- :return_type => 'OracleBMC::Core::Models::IPSecConnectionDeviceStatus')
1761
- end
1762
-
1763
- # Gets the specified private IP. You must specify the object's OCID.
1764
- # Alternatively, you can get the object by using
1765
- # {#list_private_ips list_private_ips}
1766
- # with the private IP address (for example, 10.0.3.3) and subnet OCID.
1767
- #
1768
- # @param [String] private_ip_id The private IP's OCID.
1769
- # @param [Hash] opts the optional parameters
1770
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::PrivateIp
1771
- def get_private_ip(private_ip_id, opts = {})
1772
- logger.debug "Calling operation VirtualNetworkClient#get_private_ip." if logger
1773
-
1774
- fail "Missing the required parameter 'private_ip_id' when calling get_private_ip." if private_ip_id.nil?
1775
-
1776
- path = "/privateIps/{privateIpId}".sub('{privateIpId}', private_ip_id.to_s)
1777
-
1778
- # Query Params
1779
- query_params = {}
1780
-
1781
- # Header Params
1782
- header_params = {}
1783
- header_params['accept'] = 'application/json'
1784
- header_params['content-type'] = 'application/json'
1785
-
1786
- post_body = nil
1787
-
1788
- return @api_client.call_api(
1789
- :GET,
1790
- path,
1791
- endpoint,
1792
- :header_params => header_params,
1793
- :query_params => query_params,
1794
- :body => post_body,
1795
- :return_type => 'OracleBMC::Core::Models::PrivateIp')
1796
- end
1797
-
1798
- # Gets the specified route table's information.
1799
- # @param [String] rt_id The OCID of the route table.
1800
- # @param [Hash] opts the optional parameters
1801
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::RouteTable
1802
- def get_route_table(rt_id, opts = {})
1803
- logger.debug "Calling operation VirtualNetworkClient#get_route_table." if logger
1804
-
1805
- fail "Missing the required parameter 'rt_id' when calling get_route_table." if rt_id.nil?
1806
-
1807
- path = "/routeTables/{rtId}".sub('{rtId}', rt_id.to_s)
1808
-
1809
- # Query Params
1810
- query_params = {}
1811
-
1812
- # Header Params
1813
- header_params = {}
1814
- header_params['accept'] = 'application/json'
1815
- header_params['content-type'] = 'application/json'
1816
-
1817
- post_body = nil
1818
-
1819
- return @api_client.call_api(
1820
- :GET,
1821
- path,
1822
- endpoint,
1823
- :header_params => header_params,
1824
- :query_params => query_params,
1825
- :body => post_body,
1826
- :return_type => 'OracleBMC::Core::Models::RouteTable')
1827
- end
1828
-
1829
- # Gets the specified security list's information.
1830
- # @param [String] security_list_id The OCID of the security list.
1831
- # @param [Hash] opts the optional parameters
1832
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::SecurityList
1833
- def get_security_list(security_list_id, opts = {})
1834
- logger.debug "Calling operation VirtualNetworkClient#get_security_list." if logger
1835
-
1836
- fail "Missing the required parameter 'security_list_id' when calling get_security_list." if security_list_id.nil?
1837
-
1838
- path = "/securityLists/{securityListId}".sub('{securityListId}', security_list_id.to_s)
1839
-
1840
- # Query Params
1841
- query_params = {}
1842
-
1843
- # Header Params
1844
- header_params = {}
1845
- header_params['accept'] = 'application/json'
1846
- header_params['content-type'] = 'application/json'
1847
-
1848
- post_body = nil
1849
-
1850
- return @api_client.call_api(
1851
- :GET,
1852
- path,
1853
- endpoint,
1854
- :header_params => header_params,
1855
- :query_params => query_params,
1856
- :body => post_body,
1857
- :return_type => 'OracleBMC::Core::Models::SecurityList')
1858
- end
1859
-
1860
- # Gets the specified subnet's information.
1861
- # @param [String] subnet_id The OCID of the subnet.
1862
- # @param [Hash] opts the optional parameters
1863
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Subnet
1864
- def get_subnet(subnet_id, opts = {})
1865
- logger.debug "Calling operation VirtualNetworkClient#get_subnet." if logger
1866
-
1867
- fail "Missing the required parameter 'subnet_id' when calling get_subnet." if subnet_id.nil?
1868
-
1869
- path = "/subnets/{subnetId}".sub('{subnetId}', subnet_id.to_s)
1870
-
1871
- # Query Params
1872
- query_params = {}
1873
-
1874
- # Header Params
1875
- header_params = {}
1876
- header_params['accept'] = 'application/json'
1877
- header_params['content-type'] = 'application/json'
1878
-
1879
- post_body = nil
1880
-
1881
- return @api_client.call_api(
1882
- :GET,
1883
- path,
1884
- endpoint,
1885
- :header_params => header_params,
1886
- :query_params => query_params,
1887
- :body => post_body,
1888
- :return_type => 'OracleBMC::Core::Models::Subnet')
1889
- end
1890
-
1891
- # Gets the specified VCN's information.
1892
- # @param [String] vcn_id The OCID of the VCN.
1893
- # @param [Hash] opts the optional parameters
1894
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Vcn
1895
- def get_vcn(vcn_id, opts = {})
1896
- logger.debug "Calling operation VirtualNetworkClient#get_vcn." if logger
1897
-
1898
- fail "Missing the required parameter 'vcn_id' when calling get_vcn." if vcn_id.nil?
1899
-
1900
- path = "/vcns/{vcnId}".sub('{vcnId}', vcn_id.to_s)
1901
-
1902
- # Query Params
1903
- query_params = {}
1904
-
1905
- # Header Params
1906
- header_params = {}
1907
- header_params['accept'] = 'application/json'
1908
- header_params['content-type'] = 'application/json'
1909
-
1910
- post_body = nil
1911
-
1912
- return @api_client.call_api(
1913
- :GET,
1914
- path,
1915
- endpoint,
1916
- :header_params => header_params,
1917
- :query_params => query_params,
1918
- :body => post_body,
1919
- :return_type => 'OracleBMC::Core::Models::Vcn')
1920
- end
1921
-
1922
- # Gets the specified virtual circuit's information.
1923
- # @param [String] virtual_circuit_id The OCID of the virtual circuit.
1924
- # @param [Hash] opts the optional parameters
1925
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::VirtualCircuit
1926
- def get_virtual_circuit(virtual_circuit_id, opts = {})
1927
- logger.debug "Calling operation VirtualNetworkClient#get_virtual_circuit." if logger
1928
-
1929
- fail "Missing the required parameter 'virtual_circuit_id' when calling get_virtual_circuit." if virtual_circuit_id.nil?
1930
-
1931
- path = "/virtualCircuits/{virtualCircuitId}".sub('{virtualCircuitId}', virtual_circuit_id.to_s)
1932
-
1933
- # Query Params
1934
- query_params = {}
1935
-
1936
- # Header Params
1937
- header_params = {}
1938
- header_params['accept'] = 'application/json'
1939
- header_params['content-type'] = 'application/json'
1940
-
1941
- post_body = nil
1942
-
1943
- return @api_client.call_api(
1944
- :GET,
1945
- path,
1946
- endpoint,
1947
- :header_params => header_params,
1948
- :query_params => query_params,
1949
- :body => post_body,
1950
- :return_type => 'OracleBMC::Core::Models::VirtualCircuit')
1951
- end
1952
-
1953
- # Gets the information for the specified virtual network interface card (VNIC).
1954
- # You can get the VNIC OCID from the
1955
- # {#list_vnic_attachments list_vnic_attachments}
1956
- # operation.
1957
- #
1958
- # @param [String] vnic_id The OCID of the VNIC.
1959
- # @param [Hash] opts the optional parameters
1960
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Vnic
1961
- def get_vnic(vnic_id, opts = {})
1962
- logger.debug "Calling operation VirtualNetworkClient#get_vnic." if logger
1963
-
1964
- fail "Missing the required parameter 'vnic_id' when calling get_vnic." if vnic_id.nil?
1965
-
1966
- path = "/vnics/{vnicId}".sub('{vnicId}', vnic_id.to_s)
1967
-
1968
- # Query Params
1969
- query_params = {}
1970
-
1971
- # Header Params
1972
- header_params = {}
1973
- header_params['accept'] = 'application/json'
1974
- header_params['content-type'] = 'application/json'
1975
-
1976
- post_body = nil
1977
-
1978
- return @api_client.call_api(
1979
- :GET,
1980
- path,
1981
- endpoint,
1982
- :header_params => header_params,
1983
- :query_params => query_params,
1984
- :body => post_body,
1985
- :return_type => 'OracleBMC::Core::Models::Vnic')
1986
- end
1987
-
1988
- # Lists the Customer-Premises Equipment objects (CPEs) in the specified compartment.
1989
- #
1990
- # @param [String] compartment_id The OCID of the compartment.
1991
- # @param [Hash] opts the optional parameters
1992
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
1993
- #
1994
- # Example: `500`
1995
- #
1996
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
1997
- #
1998
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::Cpe>
1999
- def list_cpes(compartment_id, opts = {})
2000
- logger.debug "Calling operation VirtualNetworkClient#list_cpes." if logger
2001
-
2002
- fail "Missing the required parameter 'compartment_id' when calling list_cpes." if compartment_id.nil?
2003
-
2004
- path = "/cpes"
2005
-
2006
- # Query Params
2007
- query_params = {}
2008
- query_params[:'compartmentId'] = compartment_id
2009
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2010
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2011
-
2012
- # Header Params
2013
- header_params = {}
2014
- header_params['accept'] = 'application/json'
2015
- header_params['content-type'] = 'application/json'
2016
-
2017
- post_body = nil
2018
-
2019
- return @api_client.call_api(
2020
- :GET,
2021
- path,
2022
- endpoint,
2023
- :header_params => header_params,
2024
- :query_params => query_params,
2025
- :body => post_body,
2026
- :return_type => 'Array<OracleBMC::Core::Models::Cpe>')
2027
- end
2028
-
2029
- # Lists the cross-connect groups in the specified compartment.
2030
- #
2031
- # @param [String] compartment_id The OCID of the compartment.
2032
- # @param [Hash] opts the optional parameters
2033
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2034
- #
2035
- # Example: `500`
2036
- #
2037
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2038
- #
2039
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::CrossConnectGroup>
2040
- def list_cross_connect_groups(compartment_id, opts = {})
2041
- logger.debug "Calling operation VirtualNetworkClient#list_cross_connect_groups." if logger
2042
-
2043
- fail "Missing the required parameter 'compartment_id' when calling list_cross_connect_groups." if compartment_id.nil?
2044
-
2045
- path = "/crossConnectGroups"
2046
-
2047
- # Query Params
2048
- query_params = {}
2049
- query_params[:'compartmentId'] = compartment_id
2050
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2051
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2052
-
2053
- # Header Params
2054
- header_params = {}
2055
- header_params['accept'] = 'application/json'
2056
- header_params['content-type'] = 'application/json'
2057
-
2058
- post_body = nil
2059
-
2060
- return @api_client.call_api(
2061
- :GET,
2062
- path,
2063
- endpoint,
2064
- :header_params => header_params,
2065
- :query_params => query_params,
2066
- :body => post_body,
2067
- :return_type => 'Array<OracleBMC::Core::Models::CrossConnectGroup>')
2068
- end
2069
-
2070
- # Lists the available FastConnect locations for cross-connect installation. You need
2071
- # this information so you can specify your desired location when you create a cross-connect.
2072
- #
2073
- # @param [String] compartment_id The OCID of the compartment.
2074
- # @param [Hash] opts the optional parameters
2075
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2076
- #
2077
- # Example: `500`
2078
- #
2079
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2080
- #
2081
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::CrossConnectLocation>
2082
- def list_cross_connect_locations(compartment_id, opts = {})
2083
- logger.debug "Calling operation VirtualNetworkClient#list_cross_connect_locations." if logger
2084
-
2085
- fail "Missing the required parameter 'compartment_id' when calling list_cross_connect_locations." if compartment_id.nil?
2086
-
2087
- path = "/crossConnectLocations"
2088
-
2089
- # Query Params
2090
- query_params = {}
2091
- query_params[:'compartmentId'] = compartment_id
2092
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2093
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2094
-
2095
- # Header Params
2096
- header_params = {}
2097
- header_params['accept'] = 'application/json'
2098
- header_params['content-type'] = 'application/json'
2099
-
2100
- post_body = nil
2101
-
2102
- return @api_client.call_api(
2103
- :GET,
2104
- path,
2105
- endpoint,
2106
- :header_params => header_params,
2107
- :query_params => query_params,
2108
- :body => post_body,
2109
- :return_type => 'Array<OracleBMC::Core::Models::CrossConnectLocation>')
2110
- end
2111
-
2112
- # Lists the cross-connects in the specified compartment. You can filter the list
2113
- # by specifying the OCID of a cross-connect group.
2114
- #
2115
- # @param [String] compartment_id The OCID of the compartment.
2116
- # @param [Hash] opts the optional parameters
2117
- # @option opts [String] :cross_connect_group_id The OCID of the cross-connect group.
2118
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2119
- #
2120
- # Example: `500`
2121
- #
2122
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2123
- #
2124
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::CrossConnect>
2125
- def list_cross_connects(compartment_id, opts = {})
2126
- logger.debug "Calling operation VirtualNetworkClient#list_cross_connects." if logger
2127
-
2128
- fail "Missing the required parameter 'compartment_id' when calling list_cross_connects." if compartment_id.nil?
2129
-
2130
- path = "/crossConnects"
2131
-
2132
- # Query Params
2133
- query_params = {}
2134
- query_params[:'compartmentId'] = compartment_id
2135
- query_params[:'crossConnectGroupId'] = opts[:'cross_connect_group_id'] if opts[:'cross_connect_group_id']
2136
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2137
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2138
-
2139
- # Header Params
2140
- header_params = {}
2141
- header_params['accept'] = 'application/json'
2142
- header_params['content-type'] = 'application/json'
2143
-
2144
- post_body = nil
2145
-
2146
- return @api_client.call_api(
2147
- :GET,
2148
- path,
2149
- endpoint,
2150
- :header_params => header_params,
2151
- :query_params => query_params,
2152
- :body => post_body,
2153
- :return_type => 'Array<OracleBMC::Core::Models::CrossConnect>')
2154
- end
2155
-
2156
- # Lists the available port speeds for cross-connects. You need this information
2157
- # so you can specify your desired port speed (i.e., shape) when you create a
2158
- # cross-connect.
2159
- #
2160
- # @param [String] compartment_id The OCID of the compartment.
2161
- # @param [Hash] opts the optional parameters
2162
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2163
- #
2164
- # Example: `500`
2165
- #
2166
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2167
- #
2168
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::CrossConnectPortSpeedShape>
2169
- def list_crossconnect_port_speed_shapes(compartment_id, opts = {})
2170
- logger.debug "Calling operation VirtualNetworkClient#list_crossconnect_port_speed_shapes." if logger
2171
-
2172
- fail "Missing the required parameter 'compartment_id' when calling list_crossconnect_port_speed_shapes." if compartment_id.nil?
2173
-
2174
- path = "/crossConnectPortSpeedShapes"
2175
-
2176
- # Query Params
2177
- query_params = {}
2178
- query_params[:'compartmentId'] = compartment_id
2179
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2180
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2181
-
2182
- # Header Params
2183
- header_params = {}
2184
- header_params['accept'] = 'application/json'
2185
- header_params['content-type'] = 'application/json'
2186
-
2187
- post_body = nil
2188
-
2189
- return @api_client.call_api(
2190
- :GET,
2191
- path,
2192
- endpoint,
2193
- :header_params => header_params,
2194
- :query_params => query_params,
2195
- :body => post_body,
2196
- :return_type => 'Array<OracleBMC::Core::Models::CrossConnectPortSpeedShape>')
2197
- end
2198
-
2199
- # Lists the sets of DHCP options in the specified VCN and specified compartment.
2200
- # The response includes the default set of options that automatically comes with each VCN,
2201
- # plus any other sets you've created.
2202
- #
2203
- # @param [String] compartment_id The OCID of the compartment.
2204
- # @param [String] vcn_id The OCID of the VCN.
2205
- # @param [Hash] opts the optional parameters
2206
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2207
- #
2208
- # Example: `500`
2209
- #
2210
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2211
- #
2212
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::DhcpOptions>
2213
- def list_dhcp_options(compartment_id, vcn_id, opts = {})
2214
- logger.debug "Calling operation VirtualNetworkClient#list_dhcp_options." if logger
2215
-
2216
- fail "Missing the required parameter 'compartment_id' when calling list_dhcp_options." if compartment_id.nil?
2217
- fail "Missing the required parameter 'vcn_id' when calling list_dhcp_options." if vcn_id.nil?
2218
-
2219
- path = "/dhcps"
2220
-
2221
- # Query Params
2222
- query_params = {}
2223
- query_params[:'compartmentId'] = compartment_id
2224
- query_params[:'vcnId'] = vcn_id
2225
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2226
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2227
-
2228
- # Header Params
2229
- header_params = {}
2230
- header_params['accept'] = 'application/json'
2231
- header_params['content-type'] = 'application/json'
2232
-
2233
- post_body = nil
2234
-
2235
- return @api_client.call_api(
2236
- :GET,
2237
- path,
2238
- endpoint,
2239
- :header_params => header_params,
2240
- :query_params => query_params,
2241
- :body => post_body,
2242
- :return_type => 'Array<OracleBMC::Core::Models::DhcpOptions>')
2243
- end
2244
-
2245
- # Lists the `DrgAttachment` objects for the specified compartment. You can filter the
2246
- # results by VCN or DRG.
2247
- #
2248
- # @param [String] compartment_id The OCID of the compartment.
2249
- # @param [Hash] opts the optional parameters
2250
- # @option opts [String] :vcn_id The OCID of the VCN.
2251
- # @option opts [String] :drg_id The OCID of the DRG.
2252
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2253
- #
2254
- # Example: `500`
2255
- #
2256
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2257
- #
2258
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::DrgAttachment>
2259
- def list_drg_attachments(compartment_id, opts = {})
2260
- logger.debug "Calling operation VirtualNetworkClient#list_drg_attachments." if logger
2261
-
2262
- fail "Missing the required parameter 'compartment_id' when calling list_drg_attachments." if compartment_id.nil?
2263
-
2264
- path = "/drgAttachments"
2265
-
2266
- # Query Params
2267
- query_params = {}
2268
- query_params[:'compartmentId'] = compartment_id
2269
- query_params[:'vcnId'] = opts[:'vcn_id'] if opts[:'vcn_id']
2270
- query_params[:'drgId'] = opts[:'drg_id'] if opts[:'drg_id']
2271
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2272
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2273
-
2274
- # Header Params
2275
- header_params = {}
2276
- header_params['accept'] = 'application/json'
2277
- header_params['content-type'] = 'application/json'
2278
-
2279
- post_body = nil
2280
-
2281
- return @api_client.call_api(
2282
- :GET,
2283
- path,
2284
- endpoint,
2285
- :header_params => header_params,
2286
- :query_params => query_params,
2287
- :body => post_body,
2288
- :return_type => 'Array<OracleBMC::Core::Models::DrgAttachment>')
2289
- end
2290
-
2291
- # Lists the DRGs in the specified compartment.
2292
- #
2293
- # @param [String] compartment_id The OCID of the compartment.
2294
- # @param [Hash] opts the optional parameters
2295
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2296
- #
2297
- # Example: `500`
2298
- #
2299
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2300
- #
2301
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::Drg>
2302
- def list_drgs(compartment_id, opts = {})
2303
- logger.debug "Calling operation VirtualNetworkClient#list_drgs." if logger
2304
-
2305
- fail "Missing the required parameter 'compartment_id' when calling list_drgs." if compartment_id.nil?
2306
-
2307
- path = "/drgs"
2308
-
2309
- # Query Params
2310
- query_params = {}
2311
- query_params[:'compartmentId'] = compartment_id
2312
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2313
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2314
-
2315
- # Header Params
2316
- header_params = {}
2317
- header_params['accept'] = 'application/json'
2318
- header_params['content-type'] = 'application/json'
2319
-
2320
- post_body = nil
2321
-
2322
- return @api_client.call_api(
2323
- :GET,
2324
- path,
2325
- endpoint,
2326
- :header_params => header_params,
2327
- :query_params => query_params,
2328
- :body => post_body,
2329
- :return_type => 'Array<OracleBMC::Core::Models::Drg>')
2330
- end
2331
-
2332
- # Lists the service offerings from supported providers. You need this
2333
- # information so you can specify your desired provider and service
2334
- # offering when you create a virtual circuit.
2335
- #
2336
- # For the compartment ID, provide the OCID of your tenancy (the root compartment).
2337
- #
2338
- # For more information, see [FastConnect Overview](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).
2339
- #
2340
- # @param [String] compartment_id The OCID of the compartment.
2341
- # @param [Hash] opts the optional parameters
2342
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2343
- #
2344
- # Example: `500`
2345
- #
2346
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2347
- #
2348
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::FastConnectProviderService>
2349
- def list_fast_connect_provider_services(compartment_id, opts = {})
2350
- logger.debug "Calling operation VirtualNetworkClient#list_fast_connect_provider_services." if logger
2351
-
2352
- fail "Missing the required parameter 'compartment_id' when calling list_fast_connect_provider_services." if compartment_id.nil?
2353
-
2354
- path = "/fastConnectProviderServices"
2355
-
2356
- # Query Params
2357
- query_params = {}
2358
- query_params[:'compartmentId'] = compartment_id
2359
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2360
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2361
-
2362
- # Header Params
2363
- header_params = {}
2364
- header_params['accept'] = 'application/json'
2365
- header_params['content-type'] = 'application/json'
2366
-
2367
- post_body = nil
2368
-
2369
- return @api_client.call_api(
2370
- :GET,
2371
- path,
2372
- endpoint,
2373
- :header_params => header_params,
2374
- :query_params => query_params,
2375
- :body => post_body,
2376
- :return_type => 'Array<OracleBMC::Core::Models::FastConnectProviderService>')
2377
- end
2378
-
2379
- # Lists the Internet Gateways in the specified VCN and the specified compartment.
2380
- #
2381
- # @param [String] compartment_id The OCID of the compartment.
2382
- # @param [String] vcn_id The OCID of the VCN.
2383
- # @param [Hash] opts the optional parameters
2384
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2385
- #
2386
- # Example: `500`
2387
- #
2388
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2389
- #
2390
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::InternetGateway>
2391
- def list_internet_gateways(compartment_id, vcn_id, opts = {})
2392
- logger.debug "Calling operation VirtualNetworkClient#list_internet_gateways." if logger
2393
-
2394
- fail "Missing the required parameter 'compartment_id' when calling list_internet_gateways." if compartment_id.nil?
2395
- fail "Missing the required parameter 'vcn_id' when calling list_internet_gateways." if vcn_id.nil?
2396
-
2397
- path = "/internetGateways"
2398
-
2399
- # Query Params
2400
- query_params = {}
2401
- query_params[:'compartmentId'] = compartment_id
2402
- query_params[:'vcnId'] = vcn_id
2403
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2404
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2405
-
2406
- # Header Params
2407
- header_params = {}
2408
- header_params['accept'] = 'application/json'
2409
- header_params['content-type'] = 'application/json'
2410
-
2411
- post_body = nil
2412
-
2413
- return @api_client.call_api(
2414
- :GET,
2415
- path,
2416
- endpoint,
2417
- :header_params => header_params,
2418
- :query_params => query_params,
2419
- :body => post_body,
2420
- :return_type => 'Array<OracleBMC::Core::Models::InternetGateway>')
2421
- end
2422
-
2423
- # Lists the IPSec connections for the specified compartment. You can filter the
2424
- # results by DRG or CPE.
2425
- #
2426
- # @param [String] compartment_id The OCID of the compartment.
2427
- # @param [Hash] opts the optional parameters
2428
- # @option opts [String] :drg_id The OCID of the DRG.
2429
- # @option opts [String] :cpe_id The OCID of the CPE.
2430
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2431
- #
2432
- # Example: `500`
2433
- #
2434
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2435
- #
2436
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::IPSecConnection>
2437
- def list_ip_sec_connections(compartment_id, opts = {})
2438
- logger.debug "Calling operation VirtualNetworkClient#list_ip_sec_connections." if logger
2439
-
2440
- fail "Missing the required parameter 'compartment_id' when calling list_ip_sec_connections." if compartment_id.nil?
2441
-
2442
- path = "/ipsecConnections"
2443
-
2444
- # Query Params
2445
- query_params = {}
2446
- query_params[:'compartmentId'] = compartment_id
2447
- query_params[:'drgId'] = opts[:'drg_id'] if opts[:'drg_id']
2448
- query_params[:'cpeId'] = opts[:'cpe_id'] if opts[:'cpe_id']
2449
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2450
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2451
-
2452
- # Header Params
2453
- header_params = {}
2454
- header_params['accept'] = 'application/json'
2455
- header_params['content-type'] = 'application/json'
2456
-
2457
- post_body = nil
2458
-
2459
- return @api_client.call_api(
2460
- :GET,
2461
- path,
2462
- endpoint,
2463
- :header_params => header_params,
2464
- :query_params => query_params,
2465
- :body => post_body,
2466
- :return_type => 'Array<OracleBMC::Core::Models::IPSecConnection>')
2467
- end
2468
-
2469
- # Lists the {PrivateIp} objects based
2470
- # on one of these filters:
2471
- #
2472
- # - Subnet OCID.
2473
- # - VNIC OCID.
2474
- # - Both private IP address and subnet OCID: This lets
2475
- # you get a `privateIP` object based on its private IP
2476
- # address (for example, 10.0.3.3) and not its OCID. For comparison,
2477
- # {#get_private_ip get_private_ip}
2478
- # requires the OCID.
2479
- #
2480
- # If you're listing all the private IPs associated with a given subnet
2481
- # or VNIC, the response includes both primary and secondary private IPs.
2482
- #
2483
- # @param [Hash] opts the optional parameters
2484
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2485
- #
2486
- # Example: `500`
2487
- #
2488
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2489
- #
2490
- # @option opts [String] :ip_address The private IP address of the `privateIp` object.
2491
- #
2492
- # Example: `10.0.3.3`
2493
- #
2494
- # @option opts [String] :subnet_id The OCID of the subnet.
2495
- # @option opts [String] :vnic_id The OCID of the VNIC.
2496
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::PrivateIp>
2497
- def list_private_ips(opts = {})
2498
- logger.debug "Calling operation VirtualNetworkClient#list_private_ips." if logger
2499
-
2500
-
2501
- path = "/privateIps"
2502
-
2503
- # Query Params
2504
- query_params = {}
2505
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2506
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2507
- query_params[:'ipAddress'] = opts[:'ip_address'] if opts[:'ip_address']
2508
- query_params[:'subnetId'] = opts[:'subnet_id'] if opts[:'subnet_id']
2509
- query_params[:'vnicId'] = opts[:'vnic_id'] if opts[:'vnic_id']
2510
-
2511
- # Header Params
2512
- header_params = {}
2513
- header_params['accept'] = 'application/json'
2514
- header_params['content-type'] = 'application/json'
2515
-
2516
- post_body = nil
2517
-
2518
- return @api_client.call_api(
2519
- :GET,
2520
- path,
2521
- endpoint,
2522
- :header_params => header_params,
2523
- :query_params => query_params,
2524
- :body => post_body,
2525
- :return_type => 'Array<OracleBMC::Core::Models::PrivateIp>')
2526
- end
2527
-
2528
- # Lists the route tables in the specified VCN and specified compartment. The response
2529
- # includes the default route table that automatically comes with each VCN, plus any route tables
2530
- # you've created.
2531
- #
2532
- # @param [String] compartment_id The OCID of the compartment.
2533
- # @param [String] vcn_id The OCID of the VCN.
2534
- # @param [Hash] opts the optional parameters
2535
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2536
- #
2537
- # Example: `500`
2538
- #
2539
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2540
- #
2541
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::RouteTable>
2542
- def list_route_tables(compartment_id, vcn_id, opts = {})
2543
- logger.debug "Calling operation VirtualNetworkClient#list_route_tables." if logger
2544
-
2545
- fail "Missing the required parameter 'compartment_id' when calling list_route_tables." if compartment_id.nil?
2546
- fail "Missing the required parameter 'vcn_id' when calling list_route_tables." if vcn_id.nil?
2547
-
2548
- path = "/routeTables"
2549
-
2550
- # Query Params
2551
- query_params = {}
2552
- query_params[:'compartmentId'] = compartment_id
2553
- query_params[:'vcnId'] = vcn_id
2554
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2555
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2556
-
2557
- # Header Params
2558
- header_params = {}
2559
- header_params['accept'] = 'application/json'
2560
- header_params['content-type'] = 'application/json'
2561
-
2562
- post_body = nil
2563
-
2564
- return @api_client.call_api(
2565
- :GET,
2566
- path,
2567
- endpoint,
2568
- :header_params => header_params,
2569
- :query_params => query_params,
2570
- :body => post_body,
2571
- :return_type => 'Array<OracleBMC::Core::Models::RouteTable>')
2572
- end
2573
-
2574
- # Lists the security lists in the specified VCN and compartment.
2575
- #
2576
- # @param [String] compartment_id The OCID of the compartment.
2577
- # @param [String] vcn_id The OCID of the VCN.
2578
- # @param [Hash] opts the optional parameters
2579
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2580
- #
2581
- # Example: `500`
2582
- #
2583
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2584
- #
2585
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::SecurityList>
2586
- def list_security_lists(compartment_id, vcn_id, opts = {})
2587
- logger.debug "Calling operation VirtualNetworkClient#list_security_lists." if logger
2588
-
2589
- fail "Missing the required parameter 'compartment_id' when calling list_security_lists." if compartment_id.nil?
2590
- fail "Missing the required parameter 'vcn_id' when calling list_security_lists." if vcn_id.nil?
2591
-
2592
- path = "/securityLists"
2593
-
2594
- # Query Params
2595
- query_params = {}
2596
- query_params[:'compartmentId'] = compartment_id
2597
- query_params[:'vcnId'] = vcn_id
2598
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2599
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2600
-
2601
- # Header Params
2602
- header_params = {}
2603
- header_params['accept'] = 'application/json'
2604
- header_params['content-type'] = 'application/json'
2605
-
2606
- post_body = nil
2607
-
2608
- return @api_client.call_api(
2609
- :GET,
2610
- path,
2611
- endpoint,
2612
- :header_params => header_params,
2613
- :query_params => query_params,
2614
- :body => post_body,
2615
- :return_type => 'Array<OracleBMC::Core::Models::SecurityList>')
2616
- end
2617
-
2618
- # Lists the subnets in the specified VCN and the specified compartment.
2619
- #
2620
- # @param [String] compartment_id The OCID of the compartment.
2621
- # @param [String] vcn_id The OCID of the VCN.
2622
- # @param [Hash] opts the optional parameters
2623
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2624
- #
2625
- # Example: `500`
2626
- #
2627
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2628
- #
2629
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::Subnet>
2630
- def list_subnets(compartment_id, vcn_id, opts = {})
2631
- logger.debug "Calling operation VirtualNetworkClient#list_subnets." if logger
2632
-
2633
- fail "Missing the required parameter 'compartment_id' when calling list_subnets." if compartment_id.nil?
2634
- fail "Missing the required parameter 'vcn_id' when calling list_subnets." if vcn_id.nil?
2635
-
2636
- path = "/subnets"
2637
-
2638
- # Query Params
2639
- query_params = {}
2640
- query_params[:'compartmentId'] = compartment_id
2641
- query_params[:'vcnId'] = vcn_id
2642
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2643
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2644
-
2645
- # Header Params
2646
- header_params = {}
2647
- header_params['accept'] = 'application/json'
2648
- header_params['content-type'] = 'application/json'
2649
-
2650
- post_body = nil
2651
-
2652
- return @api_client.call_api(
2653
- :GET,
2654
- path,
2655
- endpoint,
2656
- :header_params => header_params,
2657
- :query_params => query_params,
2658
- :body => post_body,
2659
- :return_type => 'Array<OracleBMC::Core::Models::Subnet>')
2660
- end
2661
-
2662
- # Lists the Virtual Cloud Networks (VCNs) in the specified compartment.
2663
- #
2664
- # @param [String] compartment_id The OCID of the compartment.
2665
- # @param [Hash] opts the optional parameters
2666
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2667
- #
2668
- # Example: `500`
2669
- #
2670
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2671
- #
2672
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::Vcn>
2673
- def list_vcns(compartment_id, opts = {})
2674
- logger.debug "Calling operation VirtualNetworkClient#list_vcns." if logger
2675
-
2676
- fail "Missing the required parameter 'compartment_id' when calling list_vcns." if compartment_id.nil?
2677
-
2678
- path = "/vcns"
2679
-
2680
- # Query Params
2681
- query_params = {}
2682
- query_params[:'compartmentId'] = compartment_id
2683
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2684
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2685
-
2686
- # Header Params
2687
- header_params = {}
2688
- header_params['accept'] = 'application/json'
2689
- header_params['content-type'] = 'application/json'
2690
-
2691
- post_body = nil
2692
-
2693
- return @api_client.call_api(
2694
- :GET,
2695
- path,
2696
- endpoint,
2697
- :header_params => header_params,
2698
- :query_params => query_params,
2699
- :body => post_body,
2700
- :return_type => 'Array<OracleBMC::Core::Models::Vcn>')
2701
- end
2702
-
2703
- # Lists the available bandwidth levels for virtual circuits. You need this
2704
- # information so you can specify your desired bandwidth level (i.e., shape)
2705
- # when you create a virtual circuit.
2706
- #
2707
- # For the compartment ID, provide the OCID of your tenancy (the root compartment).
2708
- #
2709
- # For more information about virtual circuits, see
2710
- # [FastConnect Overview](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).
2711
- #
2712
- # @param [String] compartment_id The OCID of the compartment.
2713
- # @param [Hash] opts the optional parameters
2714
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2715
- #
2716
- # Example: `500`
2717
- #
2718
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2719
- #
2720
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::VirtualCircuitBandwidthShape>
2721
- def list_virtual_circuit_bandwidth_shapes(compartment_id, opts = {})
2722
- logger.debug "Calling operation VirtualNetworkClient#list_virtual_circuit_bandwidth_shapes." if logger
2723
-
2724
- fail "Missing the required parameter 'compartment_id' when calling list_virtual_circuit_bandwidth_shapes." if compartment_id.nil?
2725
-
2726
- path = "/virtualCircuitBandwidthShapes"
2727
-
2728
- # Query Params
2729
- query_params = {}
2730
- query_params[:'compartmentId'] = compartment_id
2731
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2732
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2733
-
2734
- # Header Params
2735
- header_params = {}
2736
- header_params['accept'] = 'application/json'
2737
- header_params['content-type'] = 'application/json'
2738
-
2739
- post_body = nil
2740
-
2741
- return @api_client.call_api(
2742
- :GET,
2743
- path,
2744
- endpoint,
2745
- :header_params => header_params,
2746
- :query_params => query_params,
2747
- :body => post_body,
2748
- :return_type => 'Array<OracleBMC::Core::Models::VirtualCircuitBandwidthShape>')
2749
- end
2750
-
2751
- # Lists the virtual circuits in the specified compartment.
2752
- #
2753
- # @param [String] compartment_id The OCID of the compartment.
2754
- # @param [Hash] opts the optional parameters
2755
- # @option opts [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
2756
- #
2757
- # Example: `500`
2758
- #
2759
- # @option opts [String] :page The value of the `opc-next-page` response header from the previous \"List\" call.
2760
- #
2761
- # @return [Response] A Response object with data of type Array<OracleBMC::Core::Models::VirtualCircuit>
2762
- def list_virtual_circuits(compartment_id, opts = {})
2763
- logger.debug "Calling operation VirtualNetworkClient#list_virtual_circuits." if logger
2764
-
2765
- fail "Missing the required parameter 'compartment_id' when calling list_virtual_circuits." if compartment_id.nil?
2766
-
2767
- path = "/virtualCircuits"
2768
-
2769
- # Query Params
2770
- query_params = {}
2771
- query_params[:'compartmentId'] = compartment_id
2772
- query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
2773
- query_params[:'page'] = opts[:'page'] if opts[:'page']
2774
-
2775
- # Header Params
2776
- header_params = {}
2777
- header_params['accept'] = 'application/json'
2778
- header_params['content-type'] = 'application/json'
2779
-
2780
- post_body = nil
2781
-
2782
- return @api_client.call_api(
2783
- :GET,
2784
- path,
2785
- endpoint,
2786
- :header_params => header_params,
2787
- :query_params => query_params,
2788
- :body => post_body,
2789
- :return_type => 'Array<OracleBMC::Core::Models::VirtualCircuit>')
2790
- end
2791
-
2792
- # Updates the specified CPE's display name.
2793
- # Avoid entering confidential information.
2794
- #
2795
- # @param [String] cpe_id The OCID of the CPE.
2796
- # @param [UpdateCpeDetails] update_cpe_details Details object for updating a CPE.
2797
- # @param [Hash] opts the optional parameters
2798
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
2799
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
2800
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
2801
- #
2802
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Cpe
2803
- def update_cpe(cpe_id, update_cpe_details, opts = {})
2804
- logger.debug "Calling operation VirtualNetworkClient#update_cpe." if logger
2805
-
2806
- fail "Missing the required parameter 'cpe_id' when calling update_cpe." if cpe_id.nil?
2807
- fail "Missing the required parameter 'update_cpe_details' when calling update_cpe." if update_cpe_details.nil?
2808
-
2809
- path = "/cpes/{cpeId}".sub('{cpeId}', cpe_id.to_s)
2810
-
2811
- # Query Params
2812
- query_params = {}
2813
-
2814
- # Header Params
2815
- header_params = {}
2816
- header_params['accept'] = 'application/json'
2817
- header_params['content-type'] = 'application/json'
2818
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
2819
-
2820
- post_body = @api_client.object_to_http_body(update_cpe_details)
2821
-
2822
- return @api_client.call_api(
2823
- :PUT,
2824
- path,
2825
- endpoint,
2826
- :header_params => header_params,
2827
- :query_params => query_params,
2828
- :body => post_body,
2829
- :return_type => 'OracleBMC::Core::Models::Cpe')
2830
- end
2831
-
2832
- # Updates the specified cross-connect.
2833
- # @param [String] cross_connect_id The OCID of the cross-connect.
2834
- # @param [UpdateCrossConnectDetails] update_cross_connect_details Update CrossConnect fields.
2835
- # @param [Hash] opts the optional parameters
2836
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
2837
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
2838
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
2839
- #
2840
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::CrossConnect
2841
- def update_cross_connect(cross_connect_id, update_cross_connect_details, opts = {})
2842
- logger.debug "Calling operation VirtualNetworkClient#update_cross_connect." if logger
2843
-
2844
- fail "Missing the required parameter 'cross_connect_id' when calling update_cross_connect." if cross_connect_id.nil?
2845
- fail "Missing the required parameter 'update_cross_connect_details' when calling update_cross_connect." if update_cross_connect_details.nil?
2846
-
2847
- path = "/crossConnects/{crossConnectId}".sub('{crossConnectId}', cross_connect_id.to_s)
2848
-
2849
- # Query Params
2850
- query_params = {}
2851
-
2852
- # Header Params
2853
- header_params = {}
2854
- header_params['accept'] = 'application/json'
2855
- header_params['content-type'] = 'application/json'
2856
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
2857
-
2858
- post_body = @api_client.object_to_http_body(update_cross_connect_details)
2859
-
2860
- return @api_client.call_api(
2861
- :PUT,
2862
- path,
2863
- endpoint,
2864
- :header_params => header_params,
2865
- :query_params => query_params,
2866
- :body => post_body,
2867
- :return_type => 'OracleBMC::Core::Models::CrossConnect')
2868
- end
2869
-
2870
- # Updates the specified cross-connect group's display name.
2871
- # Avoid entering confidential information.
2872
- #
2873
- # @param [String] cross_connect_group_id The OCID of the cross-connect group.
2874
- # @param [UpdateCrossConnectGroupDetails] update_cross_connect_group_details Update CrossConnectGroup fields
2875
- # @param [Hash] opts the optional parameters
2876
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
2877
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
2878
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
2879
- #
2880
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::CrossConnectGroup
2881
- def update_cross_connect_group(cross_connect_group_id, update_cross_connect_group_details, opts = {})
2882
- logger.debug "Calling operation VirtualNetworkClient#update_cross_connect_group." if logger
2883
-
2884
- fail "Missing the required parameter 'cross_connect_group_id' when calling update_cross_connect_group." if cross_connect_group_id.nil?
2885
- fail "Missing the required parameter 'update_cross_connect_group_details' when calling update_cross_connect_group." if update_cross_connect_group_details.nil?
2886
-
2887
- path = "/crossConnectGroups/{crossConnectGroupId}".sub('{crossConnectGroupId}', cross_connect_group_id.to_s)
2888
-
2889
- # Query Params
2890
- query_params = {}
2891
-
2892
- # Header Params
2893
- header_params = {}
2894
- header_params['accept'] = 'application/json'
2895
- header_params['content-type'] = 'application/json'
2896
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
2897
-
2898
- post_body = @api_client.object_to_http_body(update_cross_connect_group_details)
2899
-
2900
- return @api_client.call_api(
2901
- :PUT,
2902
- path,
2903
- endpoint,
2904
- :header_params => header_params,
2905
- :query_params => query_params,
2906
- :body => post_body,
2907
- :return_type => 'OracleBMC::Core::Models::CrossConnectGroup')
2908
- end
2909
-
2910
- # Updates the specified set of DHCP options. You can update the display name or the options
2911
- # themselves. Avoid entering confidential information.
2912
- #
2913
- # Note that the `options` object you provide replaces the entire existing set of options.
2914
- #
2915
- # @param [String] dhcp_id The OCID for the set of DHCP options.
2916
- # @param [UpdateDhcpDetails] update_dhcp_details Request object for updating a set of DHCP options.
2917
- # @param [Hash] opts the optional parameters
2918
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
2919
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
2920
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
2921
- #
2922
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::DhcpOptions
2923
- def update_dhcp_options(dhcp_id, update_dhcp_details, opts = {})
2924
- logger.debug "Calling operation VirtualNetworkClient#update_dhcp_options." if logger
2925
-
2926
- fail "Missing the required parameter 'dhcp_id' when calling update_dhcp_options." if dhcp_id.nil?
2927
- fail "Missing the required parameter 'update_dhcp_details' when calling update_dhcp_options." if update_dhcp_details.nil?
2928
-
2929
- path = "/dhcps/{dhcpId}".sub('{dhcpId}', dhcp_id.to_s)
2930
-
2931
- # Query Params
2932
- query_params = {}
2933
-
2934
- # Header Params
2935
- header_params = {}
2936
- header_params['accept'] = 'application/json'
2937
- header_params['content-type'] = 'application/json'
2938
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
2939
-
2940
- post_body = @api_client.object_to_http_body(update_dhcp_details)
2941
-
2942
- return @api_client.call_api(
2943
- :PUT,
2944
- path,
2945
- endpoint,
2946
- :header_params => header_params,
2947
- :query_params => query_params,
2948
- :body => post_body,
2949
- :return_type => 'OracleBMC::Core::Models::DhcpOptions')
2950
- end
2951
-
2952
- # Updates the specified DRG's display name. Avoid entering confidential information.
2953
- #
2954
- # @param [String] drg_id The OCID of the DRG.
2955
- # @param [UpdateDrgDetails] update_drg_details Details object for updating a DRG.
2956
- # @param [Hash] opts the optional parameters
2957
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
2958
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
2959
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
2960
- #
2961
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Drg
2962
- def update_drg(drg_id, update_drg_details, opts = {})
2963
- logger.debug "Calling operation VirtualNetworkClient#update_drg." if logger
2964
-
2965
- fail "Missing the required parameter 'drg_id' when calling update_drg." if drg_id.nil?
2966
- fail "Missing the required parameter 'update_drg_details' when calling update_drg." if update_drg_details.nil?
2967
-
2968
- path = "/drgs/{drgId}".sub('{drgId}', drg_id.to_s)
2969
-
2970
- # Query Params
2971
- query_params = {}
2972
-
2973
- # Header Params
2974
- header_params = {}
2975
- header_params['accept'] = 'application/json'
2976
- header_params['content-type'] = 'application/json'
2977
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
2978
-
2979
- post_body = @api_client.object_to_http_body(update_drg_details)
2980
-
2981
- return @api_client.call_api(
2982
- :PUT,
2983
- path,
2984
- endpoint,
2985
- :header_params => header_params,
2986
- :query_params => query_params,
2987
- :body => post_body,
2988
- :return_type => 'OracleBMC::Core::Models::Drg')
2989
- end
2990
-
2991
- # Updates the display name for the specified `DrgAttachment`.
2992
- # Avoid entering confidential information.
2993
- #
2994
- # @param [String] drg_attachment_id The OCID of the DRG attachment.
2995
- # @param [UpdateDrgAttachmentDetails] update_drg_attachment_details Details object for updating a `DrgAttachment`.
2996
- # @param [Hash] opts the optional parameters
2997
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
2998
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
2999
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
3000
- #
3001
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::DrgAttachment
3002
- def update_drg_attachment(drg_attachment_id, update_drg_attachment_details, opts = {})
3003
- logger.debug "Calling operation VirtualNetworkClient#update_drg_attachment." if logger
3004
-
3005
- fail "Missing the required parameter 'drg_attachment_id' when calling update_drg_attachment." if drg_attachment_id.nil?
3006
- fail "Missing the required parameter 'update_drg_attachment_details' when calling update_drg_attachment." if update_drg_attachment_details.nil?
3007
-
3008
- path = "/drgAttachments/{drgAttachmentId}".sub('{drgAttachmentId}', drg_attachment_id.to_s)
3009
-
3010
- # Query Params
3011
- query_params = {}
3012
-
3013
- # Header Params
3014
- header_params = {}
3015
- header_params['accept'] = 'application/json'
3016
- header_params['content-type'] = 'application/json'
3017
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
3018
-
3019
- post_body = @api_client.object_to_http_body(update_drg_attachment_details)
3020
-
3021
- return @api_client.call_api(
3022
- :PUT,
3023
- path,
3024
- endpoint,
3025
- :header_params => header_params,
3026
- :query_params => query_params,
3027
- :body => post_body,
3028
- :return_type => 'OracleBMC::Core::Models::DrgAttachment')
3029
- end
3030
-
3031
- # Updates the specified Internet Gateway. You can disable/enable it, or change its display name.
3032
- # Avoid entering confidential information.
3033
- #
3034
- # If the gateway is disabled, that means no traffic will flow to/from the internet even if there's
3035
- # a route rule that enables that traffic.
3036
- #
3037
- # @param [String] ig_id The OCID of the Internet Gateway.
3038
- # @param [UpdateInternetGatewayDetails] update_internet_gateway_details Details for updating the Internet Gateway.
3039
- # @param [Hash] opts the optional parameters
3040
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
3041
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
3042
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
3043
- #
3044
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::InternetGateway
3045
- def update_internet_gateway(ig_id, update_internet_gateway_details, opts = {})
3046
- logger.debug "Calling operation VirtualNetworkClient#update_internet_gateway." if logger
3047
-
3048
- fail "Missing the required parameter 'ig_id' when calling update_internet_gateway." if ig_id.nil?
3049
- fail "Missing the required parameter 'update_internet_gateway_details' when calling update_internet_gateway." if update_internet_gateway_details.nil?
3050
-
3051
- path = "/internetGateways/{igId}".sub('{igId}', ig_id.to_s)
3052
-
3053
- # Query Params
3054
- query_params = {}
3055
-
3056
- # Header Params
3057
- header_params = {}
3058
- header_params['accept'] = 'application/json'
3059
- header_params['content-type'] = 'application/json'
3060
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
3061
-
3062
- post_body = @api_client.object_to_http_body(update_internet_gateway_details)
3063
-
3064
- return @api_client.call_api(
3065
- :PUT,
3066
- path,
3067
- endpoint,
3068
- :header_params => header_params,
3069
- :query_params => query_params,
3070
- :body => post_body,
3071
- :return_type => 'OracleBMC::Core::Models::InternetGateway')
3072
- end
3073
-
3074
- # Updates the display name for the specified IPSec connection.
3075
- # Avoid entering confidential information.
3076
- #
3077
- # @param [String] ipsc_id The OCID of the IPSec connection.
3078
- # @param [UpdateIPSecConnectionDetails] update_ip_sec_connection_details Details object for updating a IPSec connection.
3079
- # @param [Hash] opts the optional parameters
3080
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
3081
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
3082
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
3083
- #
3084
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::IPSecConnection
3085
- def update_ip_sec_connection(ipsc_id, update_ip_sec_connection_details, opts = {})
3086
- logger.debug "Calling operation VirtualNetworkClient#update_ip_sec_connection." if logger
3087
-
3088
- fail "Missing the required parameter 'ipsc_id' when calling update_ip_sec_connection." if ipsc_id.nil?
3089
- fail "Missing the required parameter 'update_ip_sec_connection_details' when calling update_ip_sec_connection." if update_ip_sec_connection_details.nil?
3090
-
3091
- path = "/ipsecConnections/{ipscId}".sub('{ipscId}', ipsc_id.to_s)
3092
-
3093
- # Query Params
3094
- query_params = {}
3095
-
3096
- # Header Params
3097
- header_params = {}
3098
- header_params['accept'] = 'application/json'
3099
- header_params['content-type'] = 'application/json'
3100
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
3101
-
3102
- post_body = @api_client.object_to_http_body(update_ip_sec_connection_details)
3103
-
3104
- return @api_client.call_api(
3105
- :PUT,
3106
- path,
3107
- endpoint,
3108
- :header_params => header_params,
3109
- :query_params => query_params,
3110
- :body => post_body,
3111
- :return_type => 'OracleBMC::Core::Models::IPSecConnection')
3112
- end
3113
-
3114
- # Updates the specified private IP. You must specify the object's OCID.
3115
- # Use this operation if you want to:
3116
- #
3117
- # - Move a secondary private IP to a different VNIC in the same subnet.
3118
- # - Change the display name for a secondary private IP.
3119
- # - Change the hostname for a secondary private IP.
3120
- #
3121
- # This operation cannot be used with primary private IPs.
3122
- # To update the hostname for the primary IP on a VNIC, use
3123
- # {#update_vnic update_vnic}.
3124
- #
3125
- # @param [String] private_ip_id The private IP's OCID.
3126
- # @param [UpdatePrivateIpDetails] update_private_ip_details Private IP details.
3127
- # @param [Hash] opts the optional parameters
3128
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
3129
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
3130
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
3131
- #
3132
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::PrivateIp
3133
- def update_private_ip(private_ip_id, update_private_ip_details, opts = {})
3134
- logger.debug "Calling operation VirtualNetworkClient#update_private_ip." if logger
3135
-
3136
- fail "Missing the required parameter 'private_ip_id' when calling update_private_ip." if private_ip_id.nil?
3137
- fail "Missing the required parameter 'update_private_ip_details' when calling update_private_ip." if update_private_ip_details.nil?
3138
-
3139
- path = "/privateIps/{privateIpId}".sub('{privateIpId}', private_ip_id.to_s)
3140
-
3141
- # Query Params
3142
- query_params = {}
3143
-
3144
- # Header Params
3145
- header_params = {}
3146
- header_params['accept'] = 'application/json'
3147
- header_params['content-type'] = 'application/json'
3148
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
3149
-
3150
- post_body = @api_client.object_to_http_body(update_private_ip_details)
3151
-
3152
- return @api_client.call_api(
3153
- :PUT,
3154
- path,
3155
- endpoint,
3156
- :header_params => header_params,
3157
- :query_params => query_params,
3158
- :body => post_body,
3159
- :return_type => 'OracleBMC::Core::Models::PrivateIp')
3160
- end
3161
-
3162
- # Updates the specified route table's display name or route rules.
3163
- # Avoid entering confidential information.
3164
- #
3165
- # Note that the `routeRules` object you provide replaces the entire existing set of rules.
3166
- #
3167
- # @param [String] rt_id The OCID of the route table.
3168
- # @param [UpdateRouteTableDetails] update_route_table_details Details object for updating a route table.
3169
- # @param [Hash] opts the optional parameters
3170
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
3171
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
3172
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
3173
- #
3174
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::RouteTable
3175
- def update_route_table(rt_id, update_route_table_details, opts = {})
3176
- logger.debug "Calling operation VirtualNetworkClient#update_route_table." if logger
3177
-
3178
- fail "Missing the required parameter 'rt_id' when calling update_route_table." if rt_id.nil?
3179
- fail "Missing the required parameter 'update_route_table_details' when calling update_route_table." if update_route_table_details.nil?
3180
-
3181
- path = "/routeTables/{rtId}".sub('{rtId}', rt_id.to_s)
3182
-
3183
- # Query Params
3184
- query_params = {}
3185
-
3186
- # Header Params
3187
- header_params = {}
3188
- header_params['accept'] = 'application/json'
3189
- header_params['content-type'] = 'application/json'
3190
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
3191
-
3192
- post_body = @api_client.object_to_http_body(update_route_table_details)
3193
-
3194
- return @api_client.call_api(
3195
- :PUT,
3196
- path,
3197
- endpoint,
3198
- :header_params => header_params,
3199
- :query_params => query_params,
3200
- :body => post_body,
3201
- :return_type => 'OracleBMC::Core::Models::RouteTable')
3202
- end
3203
-
3204
- # Updates the specified security list's display name or rules.
3205
- # Avoid entering confidential information.
3206
- #
3207
- # Note that the `egressSecurityRules` or `ingressSecurityRules` objects you provide replace the entire
3208
- # existing objects.
3209
- #
3210
- # @param [String] security_list_id The OCID of the security list.
3211
- # @param [UpdateSecurityListDetails] update_security_list_details Updated details for the security list.
3212
- # @param [Hash] opts the optional parameters
3213
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
3214
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
3215
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
3216
- #
3217
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::SecurityList
3218
- def update_security_list(security_list_id, update_security_list_details, opts = {})
3219
- logger.debug "Calling operation VirtualNetworkClient#update_security_list." if logger
3220
-
3221
- fail "Missing the required parameter 'security_list_id' when calling update_security_list." if security_list_id.nil?
3222
- fail "Missing the required parameter 'update_security_list_details' when calling update_security_list." if update_security_list_details.nil?
3223
-
3224
- path = "/securityLists/{securityListId}".sub('{securityListId}', security_list_id.to_s)
3225
-
3226
- # Query Params
3227
- query_params = {}
3228
-
3229
- # Header Params
3230
- header_params = {}
3231
- header_params['accept'] = 'application/json'
3232
- header_params['content-type'] = 'application/json'
3233
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
3234
-
3235
- post_body = @api_client.object_to_http_body(update_security_list_details)
3236
-
3237
- return @api_client.call_api(
3238
- :PUT,
3239
- path,
3240
- endpoint,
3241
- :header_params => header_params,
3242
- :query_params => query_params,
3243
- :body => post_body,
3244
- :return_type => 'OracleBMC::Core::Models::SecurityList')
3245
- end
3246
-
3247
- # Updates the specified subnet's display name. Avoid entering confidential information.
3248
- #
3249
- # @param [String] subnet_id The OCID of the subnet.
3250
- # @param [UpdateSubnetDetails] update_subnet_details Details object for updating a subnet.
3251
- # @param [Hash] opts the optional parameters
3252
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
3253
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
3254
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
3255
- #
3256
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Subnet
3257
- def update_subnet(subnet_id, update_subnet_details, opts = {})
3258
- logger.debug "Calling operation VirtualNetworkClient#update_subnet." if logger
3259
-
3260
- fail "Missing the required parameter 'subnet_id' when calling update_subnet." if subnet_id.nil?
3261
- fail "Missing the required parameter 'update_subnet_details' when calling update_subnet." if update_subnet_details.nil?
3262
-
3263
- path = "/subnets/{subnetId}".sub('{subnetId}', subnet_id.to_s)
3264
-
3265
- # Query Params
3266
- query_params = {}
3267
-
3268
- # Header Params
3269
- header_params = {}
3270
- header_params['accept'] = 'application/json'
3271
- header_params['content-type'] = 'application/json'
3272
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
3273
-
3274
- post_body = @api_client.object_to_http_body(update_subnet_details)
3275
-
3276
- return @api_client.call_api(
3277
- :PUT,
3278
- path,
3279
- endpoint,
3280
- :header_params => header_params,
3281
- :query_params => query_params,
3282
- :body => post_body,
3283
- :return_type => 'OracleBMC::Core::Models::Subnet')
3284
- end
3285
-
3286
- # Updates the specified VCN's display name.
3287
- # Avoid entering confidential information.
3288
- #
3289
- # @param [String] vcn_id The OCID of the VCN.
3290
- # @param [UpdateVcnDetails] update_vcn_details Details object for updating a VCN.
3291
- # @param [Hash] opts the optional parameters
3292
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
3293
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
3294
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
3295
- #
3296
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Vcn
3297
- def update_vcn(vcn_id, update_vcn_details, opts = {})
3298
- logger.debug "Calling operation VirtualNetworkClient#update_vcn." if logger
3299
-
3300
- fail "Missing the required parameter 'vcn_id' when calling update_vcn." if vcn_id.nil?
3301
- fail "Missing the required parameter 'update_vcn_details' when calling update_vcn." if update_vcn_details.nil?
3302
-
3303
- path = "/vcns/{vcnId}".sub('{vcnId}', vcn_id.to_s)
3304
-
3305
- # Query Params
3306
- query_params = {}
3307
-
3308
- # Header Params
3309
- header_params = {}
3310
- header_params['accept'] = 'application/json'
3311
- header_params['content-type'] = 'application/json'
3312
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
3313
-
3314
- post_body = @api_client.object_to_http_body(update_vcn_details)
3315
-
3316
- return @api_client.call_api(
3317
- :PUT,
3318
- path,
3319
- endpoint,
3320
- :header_params => header_params,
3321
- :query_params => query_params,
3322
- :body => post_body,
3323
- :return_type => 'OracleBMC::Core::Models::Vcn')
3324
- end
3325
-
3326
- # Updates the specified virtual circuit. This can be called by
3327
- # either the customer who owns the virtual circuit, or the
3328
- # provider (when provisioning or de-provisioning the virtual
3329
- # circuit from their end). The documentation for
3330
- # {#update_virtual_circuit_details update_virtual_circuit_details}
3331
- # indicates who can update each property of the virtual circuit.
3332
- #
3333
- # **Important:** If the virtual circuit is working and in the
3334
- # PROVISIONED state, updating any of the network-related properties
3335
- # (such as the DRG being used, the BGP ASN, etc.) will cause the virtual
3336
- # circuit's state to switch to PROVISIONING and the related BGP
3337
- # session to go down. After Oracle re-provisions the virtual circuit,
3338
- # its state will return to PROVISIONED. Make sure you confirm that
3339
- # the associated BGP session is back up. For more information
3340
- # about the various states and how to test connectivity, see
3341
- # [FastConnect Overview](https://docs.us-phoenix-1.oraclecloud.com/Content/Network/Concepts/fastconnect.htm).
3342
- #
3343
- # @param [String] virtual_circuit_id The OCID of the virtual circuit.
3344
- # @param [UpdateVirtualCircuitDetails] update_virtual_circuit_details Update VirtualCircuit fields.
3345
- # @param [Hash] opts the optional parameters
3346
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
3347
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
3348
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
3349
- #
3350
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::VirtualCircuit
3351
- def update_virtual_circuit(virtual_circuit_id, update_virtual_circuit_details, opts = {})
3352
- logger.debug "Calling operation VirtualNetworkClient#update_virtual_circuit." if logger
3353
-
3354
- fail "Missing the required parameter 'virtual_circuit_id' when calling update_virtual_circuit." if virtual_circuit_id.nil?
3355
- fail "Missing the required parameter 'update_virtual_circuit_details' when calling update_virtual_circuit." if update_virtual_circuit_details.nil?
3356
-
3357
- path = "/virtualCircuits/{virtualCircuitId}".sub('{virtualCircuitId}', virtual_circuit_id.to_s)
3358
-
3359
- # Query Params
3360
- query_params = {}
3361
-
3362
- # Header Params
3363
- header_params = {}
3364
- header_params['accept'] = 'application/json'
3365
- header_params['content-type'] = 'application/json'
3366
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
3367
-
3368
- post_body = @api_client.object_to_http_body(update_virtual_circuit_details)
3369
-
3370
- return @api_client.call_api(
3371
- :PUT,
3372
- path,
3373
- endpoint,
3374
- :header_params => header_params,
3375
- :query_params => query_params,
3376
- :body => post_body,
3377
- :return_type => 'OracleBMC::Core::Models::VirtualCircuit')
3378
- end
3379
-
3380
- # Updates the specified VNIC.
3381
- #
3382
- # @param [String] vnic_id The OCID of the VNIC.
3383
- # @param [UpdateVnicDetails] update_vnic_details Details object for updating a VNIC.
3384
- # @param [Hash] opts the optional parameters
3385
- # @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`
3386
- # parameter to the value of the etag from a previous GET or POST response for that resource. The resource
3387
- # will be updated or deleted only if the etag you provide matches the resource's current etag value.
3388
- #
3389
- # @return [Response] A Response object with data of type OracleBMC::Core::Models::Vnic
3390
- def update_vnic(vnic_id, update_vnic_details, opts = {})
3391
- logger.debug "Calling operation VirtualNetworkClient#update_vnic." if logger
3392
-
3393
- fail "Missing the required parameter 'vnic_id' when calling update_vnic." if vnic_id.nil?
3394
- fail "Missing the required parameter 'update_vnic_details' when calling update_vnic." if update_vnic_details.nil?
3395
-
3396
- path = "/vnics/{vnicId}".sub('{vnicId}', vnic_id.to_s)
3397
-
3398
- # Query Params
3399
- query_params = {}
3400
-
3401
- # Header Params
3402
- header_params = {}
3403
- header_params['accept'] = 'application/json'
3404
- header_params['content-type'] = 'application/json'
3405
- header_params[:'if-match'] = opts[:'if_match'] if opts[:'if_match']
3406
-
3407
- post_body = @api_client.object_to_http_body(update_vnic_details)
3408
-
3409
- return @api_client.call_api(
3410
- :PUT,
3411
- path,
3412
- endpoint,
3413
- :header_params => header_params,
3414
- :query_params => query_params,
3415
- :body => post_body,
3416
- :return_type => 'OracleBMC::Core::Models::Vnic')
3417
- end
3418
- end
3419
- end