Class: OCI::Core::VirtualNetworkClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/virtual_network_client.rb

Overview

Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the Networking, Compute, and Block Volume services. The required permissions are documented in the Details for the Core Services article.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ VirtualNetworkClient

Creates a new VirtualNetworkClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/core/virtual_network_client.rb', line 61

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20160918'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "VirtualNetworkClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



21
22
23
 
# File 'lib/oci/core/virtual_network_client.rb', line 21

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/core/virtual_network_client.rb', line 25

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/core/virtual_network_client.rb', line 35

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



31
32
33
 
# File 'lib/oci/core/virtual_network_client.rb', line 31

def retry_config
  @retry_config
end

Instance Method Details

#add_drg_route_distribution_statements(drg_route_distribution_id, add_drg_route_distribution_statements_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_drg_route_distribution_statements API.

Adds one or more route distribution statements to the specified route distribution.

Parameters:

  • drg_route_distribution_id (String) —

    The OCID of the route distribution.

  • add_drg_route_distribution_statements_details (OCI::Core::Models::AddDrgRouteDistributionStatementsDetails) —

    Request with one or more route distribution statements to be inserted into the route distribution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/core/virtual_network_client.rb', line 119

def add_drg_route_distribution_statements(drg_route_distribution_id, add_drg_route_distribution_statements_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#add_drg_route_distribution_statements.' if logger

  raise "Missing the required parameter 'drg_route_distribution_id' when calling add_drg_route_distribution_statements." if drg_route_distribution_id.nil?
  raise "Missing the required parameter 'add_drg_route_distribution_statements_details' when calling add_drg_route_distribution_statements." if add_drg_route_distribution_statements_details.nil?
  raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id)

  path = '/drgRouteDistributions/{drgRouteDistributionId}/actions/addDrgRouteDistributionStatements'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(add_drg_route_distribution_statements_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_drg_route_distribution_statements') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::DrgRouteDistributionStatement>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_drg_route_rules(drg_route_table_id, add_drg_route_rules_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_drg_route_rules API.

Adds one or more static route rules to the specified DRG route table.

Parameters:

  • drg_route_table_id (String) —

    The OCID of the DRG route table.

  • add_drg_route_rules_details (OCI::Core::Models::AddDrgRouteRulesDetails) —

    Request for one or more route rules to be inserted into the DRG route table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/core/virtual_network_client.rb', line 181

def add_drg_route_rules(drg_route_table_id, add_drg_route_rules_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#add_drg_route_rules.' if logger

  raise "Missing the required parameter 'drg_route_table_id' when calling add_drg_route_rules." if drg_route_table_id.nil?
  raise "Missing the required parameter 'add_drg_route_rules_details' when calling add_drg_route_rules." if add_drg_route_rules_details.nil?
  raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id)

  path = '/drgRouteTables/{drgRouteTableId}/actions/addDrgRouteRules'.sub('{drgRouteTableId}', drg_route_table_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_drg_route_rules_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_drg_route_rules') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::DrgRouteRule>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_ipv4_subnet_cidr(subnet_id, add_ipv4_subnet_cidr_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_ipv4_subnet_cidr API.

Add an IPv4 prefix to a subnet.

Parameters:

  • subnet_id (String) —

    Specify the OCID of the subnet.

  • add_ipv4_subnet_cidr_details (OCI::Core::Models::AddIpv4SubnetCidrDetails) —

    Details object for adding an IPv4 prefix to a subnet.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/oci/core/virtual_network_client.rb', line 251

def add_ipv4_subnet_cidr(subnet_id, add_ipv4_subnet_cidr_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#add_ipv4_subnet_cidr.' if logger

  raise "Missing the required parameter 'subnet_id' when calling add_ipv4_subnet_cidr." if subnet_id.nil?
  raise "Missing the required parameter 'add_ipv4_subnet_cidr_details' when calling add_ipv4_subnet_cidr." if add_ipv4_subnet_cidr_details.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/subnets/{subnetId}/actions/addIpv4Cidr'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_ipv4_subnet_cidr_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_ipv4_subnet_cidr') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_ipv6_subnet_cidr(subnet_id, add_subnet_ipv6_cidr_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_ipv6_subnet_cidr API.

Add an IPv6 prefix to a subnet.

Parameters:

  • subnet_id (String) —

    Specify the OCID of the subnet.

  • add_subnet_ipv6_cidr_details (OCI::Core::Models::AddSubnetIpv6CidrDetails) —

    Details object for adding an IPv6 prefix to a subnet.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/oci/core/virtual_network_client.rb', line 322

def add_ipv6_subnet_cidr(subnet_id, add_subnet_ipv6_cidr_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#add_ipv6_subnet_cidr.' if logger

  raise "Missing the required parameter 'subnet_id' when calling add_ipv6_subnet_cidr." if subnet_id.nil?
  raise "Missing the required parameter 'add_subnet_ipv6_cidr_details' when calling add_ipv6_subnet_cidr." if add_subnet_ipv6_cidr_details.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/subnets/{subnetId}/actions/addIpv6Cidr'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_subnet_ipv6_cidr_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_ipv6_subnet_cidr') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_ipv6_vcn_cidr(vcn_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_ipv6_vcn_cidr API.

Add an IPv6 prefix to a VCN. The VCN size is always /56 and assigned by Oracle. Once added the IPv6 prefix cannot be removed or modified.

Parameters:

  • vcn_id (String) —

    Specify the OCID of the VCN.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :add_vcn_ipv6_cidr_details (OCI::Core::Models::AddVcnIpv6CidrDetails) —

    Details object for adding an IPv6 VCN CIDR.

Returns:

  • (Response) —

    A Response object with data of type nil



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/oci/core/virtual_network_client.rb', line 395

def add_ipv6_vcn_cidr(vcn_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#add_ipv6_vcn_cidr.' if logger

  raise "Missing the required parameter 'vcn_id' when calling add_ipv6_vcn_cidr." if vcn_id.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/vcns/{vcnId}/actions/addIpv6Cidr'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(opts[:add_vcn_ipv6_cidr_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_ipv6_vcn_cidr') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_network_security_group_security_rules(network_security_group_id, add_network_security_group_security_rules_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_network_security_group_security_rules API.

Adds up to 25 security rules to the specified network security group. Adding more than 25 rules requires multiple operations.

Parameters:

  • network_security_group_id (String) —

    The OCID of the network security group.

  • add_network_security_group_security_rules_details (OCI::Core::Models::AddNetworkSecurityGroupSecurityRulesDetails) —

    Request with one or more security rules to be associated with the network security group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/oci/core/virtual_network_client.rb', line 453

def add_network_security_group_security_rules(network_security_group_id, add_network_security_group_security_rules_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#add_network_security_group_security_rules.' if logger

  raise "Missing the required parameter 'network_security_group_id' when calling add_network_security_group_security_rules." if network_security_group_id.nil?
  raise "Missing the required parameter 'add_network_security_group_security_rules_details' when calling add_network_security_group_security_rules." if add_network_security_group_security_rules_details.nil?
  raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id)

  path = '/networkSecurityGroups/{networkSecurityGroupId}/actions/addSecurityRules'.sub('{networkSecurityGroupId}', network_security_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(add_network_security_group_security_rules_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_network_security_group_security_rules') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::AddedNetworkSecurityGroupSecurityRules'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_public_ip_pool_capacity(public_ip_pool_id, add_public_ip_pool_capacity_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_public_ip_pool_capacity API.

Adds some or all of a CIDR block to a public IP pool.

The CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/oci/core/virtual_network_client.rb', line 520

def add_public_ip_pool_capacity(public_ip_pool_id, add_public_ip_pool_capacity_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#add_public_ip_pool_capacity.' if logger

  raise "Missing the required parameter 'public_ip_pool_id' when calling add_public_ip_pool_capacity." if public_ip_pool_id.nil?
  raise "Missing the required parameter 'add_public_ip_pool_capacity_details' when calling add_public_ip_pool_capacity." if add_public_ip_pool_capacity_details.nil?
  raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id)

  path = '/publicIpPools/{publicIpPoolId}/actions/addCapacity'.sub('{publicIpPoolId}', public_ip_pool_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_public_ip_pool_capacity_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_public_ip_pool_capacity') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PublicIpPool'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#add_vcn_cidr(vcn_id, add_vcn_cidr_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use add_vcn_cidr API.

Adds a CIDR block to a VCN. The CIDR block you add:

  • Must be valid.

  • Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.

  • Must not exceed the limit of CIDR blocks allowed per VCN.

Note: Adding a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the GetWorkRequest operation to check the status of the update.

Parameters:

  • vcn_id (String) —

    Specify the OCID of the VCN.

  • add_vcn_cidr_details (OCI::Core::Models::AddVcnCidrDetails) —

    Details object for deleting a VCN CIDR.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/oci/core/virtual_network_client.rb', line 597

def add_vcn_cidr(vcn_id, add_vcn_cidr_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#add_vcn_cidr.' if logger

  raise "Missing the required parameter 'vcn_id' when calling add_vcn_cidr." if vcn_id.nil?
  raise "Missing the required parameter 'add_vcn_cidr_details' when calling add_vcn_cidr." if add_vcn_cidr_details.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/vcns/{vcnId}/actions/addCidr'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(add_vcn_cidr_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_vcn_cidr') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end
Note:

Click here to see an example of how to use advertise_byoip_range API.

Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud. The ByoipRange resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP.

Parameters:

  • byoip_range_id (String) —

    The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/oci/core/virtual_network_client.rb', line 658

def advertise_byoip_range(byoip_range_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#advertise_byoip_range.' if logger

  raise "Missing the required parameter 'byoip_range_id' when calling advertise_byoip_range." if byoip_range_id.nil?
  raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id)

  path = '/byoipRanges/{byoipRangeId}/actions/advertise'.sub('{byoipRangeId}', byoip_range_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#advertise_byoip_range') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#attach_service_id(service_gateway_id, attach_service_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use attach_service_id API.

Adds the specified Service to the list of enabled Service objects for the specified gateway. You must also set up a route rule with the cidrBlock of the Service as the rule's destination and the service gateway as the rule's target. See RouteTable.

Note: The AttachServiceId operation is an easy way to add an individual Service to the service gateway. Compare it with update_service_gateway, which replaces the entire existing list of enabled Service objects with the list that you provide in the Update call.

Parameters:

  • service_gateway_id (String) —

    The service gateway's OCID.

  • attach_service_details (OCI::Core::Models::ServiceIdRequestDetails) —

    ServiceId of Service to be attached to a service gateway.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'lib/oci/core/virtual_network_client.rb', line 725

def attach_service_id(service_gateway_id, attach_service_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#attach_service_id.' if logger

  raise "Missing the required parameter 'service_gateway_id' when calling attach_service_id." if service_gateway_id.nil?
  raise "Missing the required parameter 'attach_service_details' when calling attach_service_id." if attach_service_details.nil?
  raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id)

  path = '/serviceGateways/{serviceGatewayId}/actions/attachService'.sub('{serviceGatewayId}', service_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(attach_service_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#attach_service_id') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::ServiceGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#bulk_add_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_add_virtual_circuit_public_prefixes_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use bulk_add_virtual_circuit_public_prefixes API.

Adds one or more customer public IP prefixes to the specified public virtual circuit. Use this operation (and not update_virtual_circuit) to add prefixes to the virtual circuit. Oracle must verify the customer's ownership of each prefix before traffic for that prefix will flow across the virtual circuit.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:

  • (Response) —

    A Response object with data of type nil



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
 
# File 'lib/oci/core/virtual_network_client.rb', line 785

def bulk_add_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_add_virtual_circuit_public_prefixes_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#bulk_add_virtual_circuit_public_prefixes.' if logger

  raise "Missing the required parameter 'virtual_circuit_id' when calling bulk_add_virtual_circuit_public_prefixes." if virtual_circuit_id.nil?
  raise "Missing the required parameter 'bulk_add_virtual_circuit_public_prefixes_details' when calling bulk_add_virtual_circuit_public_prefixes." if bulk_add_virtual_circuit_public_prefixes_details.nil?
  raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id)

  path = '/virtualCircuits/{virtualCircuitId}/actions/bulkAddPublicPrefixes'.sub('{virtualCircuitId}', virtual_circuit_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(bulk_add_virtual_circuit_public_prefixes_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_add_virtual_circuit_public_prefixes') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#bulk_create_ipv6s(bulk_create_ipv6s_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use bulk_create_ipv6s API.

Create new IPv6s in bulk for a VNIC or subnet.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'lib/oci/core/virtual_network_client.rb', line 848

def bulk_create_ipv6s(bulk_create_ipv6s_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#bulk_create_ipv6s.' if logger

  raise "Missing the required parameter 'bulk_create_ipv6s_details' when calling bulk_create_ipv6s." if bulk_create_ipv6s_details.nil?

  path = '/ipv6/actions/bulkCreateIpv6s'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_create_ipv6s_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_create_ipv6s') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#bulk_create_private_ips(bulk_create_private_ips_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use bulk_create_private_ips API.

Create secondary private IPv4 addresses.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'lib/oci/core/virtual_network_client.rb', line 911

def bulk_create_private_ips(bulk_create_private_ips_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#bulk_create_private_ips.' if logger

  raise "Missing the required parameter 'bulk_create_private_ips_details' when calling bulk_create_private_ips." if bulk_create_private_ips_details.nil?

  path = '/privateIps/actions/bulkCreatePrivateIps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_create_private_ips_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_create_private_ips') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#bulk_delete_ipv6s(bulk_delete_ipv6s_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use bulk_delete_ipv6s API.

Unassign and delete IPv6s for a VNIC in bulk.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'lib/oci/core/virtual_network_client.rb', line 974

def bulk_delete_ipv6s(bulk_delete_ipv6s_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#bulk_delete_ipv6s.' if logger

  raise "Missing the required parameter 'bulk_delete_ipv6s_details' when calling bulk_delete_ipv6s." if bulk_delete_ipv6s_details.nil?

  path = '/ipv6/actions/bulkDeleteIpv6s'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_delete_ipv6s_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_delete_ipv6s') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#bulk_delete_private_ips(bulk_delete_private_ips_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use bulk_delete_private_ips API.

Unassign and delete secondary private IPv4s for a VNIC.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
 
# File 'lib/oci/core/virtual_network_client.rb', line 1037

def bulk_delete_private_ips(bulk_delete_private_ips_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#bulk_delete_private_ips.' if logger

  raise "Missing the required parameter 'bulk_delete_private_ips_details' when calling bulk_delete_private_ips." if bulk_delete_private_ips_details.nil?

  path = '/privateIps/actions/bulkDeletePrivateIps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_delete_private_ips_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_delete_private_ips') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#bulk_delete_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_delete_virtual_circuit_public_prefixes_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use bulk_delete_virtual_circuit_public_prefixes API.

Removes one or more customer public IP prefixes from the specified public virtual circuit. Use this operation (and not update_virtual_circuit) to remove prefixes from the virtual circuit. When the virtual circuit's state switches back to PROVISIONED, Oracle stops advertising the specified prefixes across the connection.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:

  • (Response) —

    A Response object with data of type nil



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
 
# File 'lib/oci/core/virtual_network_client.rb', line 1096

def bulk_delete_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_delete_virtual_circuit_public_prefixes_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#bulk_delete_virtual_circuit_public_prefixes.' if logger

  raise "Missing the required parameter 'virtual_circuit_id' when calling bulk_delete_virtual_circuit_public_prefixes." if virtual_circuit_id.nil?
  raise "Missing the required parameter 'bulk_delete_virtual_circuit_public_prefixes_details' when calling bulk_delete_virtual_circuit_public_prefixes." if bulk_delete_virtual_circuit_public_prefixes_details.nil?
  raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id)

  path = '/virtualCircuits/{virtualCircuitId}/actions/bulkDeletePublicPrefixes'.sub('{virtualCircuitId}', virtual_circuit_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(bulk_delete_virtual_circuit_public_prefixes_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_delete_virtual_circuit_public_prefixes') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#bulk_detach_ipv6s(bulk_detach_ipv6s_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use bulk_detach_ipv6s API.

Detach the specified IPv6s.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/oci/core/virtual_network_client.rb', line 1159

def bulk_detach_ipv6s(bulk_detach_ipv6s_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#bulk_detach_ipv6s.' if logger

  raise "Missing the required parameter 'bulk_detach_ipv6s_details' when calling bulk_detach_ipv6s." if bulk_detach_ipv6s_details.nil?

  path = '/ipv6/actions/bulkDetachIpv6s'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_detach_ipv6s_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_detach_ipv6s') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#bulk_detach_private_ips(bulk_detach_private_ips_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use bulk_detach_private_ips API.

Unassign the specified private IP addresses from the Virtual Network Interface Card (VNIC). You must specify the PrivateIP object's OCID.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/oci/core/virtual_network_client.rb', line 1222

def bulk_detach_private_ips(bulk_detach_private_ips_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#bulk_detach_private_ips.' if logger

  raise "Missing the required parameter 'bulk_detach_private_ips_details' when calling bulk_detach_private_ips." if bulk_detach_private_ips_details.nil?

  path = '/privateIps/actions/bulkDetachPrivateIps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_detach_private_ips_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_detach_private_ips') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#bulk_update_ipv6s(bulk_update_ipv6s_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use bulk_update_ipv6s API.

Updates the specified IPv6s in bulk.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/oci/core/virtual_network_client.rb', line 1285

def bulk_update_ipv6s(bulk_update_ipv6s_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#bulk_update_ipv6s.' if logger

  raise "Missing the required parameter 'bulk_update_ipv6s_details' when calling bulk_update_ipv6s." if bulk_update_ipv6s_details.nil?

  path = '/ipv6/actions/bulkUpdateIpv6s'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_update_ipv6s_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_update_ipv6s') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#bulk_update_private_ips(bulk_update_private_ips_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use bulk_update_private_ips API.

Update existing secondary private IPv4s for a VNIC.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
 
# File 'lib/oci/core/virtual_network_client.rb', line 1347

def bulk_update_private_ips(bulk_update_private_ips_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#bulk_update_private_ips.' if logger

  raise "Missing the required parameter 'bulk_update_private_ips_details' when calling bulk_update_private_ips." if bulk_update_private_ips_details.nil?

  path = '/privateIps/actions/bulkUpdatePrivateIps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(bulk_update_private_ips_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_update_private_ips') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_byoasn_compartment(byoasn_id, change_byoasn_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_byoasn_compartment API.

Moves a BYOASN Resource to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
 
# File 'lib/oci/core/virtual_network_client.rb', line 1417

def change_byoasn_compartment(byoasn_id, change_byoasn_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_byoasn_compartment.' if logger

  raise "Missing the required parameter 'byoasn_id' when calling change_byoasn_compartment." if byoasn_id.nil?
  raise "Missing the required parameter 'change_byoasn_compartment_details' when calling change_byoasn_compartment." if change_byoasn_compartment_details.nil?
  raise "Parameter value for 'byoasn_id' must not be blank" if OCI::Internal::Util.blank_string?(byoasn_id)

  path = '/byoasns/{byoasnId}/actions/changeCompartment'.sub('{byoasnId}', byoasn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_byoasn_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_byoasn_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_byoip_range_compartment(byoip_range_id, change_byoip_range_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_byoip_range_compartment API.

Moves a BYOIP CIDR block to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

  • byoip_range_id (String) —

    The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • change_byoip_range_compartment_details (OCI::Core::Models::ChangeByoipRangeCompartmentDetails) —

    Request to change the compartment of a BYOIP CIDR block.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
 
# File 'lib/oci/core/virtual_network_client.rb', line 1486

def change_byoip_range_compartment(byoip_range_id, change_byoip_range_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_byoip_range_compartment.' if logger

  raise "Missing the required parameter 'byoip_range_id' when calling change_byoip_range_compartment." if byoip_range_id.nil?
  raise "Missing the required parameter 'change_byoip_range_compartment_details' when calling change_byoip_range_compartment." if change_byoip_range_compartment_details.nil?
  raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id)

  path = '/byoipRanges/{byoipRangeId}/actions/changeCompartment'.sub('{byoipRangeId}', byoip_range_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_byoip_range_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_byoip_range_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_capture_filter_compartment(capture_filter_id, change_capture_filter_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_capture_filter_compartment API.

Moves a capture filter to a new compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
 
# File 'lib/oci/core/virtual_network_client.rb', line 1558

def change_capture_filter_compartment(capture_filter_id, change_capture_filter_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_capture_filter_compartment.' if logger

  raise "Missing the required parameter 'capture_filter_id' when calling change_capture_filter_compartment." if capture_filter_id.nil?
  raise "Missing the required parameter 'change_capture_filter_compartment_details' when calling change_capture_filter_compartment." if change_capture_filter_compartment_details.nil?
  raise "Parameter value for 'capture_filter_id' must not be blank" if OCI::Internal::Util.blank_string?(capture_filter_id)

  path = '/captureFilters/{captureFilterId}/actions/changeCompartment'.sub('{captureFilterId}', capture_filter_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_capture_filter_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_capture_filter_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_cpe_compartment(cpe_id, change_cpe_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_cpe_compartment API.

Moves a CPE object into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
 
# File 'lib/oci/core/virtual_network_client.rb', line 1627

def change_cpe_compartment(cpe_id, change_cpe_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_cpe_compartment.' if logger

  raise "Missing the required parameter 'cpe_id' when calling change_cpe_compartment." if cpe_id.nil?
  raise "Missing the required parameter 'change_cpe_compartment_details' when calling change_cpe_compartment." if change_cpe_compartment_details.nil?
  raise "Parameter value for 'cpe_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_id)

  path = '/cpes/{cpeId}/actions/changeCompartment'.sub('{cpeId}', cpe_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_cpe_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_cpe_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_cross_connect_compartment(cross_connect_id, change_cross_connect_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_cross_connect_compartment API.

Moves a cross-connect into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
 
# File 'lib/oci/core/virtual_network_client.rb', line 1695

def change_cross_connect_compartment(cross_connect_id, change_cross_connect_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_cross_connect_compartment.' if logger

  raise "Missing the required parameter 'cross_connect_id' when calling change_cross_connect_compartment." if cross_connect_id.nil?
  raise "Missing the required parameter 'change_cross_connect_compartment_details' when calling change_cross_connect_compartment." if change_cross_connect_compartment_details.nil?
  raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id)

  path = '/crossConnects/{crossConnectId}/actions/changeCompartment'.sub('{crossConnectId}', cross_connect_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_cross_connect_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_cross_connect_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_cross_connect_group_compartment(cross_connect_group_id, change_cross_connect_group_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_cross_connect_group_compartment API.

Moves a cross-connect group into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
 
# File 'lib/oci/core/virtual_network_client.rb', line 1763

def change_cross_connect_group_compartment(cross_connect_group_id, change_cross_connect_group_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_cross_connect_group_compartment.' if logger

  raise "Missing the required parameter 'cross_connect_group_id' when calling change_cross_connect_group_compartment." if cross_connect_group_id.nil?
  raise "Missing the required parameter 'change_cross_connect_group_compartment_details' when calling change_cross_connect_group_compartment." if change_cross_connect_group_compartment_details.nil?
  raise "Parameter value for 'cross_connect_group_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_group_id)

  path = '/crossConnectGroups/{crossConnectGroupId}/actions/changeCompartment'.sub('{crossConnectGroupId}', cross_connect_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_cross_connect_group_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_cross_connect_group_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_dhcp_options_compartment(dhcp_id, change_dhcp_options_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_dhcp_options_compartment API.

Moves a set of DHCP options into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
 
# File 'lib/oci/core/virtual_network_client.rb', line 1831

def change_dhcp_options_compartment(dhcp_id, change_dhcp_options_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_dhcp_options_compartment.' if logger

  raise "Missing the required parameter 'dhcp_id' when calling change_dhcp_options_compartment." if dhcp_id.nil?
  raise "Missing the required parameter 'change_dhcp_options_compartment_details' when calling change_dhcp_options_compartment." if change_dhcp_options_compartment_details.nil?
  raise "Parameter value for 'dhcp_id' must not be blank" if OCI::Internal::Util.blank_string?(dhcp_id)

  path = '/dhcps/{dhcpId}/actions/changeCompartment'.sub('{dhcpId}', dhcp_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_dhcp_options_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_dhcp_options_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_drg_compartment(drg_id, change_drg_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_drg_compartment API.

Moves a DRG into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
 
# File 'lib/oci/core/virtual_network_client.rb', line 1899

def change_drg_compartment(drg_id, change_drg_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_drg_compartment.' if logger

  raise "Missing the required parameter 'drg_id' when calling change_drg_compartment." if drg_id.nil?
  raise "Missing the required parameter 'change_drg_compartment_details' when calling change_drg_compartment." if change_drg_compartment_details.nil?
  raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id)

  path = '/drgs/{drgId}/actions/changeCompartment'.sub('{drgId}', drg_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_drg_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_drg_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_internet_gateway_compartment(ig_id, change_internet_gateway_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_internet_gateway_compartment API.

Moves an internet gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'lib/oci/core/virtual_network_client.rb', line 1967

def change_internet_gateway_compartment(ig_id, change_internet_gateway_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_internet_gateway_compartment.' if logger

  raise "Missing the required parameter 'ig_id' when calling change_internet_gateway_compartment." if ig_id.nil?
  raise "Missing the required parameter 'change_internet_gateway_compartment_details' when calling change_internet_gateway_compartment." if change_internet_gateway_compartment_details.nil?
  raise "Parameter value for 'ig_id' must not be blank" if OCI::Internal::Util.blank_string?(ig_id)

  path = '/internetGateways/{igId}/actions/changeCompartment'.sub('{igId}', ig_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_internet_gateway_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_internet_gateway_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_ip_sec_connection_compartment(ipsc_id, change_ip_sec_connection_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_ip_sec_connection_compartment API.

Moves an IPSec connection into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
 
# File 'lib/oci/core/virtual_network_client.rb', line 2035

def change_ip_sec_connection_compartment(ipsc_id, change_ip_sec_connection_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_ip_sec_connection_compartment.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling change_ip_sec_connection_compartment." if ipsc_id.nil?
  raise "Missing the required parameter 'change_ip_sec_connection_compartment_details' when calling change_ip_sec_connection_compartment." if change_ip_sec_connection_compartment_details.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)

  path = '/ipsecConnections/{ipscId}/actions/changeCompartment'.sub('{ipscId}', ipsc_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_ip_sec_connection_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_ip_sec_connection_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_local_peering_gateway_compartment(local_peering_gateway_id, change_local_peering_gateway_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_local_peering_gateway_compartment API.

Moves a local peering gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
 
# File 'lib/oci/core/virtual_network_client.rb', line 2103

def change_local_peering_gateway_compartment(local_peering_gateway_id, change_local_peering_gateway_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_local_peering_gateway_compartment.' if logger

  raise "Missing the required parameter 'local_peering_gateway_id' when calling change_local_peering_gateway_compartment." if local_peering_gateway_id.nil?
  raise "Missing the required parameter 'change_local_peering_gateway_compartment_details' when calling change_local_peering_gateway_compartment." if change_local_peering_gateway_compartment_details.nil?
  raise "Parameter value for 'local_peering_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(local_peering_gateway_id)

  path = '/localPeeringGateways/{localPeeringGatewayId}/actions/changeCompartment'.sub('{localPeeringGatewayId}', local_peering_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_local_peering_gateway_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_local_peering_gateway_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_nat_gateway_compartment(nat_gateway_id, change_nat_gateway_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_nat_gateway_compartment API.

Moves a NAT gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
 
# File 'lib/oci/core/virtual_network_client.rb', line 2171

def change_nat_gateway_compartment(nat_gateway_id, change_nat_gateway_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_nat_gateway_compartment.' if logger

  raise "Missing the required parameter 'nat_gateway_id' when calling change_nat_gateway_compartment." if nat_gateway_id.nil?
  raise "Missing the required parameter 'change_nat_gateway_compartment_details' when calling change_nat_gateway_compartment." if change_nat_gateway_compartment_details.nil?
  raise "Parameter value for 'nat_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(nat_gateway_id)

  path = '/natGateways/{natGatewayId}/actions/changeCompartment'.sub('{natGatewayId}', nat_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_nat_gateway_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_nat_gateway_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_network_security_group_compartment(network_security_group_id, change_network_security_group_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_network_security_group_compartment API.

Moves a network security group into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
 
# File 'lib/oci/core/virtual_network_client.rb', line 2238

def change_network_security_group_compartment(network_security_group_id, change_network_security_group_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_network_security_group_compartment.' if logger

  raise "Missing the required parameter 'network_security_group_id' when calling change_network_security_group_compartment." if network_security_group_id.nil?
  raise "Missing the required parameter 'change_network_security_group_compartment_details' when calling change_network_security_group_compartment." if change_network_security_group_compartment_details.nil?
  raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id)

  path = '/networkSecurityGroups/{networkSecurityGroupId}/actions/changeCompartment'.sub('{networkSecurityGroupId}', network_security_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_network_security_group_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_network_security_group_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_public_ip_compartment(public_ip_id, change_public_ip_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_public_ip_compartment API.

Moves a public IP into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

This operation applies only to reserved public IPs. Ephemeral public IPs always belong to the same compartment as their VNIC and move accordingly.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
 
# File 'lib/oci/core/virtual_network_client.rb', line 2309

def change_public_ip_compartment(public_ip_id, change_public_ip_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_public_ip_compartment.' if logger

  raise "Missing the required parameter 'public_ip_id' when calling change_public_ip_compartment." if public_ip_id.nil?
  raise "Missing the required parameter 'change_public_ip_compartment_details' when calling change_public_ip_compartment." if change_public_ip_compartment_details.nil?
  raise "Parameter value for 'public_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_id)

  path = '/publicIps/{publicIpId}/actions/changeCompartment'.sub('{publicIpId}', public_ip_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_public_ip_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_public_ip_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_public_ip_pool_compartment(public_ip_pool_id, change_public_ip_pool_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_public_ip_pool_compartment API.

Moves a public IP pool to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
 
# File 'lib/oci/core/virtual_network_client.rb', line 2377

def change_public_ip_pool_compartment(public_ip_pool_id, change_public_ip_pool_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_public_ip_pool_compartment.' if logger

  raise "Missing the required parameter 'public_ip_pool_id' when calling change_public_ip_pool_compartment." if public_ip_pool_id.nil?
  raise "Missing the required parameter 'change_public_ip_pool_compartment_details' when calling change_public_ip_pool_compartment." if change_public_ip_pool_compartment_details.nil?
  raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id)

  path = '/publicIpPools/{publicIpPoolId}/actions/changeCompartment'.sub('{publicIpPoolId}', public_ip_pool_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_public_ip_pool_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_public_ip_pool_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_remote_peering_connection_compartment(remote_peering_connection_id, change_remote_peering_connection_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_remote_peering_connection_compartment API.

Moves a remote peering connection (RPC) into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
 
# File 'lib/oci/core/virtual_network_client.rb', line 2445

def change_remote_peering_connection_compartment(remote_peering_connection_id, change_remote_peering_connection_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_remote_peering_connection_compartment.' if logger

  raise "Missing the required parameter 'remote_peering_connection_id' when calling change_remote_peering_connection_compartment." if remote_peering_connection_id.nil?
  raise "Missing the required parameter 'change_remote_peering_connection_compartment_details' when calling change_remote_peering_connection_compartment." if change_remote_peering_connection_compartment_details.nil?
  raise "Parameter value for 'remote_peering_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(remote_peering_connection_id)

  path = '/remotePeeringConnections/{remotePeeringConnectionId}/actions/changeCompartment'.sub('{remotePeeringConnectionId}', remote_peering_connection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_remote_peering_connection_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_remote_peering_connection_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_route_table_compartment(rt_id, change_route_table_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_route_table_compartment API.

Moves a route table into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
 
# File 'lib/oci/core/virtual_network_client.rb', line 2513

def change_route_table_compartment(rt_id, change_route_table_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_route_table_compartment.' if logger

  raise "Missing the required parameter 'rt_id' when calling change_route_table_compartment." if rt_id.nil?
  raise "Missing the required parameter 'change_route_table_compartment_details' when calling change_route_table_compartment." if change_route_table_compartment_details.nil?
  raise "Parameter value for 'rt_id' must not be blank" if OCI::Internal::Util.blank_string?(rt_id)

  path = '/routeTables/{rtId}/actions/changeCompartment'.sub('{rtId}', rt_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_route_table_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_route_table_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_security_list_compartment(security_list_id, change_security_list_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_security_list_compartment API.

Moves a security list into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
 
# File 'lib/oci/core/virtual_network_client.rb', line 2581

def change_security_list_compartment(security_list_id, change_security_list_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_security_list_compartment.' if logger

  raise "Missing the required parameter 'security_list_id' when calling change_security_list_compartment." if security_list_id.nil?
  raise "Missing the required parameter 'change_security_list_compartment_details' when calling change_security_list_compartment." if change_security_list_compartment_details.nil?
  raise "Parameter value for 'security_list_id' must not be blank" if OCI::Internal::Util.blank_string?(security_list_id)

  path = '/securityLists/{securityListId}/actions/changeCompartment'.sub('{securityListId}', security_list_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_security_list_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_security_list_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_service_gateway_compartment(service_gateway_id, change_service_gateway_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_service_gateway_compartment API.

Moves a service gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
 
# File 'lib/oci/core/virtual_network_client.rb', line 2649

def change_service_gateway_compartment(service_gateway_id, change_service_gateway_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_service_gateway_compartment.' if logger

  raise "Missing the required parameter 'service_gateway_id' when calling change_service_gateway_compartment." if service_gateway_id.nil?
  raise "Missing the required parameter 'change_service_gateway_compartment_details' when calling change_service_gateway_compartment." if change_service_gateway_compartment_details.nil?
  raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id)

  path = '/serviceGateways/{serviceGatewayId}/actions/changeCompartment'.sub('{serviceGatewayId}', service_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_service_gateway_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_service_gateway_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_subnet_compartment(subnet_id, change_subnet_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_subnet_compartment API.

Moves a subnet into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
 
# File 'lib/oci/core/virtual_network_client.rb', line 2717

def change_subnet_compartment(subnet_id, change_subnet_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_subnet_compartment.' if logger

  raise "Missing the required parameter 'subnet_id' when calling change_subnet_compartment." if subnet_id.nil?
  raise "Missing the required parameter 'change_subnet_compartment_details' when calling change_subnet_compartment." if change_subnet_compartment_details.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/subnets/{subnetId}/actions/changeCompartment'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_subnet_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_subnet_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_vcn_compartment(vcn_id, change_vcn_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_vcn_compartment API.

Moves a VCN into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
 
# File 'lib/oci/core/virtual_network_client.rb', line 2785

def change_vcn_compartment(vcn_id, change_vcn_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_vcn_compartment.' if logger

  raise "Missing the required parameter 'vcn_id' when calling change_vcn_compartment." if vcn_id.nil?
  raise "Missing the required parameter 'change_vcn_compartment_details' when calling change_vcn_compartment." if change_vcn_compartment_details.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/vcns/{vcnId}/actions/changeCompartment'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_vcn_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_vcn_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_virtual_circuit_compartment(virtual_circuit_id, change_virtual_circuit_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_virtual_circuit_compartment API.

Moves a virtual circuit into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
 
# File 'lib/oci/core/virtual_network_client.rb', line 2853

def change_virtual_circuit_compartment(virtual_circuit_id, change_virtual_circuit_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_virtual_circuit_compartment.' if logger

  raise "Missing the required parameter 'virtual_circuit_id' when calling change_virtual_circuit_compartment." if virtual_circuit_id.nil?
  raise "Missing the required parameter 'change_virtual_circuit_compartment_details' when calling change_virtual_circuit_compartment." if change_virtual_circuit_compartment_details.nil?
  raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id)

  path = '/virtualCircuits/{virtualCircuitId}/actions/changeCompartment'.sub('{virtualCircuitId}', virtual_circuit_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_virtual_circuit_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_virtual_circuit_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_vlan_compartment(vlan_id, change_vlan_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_vlan_compartment API.

Moves a VLAN into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
 
# File 'lib/oci/core/virtual_network_client.rb', line 2925

def change_vlan_compartment(vlan_id, change_vlan_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_vlan_compartment.' if logger

  raise "Missing the required parameter 'vlan_id' when calling change_vlan_compartment." if vlan_id.nil?
  raise "Missing the required parameter 'change_vlan_compartment_details' when calling change_vlan_compartment." if change_vlan_compartment_details.nil?
  raise "Parameter value for 'vlan_id' must not be blank" if OCI::Internal::Util.blank_string?(vlan_id)

  path = '/vlans/{vlanId}/actions/changeCompartment'.sub('{vlanId}', vlan_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_vlan_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_vlan_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#change_vtap_compartment(vtap_id, change_vtap_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_vtap_compartment API.

Moves a VTAP to a new compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
 
# File 'lib/oci/core/virtual_network_client.rb', line 2998

def change_vtap_compartment(vtap_id, change_vtap_compartment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#change_vtap_compartment.' if logger

  raise "Missing the required parameter 'vtap_id' when calling change_vtap_compartment." if vtap_id.nil?
  raise "Missing the required parameter 'change_vtap_compartment_details' when calling change_vtap_compartment." if change_vtap_compartment_details.nil?
  raise "Parameter value for 'vtap_id' must not be blank" if OCI::Internal::Util.blank_string?(vtap_id)

  path = '/vtaps/{vtapId}/actions/changeCompartment'.sub('{vtapId}', vtap_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_vtap_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_vtap_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#connect_local_peering_gateways(local_peering_gateway_id, connect_local_peering_gateways_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use connect_local_peering_gateways API.

Connects this local peering gateway (LPG) to another one in the same region.

This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.

Parameters:

  • local_peering_gateway_id (String) —

    The OCID of the local peering gateway.

  • connect_local_peering_gateways_details (OCI::Core::Models::ConnectLocalPeeringGatewaysDetails) —

    Details regarding the local peering gateway to connect.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:

  • (Response) —

    A Response object with data of type nil



3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
 
# File 'lib/oci/core/virtual_network_client.rb', line 3064

def connect_local_peering_gateways(local_peering_gateway_id, connect_local_peering_gateways_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#connect_local_peering_gateways.' if logger

  raise "Missing the required parameter 'local_peering_gateway_id' when calling connect_local_peering_gateways." if local_peering_gateway_id.nil?
  raise "Missing the required parameter 'connect_local_peering_gateways_details' when calling connect_local_peering_gateways." if connect_local_peering_gateways_details.nil?
  raise "Parameter value for 'local_peering_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(local_peering_gateway_id)

  path = '/localPeeringGateways/{localPeeringGatewayId}/actions/connect'.sub('{localPeeringGatewayId}', local_peering_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(connect_local_peering_gateways_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#connect_local_peering_gateways') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#connect_remote_peering_connections(remote_peering_connection_id, connect_remote_peering_connections_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use connect_remote_peering_connections API.

Connects this RPC to another one in a different region.

This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to RPCs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.

Parameters:

  • remote_peering_connection_id (String) —

    The OCID of the remote peering connection (RPC).

  • connect_remote_peering_connections_details (OCI::Core::Models::ConnectRemotePeeringConnectionsDetails) —

    Details to connect peering connection with peering connection from remote region

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:

  • (Response) —

    A Response object with data of type nil



3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'lib/oci/core/virtual_network_client.rb', line 3128

def connect_remote_peering_connections(remote_peering_connection_id, connect_remote_peering_connections_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#connect_remote_peering_connections.' if logger

  raise "Missing the required parameter 'remote_peering_connection_id' when calling connect_remote_peering_connections." if remote_peering_connection_id.nil?
  raise "Missing the required parameter 'connect_remote_peering_connections_details' when calling connect_remote_peering_connections." if connect_remote_peering_connections_details.nil?
  raise "Parameter value for 'remote_peering_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(remote_peering_connection_id)

  path = '/remotePeeringConnections/{remotePeeringConnectionId}/actions/connect'.sub('{remotePeeringConnectionId}', remote_peering_connection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(connect_remote_peering_connections_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#connect_remote_peering_connections') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_byoasn(create_byoasn_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_byoasn API.

Creates a BYOASN Resource

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
 
# File 'lib/oci/core/virtual_network_client.rb', line 3191

def create_byoasn(create_byoasn_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_byoasn.' if logger

  raise "Missing the required parameter 'create_byoasn_details' when calling create_byoasn." if create_byoasn_details.nil?

  path = '/byoasns'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_byoasn_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_byoasn') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Byoasn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_byoip_range(create_byoip_range_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_byoip_range API.

Creates a subrange of the BYOIP CIDR block.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
 
# File 'lib/oci/core/virtual_network_client.rb', line 3255

def create_byoip_range(create_byoip_range_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_byoip_range.' if logger

  raise "Missing the required parameter 'create_byoip_range_details' when calling create_byoip_range." if create_byoip_range_details.nil?

  path = '/byoipRanges'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_byoip_range_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_byoip_range') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::ByoipRange'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_capture_filter(create_capture_filter_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_capture_filter API.

Creates a virtual test access point (VTAP) capture filter in the specified compartment.

For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
 
# File 'lib/oci/core/virtual_network_client.rb', line 3327

def create_capture_filter(create_capture_filter_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_capture_filter.' if logger

  raise "Missing the required parameter 'create_capture_filter_details' when calling create_capture_filter." if create_capture_filter_details.nil?

  path = '/captureFilters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_capture_filter_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_capture_filter') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CaptureFilter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_cpe(create_cpe_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_cpe API.

Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For more information, see Site-to-Site VPN Overview.

For the purposes of access control, you must provide the OCID of the compartment where you want the CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec connection or other Networking Service components. If you're not sure which compartment to use, put the CPE in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You must provide the public IP address of your on-premises router. See CPE Configuration.

You may optionally specify a display name for the CPE, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type Cpe



3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
 
# File 'lib/oci/core/virtual_network_client.rb', line 3402

def create_cpe(create_cpe_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_cpe.' if logger

  raise "Missing the required parameter 'create_cpe_details' when calling create_cpe." if create_cpe_details.nil?

  path = '/cpes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_cpe_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_cpe') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Cpe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_cross_connect(create_cross_connect_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_cross_connect API.

Creates a new cross-connect. Oracle recommends you create each cross-connect in a CrossConnectGroup so you can use link aggregation with the connection.

After creating the CrossConnect object, you need to go the FastConnect location and request to have the physical cable installed. For more information, see FastConnect Overview.

For the purposes of access control, you must provide the OCID of the compartment where you want the cross-connect to reside. If you're not sure which compartment to use, put the cross-connect in the same compartment with your VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the cross-connect. It does not have to be unique, and you can change it. Avoid entering confidential information.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
 
# File 'lib/oci/core/virtual_network_client.rb', line 3480

def create_cross_connect(create_cross_connect_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_cross_connect.' if logger

  raise "Missing the required parameter 'create_cross_connect_details' when calling create_cross_connect." if create_cross_connect_details.nil?

  path = '/crossConnects'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_cross_connect_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_cross_connect') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CrossConnect'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_cross_connect_group(create_cross_connect_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_cross_connect_group API.

Creates a new cross-connect group to use with Oracle Cloud Infrastructure FastConnect. For more information, see FastConnect Overview.

For the purposes of access control, you must provide the OCID of the compartment where you want the cross-connect group to reside. If you're not sure which compartment to use, put the cross-connect group in the same compartment with your VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the cross-connect group. It does not have to be unique, and you can change it. Avoid entering confidential information.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
 
# File 'lib/oci/core/virtual_network_client.rb', line 3554

def create_cross_connect_group(create_cross_connect_group_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_cross_connect_group.' if logger

  raise "Missing the required parameter 'create_cross_connect_group_details' when calling create_cross_connect_group." if create_cross_connect_group_details.nil?

  path = '/crossConnectGroups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_cross_connect_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_cross_connect_group') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CrossConnectGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_dhcp_options(create_dhcp_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_dhcp_options API.

Creates a new set of DHCP options for the specified VCN. For more information, see DhcpOptions.

For the purposes of access control, you must provide the OCID of the compartment where you want the set of DHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the set of DHCP options in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the set of DHCP options, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
 
# File 'lib/oci/core/virtual_network_client.rb', line 3625

def create_dhcp_options(create_dhcp_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_dhcp_options.' if logger

  raise "Missing the required parameter 'create_dhcp_details' when calling create_dhcp_options." if create_dhcp_details.nil?

  path = '/dhcps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_dhcp_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_dhcp_options') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DhcpOptions'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_drg(create_drg_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_drg API.

Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information, see Dynamic Routing Gateways (DRGs).

For the purposes of access control, you must provide the OCID of the compartment where you want the DRG to reside. Notice that the DRG doesn't have to be in the same compartment as the VCN, the DRG attachment, or other Networking Service components. If you're not sure which compartment to use, put the DRG in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the DRG, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type Drg



3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
 
# File 'lib/oci/core/virtual_network_client.rb', line 3696

def create_drg(create_drg_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_drg.' if logger

  raise "Missing the required parameter 'create_drg_details' when calling create_drg." if create_drg_details.nil?

  path = '/drgs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_drg_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_drg') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Drg'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_drg_attachment(create_drg_attachment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_drg_attachment API.

Attaches the specified DRG to the specified network resource. A VCN can be attached to only one DRG at a time, but a DRG can be attached to more than one VCN. The response includes a DrgAttachment object with its own OCID. For more information about DRGs, see Dynamic Routing Gateways (DRGs).

You may optionally specify a display name for the attachment, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

For the purposes of access control, the DRG attachment is automatically placed into the currently selected compartment. For more information about compartments and access control, see Overview of the IAM Service.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
 
# File 'lib/oci/core/virtual_network_client.rb', line 3766

def create_drg_attachment(create_drg_attachment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_drg_attachment.' if logger

  raise "Missing the required parameter 'create_drg_attachment_details' when calling create_drg_attachment." if create_drg_attachment_details.nil?

  path = '/drgAttachments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_drg_attachment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_drg_attachment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgAttachment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_drg_route_distribution(create_drg_route_distribution_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_drg_route_distribution API.

Creates a new route distribution for the specified DRG. Assign the route distribution as an import distribution to a DRG route table using the UpdateDrgRouteTable or CreateDrgRouteTable operations. Assign the route distribution as an export distribution to a DRG attachment using the UpdateDrgAttachment or CreateDrgAttachment operations.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
 
# File 'lib/oci/core/virtual_network_client.rb', line 3829

def create_drg_route_distribution(create_drg_route_distribution_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_drg_route_distribution.' if logger

  raise "Missing the required parameter 'create_drg_route_distribution_details' when calling create_drg_route_distribution." if create_drg_route_distribution_details.nil?

  path = '/drgRouteDistributions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_drg_route_distribution_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_drg_route_distribution') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgRouteDistribution'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_drg_route_table(create_drg_route_table_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_drg_route_table API.

Creates a new DRG route table for the specified DRG. Assign the DRG route table to a DRG attachment using the UpdateDrgAttachment or CreateDrgAttachment operations.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
 
# File 'lib/oci/core/virtual_network_client.rb', line 3890

def create_drg_route_table(create_drg_route_table_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_drg_route_table.' if logger

  raise "Missing the required parameter 'create_drg_route_table_details' when calling create_drg_route_table." if create_drg_route_table_details.nil?

  path = '/drgRouteTables'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_drg_route_table_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_drg_route_table') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgRouteTable'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_internet_gateway(create_internet_gateway_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_internet_gateway API.

Creates a new internet gateway for the specified VCN. For more information, see Access to the Internet.

For the purposes of access control, you must provide the OCID of the compartment where you want the Internet Gateway to reside. Notice that the internet gateway doesn't have to be in the same compartment as the VCN or other Networking Service components. If you're not sure which compartment to use, put the Internet Gateway in the same compartment with the VCN. For more information about compartments and access control, see Overview of the IAM Service.

You may optionally specify a display name for the internet gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

For traffic to flow between a subnet and an internet gateway, you must create a route rule accordingly in the subnet's route table (for example, 0.0.0.0/0 > internet gateway). See update_route_table.

You must specify whether the internet gateway is enabled when you create it. If it's disabled, that means no traffic will flow to/from the internet even if there's a route rule that enables that traffic. You can later use update_internet_gateway to easily disable/enable the gateway without changing the route rule.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
 
# File 'lib/oci/core/virtual_network_client.rb', line 3969

def create_internet_gateway(create_internet_gateway_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_internet_gateway.' if logger

  raise "Missing the required parameter 'create_internet_gateway_details' when calling create_internet_gateway." if create_internet_gateway_details.nil?

  path = '/internetGateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_internet_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_internet_gateway') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::InternetGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_ip_sec_connection(create_ip_sec_connection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_ip_sec_connection API.

Creates a new IPSec connection between the specified DRG and CPE. For more information, see Site-to-Site VPN Overview.

If you configure at least one tunnel to use static routing, then in the request you must provide at least one valid static route (you're allowed a maximum of 10). For example: 10.0.0.0/16. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes. For more information, see the important note in IPSecConnection.

For the purposes of access control, you must provide the OCID of the compartment where you want the IPSec connection to reside. Notice that the IPSec connection doesn't have to be in the same compartment as the DRG, CPE, or other Networking Service components. If you're not sure which compartment to use, put the IPSec connection in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service.

You may optionally specify a display name for the IPSec connection, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

After creating the IPSec connection, you need to configure your on-premises router with tunnel-specific information. For tunnel status and the required configuration information, see:

  • IPSecConnectionTunnel

  • IPSecConnectionTunnelSharedSecret

For each tunnel, you need the IP address of Oracle's VPN headend and the shared secret (that is, the pre-shared key). For more information, see CPE Configuration.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
 
# File 'lib/oci/core/virtual_network_client.rb', line 4056

def create_ip_sec_connection(create_ip_sec_connection_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_ip_sec_connection.' if logger

  raise "Missing the required parameter 'create_ip_sec_connection_details' when calling create_ip_sec_connection." if create_ip_sec_connection_details.nil?

  path = '/ipsecConnections'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_ip_sec_connection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_ip_sec_connection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IPSecConnection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_ipv6(create_ipv6_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_ipv6 API.

Creates an IPv6 for the specified VNIC.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
 
# File 'lib/oci/core/virtual_network_client.rb', line 4119

def create_ipv6(create_ipv6_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_ipv6.' if logger

  raise "Missing the required parameter 'create_ipv6_details' when calling create_ipv6." if create_ipv6_details.nil?

  path = '/ipv6'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_ipv6_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_ipv6') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Ipv6'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_local_peering_gateway(create_local_peering_gateway_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_local_peering_gateway API.

Creates a new local peering gateway (LPG) for the specified VCN.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
 
# File 'lib/oci/core/virtual_network_client.rb', line 4180

def create_local_peering_gateway(create_local_peering_gateway_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_local_peering_gateway.' if logger

  raise "Missing the required parameter 'create_local_peering_gateway_details' when calling create_local_peering_gateway." if create_local_peering_gateway_details.nil?

  path = '/localPeeringGateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_local_peering_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_local_peering_gateway') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::LocalPeeringGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_nat_gateway(create_nat_gateway_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_nat_gateway API.

Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the NAT gateway as the rule's target. See RouteTable.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
 
# File 'lib/oci/core/virtual_network_client.rb', line 4241

def create_nat_gateway(create_nat_gateway_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_nat_gateway.' if logger

  raise "Missing the required parameter 'create_nat_gateway_details' when calling create_nat_gateway." if create_nat_gateway_details.nil?

  path = '/natGateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_nat_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_nat_gateway') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::NatGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_network_security_group(create_network_security_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_network_security_group API.

Creates a new network security group for the specified VCN.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
 
# File 'lib/oci/core/virtual_network_client.rb', line 4301

def create_network_security_group(create_network_security_group_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_network_security_group.' if logger

  raise "Missing the required parameter 'create_network_security_group_details' when calling create_network_security_group." if create_network_security_group_details.nil?

  path = '/networkSecurityGroups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_network_security_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_network_security_group') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::NetworkSecurityGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_private_ip(create_private_ip_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_private_ip API.

Creates a private IP. For more information about private IPs, see IP Addresses.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
 
# File 'lib/oci/core/virtual_network_client.rb', line 4363

def create_private_ip(create_private_ip_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_private_ip.' if logger

  raise "Missing the required parameter 'create_private_ip_details' when calling create_private_ip." if create_private_ip_details.nil?

  path = '/privateIps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_private_ip_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_private_ip') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PrivateIp'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_public_ip(create_public_ip_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_public_ip API.

Creates a public IP. Use the lifetime property to specify whether it's an ephemeral or reserved public IP. For information about limits on how many you can create, see Public IP Addresses.

  • For an ephemeral public IP assigned to a private IP: You must also specify a privateIpId with the OCID of the primary private IP you want to assign the public IP to. The public IP is created in the same availability domain as the private IP. An ephemeral public IP must always be assigned to a private IP, and only to the primary private IP on a VNIC, not a secondary private IP. Exception: If you create a NatGateway, Oracle automatically assigns the NAT gateway a regional ephemeral public IP that you cannot remove.

  • For a reserved public IP: You may also optionally assign the public IP to a private IP by specifying privateIpId. Or you can later assign the public IP with update_public_ip.

Note: When assigning a public IP to a private IP, the private IP must not already have a public IP with lifecycleState = ASSIGNING or ASSIGNED. If it does, an error is returned.

Also, for reserved public IPs, the optional assignment part of this operation is asynchronous. Poll the public IP's lifecycleState to determine if the assignment succeeded.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
 
# File 'lib/oci/core/virtual_network_client.rb', line 4443

def create_public_ip(create_public_ip_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_public_ip.' if logger

  raise "Missing the required parameter 'create_public_ip_details' when calling create_public_ip." if create_public_ip_details.nil?

  path = '/publicIps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_public_ip_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_public_ip') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PublicIp'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_public_ip_pool(create_public_ip_pool_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_public_ip_pool API.

Creates a public IP pool.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
 
# File 'lib/oci/core/virtual_network_client.rb', line 4506

def create_public_ip_pool(create_public_ip_pool_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_public_ip_pool.' if logger

  raise "Missing the required parameter 'create_public_ip_pool_details' when calling create_public_ip_pool." if create_public_ip_pool_details.nil?

  path = '/publicIpPools'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_public_ip_pool_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_public_ip_pool') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PublicIpPool'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_remote_peering_connection(create_remote_peering_connection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_remote_peering_connection API.

Creates a new remote peering connection (RPC) for the specified DRG.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
 
# File 'lib/oci/core/virtual_network_client.rb', line 4567

def create_remote_peering_connection(create_remote_peering_connection_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_remote_peering_connection.' if logger

  raise "Missing the required parameter 'create_remote_peering_connection_details' when calling create_remote_peering_connection." if create_remote_peering_connection_details.nil?

  path = '/remotePeeringConnections'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_remote_peering_connection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_remote_peering_connection') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::RemotePeeringConnection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_route_table(create_route_table_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_route_table API.

Creates a new route table for the specified VCN. In the request you must also include at least one route rule for the new route table. For information on the number of rules you can have in a route table, see Service Limits. For general information about route tables in your VCN and the types of targets you can use in route rules, see Route Tables.

For the purposes of access control, you must provide the OCID of the compartment where you want the route table to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the route table in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the route table, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
 
# File 'lib/oci/core/virtual_network_client.rb', line 4641

def create_route_table(create_route_table_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_route_table.' if logger

  raise "Missing the required parameter 'create_route_table_details' when calling create_route_table." if create_route_table_details.nil?

  path = '/routeTables'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_route_table_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_route_table') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::RouteTable'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_security_list(create_security_list_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_security_list API.

Creates a new security list for the specified VCN. For more information about security lists, see Security Lists. For information on the number of rules you can have in a security list, see Service Limits.

For the purposes of access control, you must provide the OCID of the compartment where you want the security list to reside. Notice that the security list doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the security list in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the security list, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
 
# File 'lib/oci/core/virtual_network_client.rb', line 4714

def create_security_list(create_security_list_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_security_list.' if logger

  raise "Missing the required parameter 'create_security_list_details' when calling create_security_list." if create_security_list_details.nil?

  path = '/securityLists'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_security_list_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_security_list') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::SecurityList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_service_gateway(create_service_gateway_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_service_gateway API.

Creates a new service gateway in the specified compartment.

For the purposes of access control, you must provide the OCID of the compartment where you want the service gateway to reside. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the service gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

Use the list_services operation to find service CIDR labels available in the region.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
 
# File 'lib/oci/core/virtual_network_client.rb', line 4785

def create_service_gateway(create_service_gateway_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_service_gateway.' if logger

  raise "Missing the required parameter 'create_service_gateway_details' when calling create_service_gateway." if create_service_gateway_details.nil?

  path = '/serviceGateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_service_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_service_gateway') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::ServiceGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_subnet(create_subnet_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_subnet API.

Creates a new subnet in the specified VCN. You can't change the size of the subnet after creation, so it's important to think about the size of subnets you need before creating them. For more information, see VCNs and Subnets. For information on the number of subnets you can have in a VCN, see Service Limits.

For the purposes of access control, you must provide the OCID of the compartment where you want the subnet to reside. Notice that the subnet doesn't have to be in the same compartment as the VCN, route tables, or other Networking Service components. If you're not sure which compartment to use, put the subnet in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally associate a route table with the subnet. If you don't, the subnet will use the VCN's default route table. For more information about route tables, see Route Tables.

You may optionally associate a security list with the subnet. If you don't, the subnet will use the VCN's default security list. For more information about security lists, see Security Lists.

You may optionally associate a set of DHCP options with the subnet. If you don't, the subnet will use the VCN's default set. For more information about DHCP options, see DHCP Options.

You may optionally specify a display name for the subnet, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

You can also add a DNS label for the subnet, which is required if you want the Internet and VCN Resolver to resolve hostnames for instances in the subnet. For more information, see DNS in Your Virtual Cloud Network.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
 
# File 'lib/oci/core/virtual_network_client.rb', line 4875

def create_subnet(create_subnet_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_subnet.' if logger

  raise "Missing the required parameter 'create_subnet_details' when calling create_subnet." if create_subnet_details.nil?

  path = '/subnets'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_subnet_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_subnet') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Subnet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_vcn(create_vcn_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_vcn API.

Creates a new virtual cloud network (VCN). For more information, see VCNs and Subnets.

For the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria:

  • The CIDR blocks must be valid.

  • They must not overlap with each other or with the on-premises network CIDR block.

  • The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN.

For a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in RFC 1918 (10.0.0.0/8, 172.16/12, and 192.168/16). Example: 172.16.0.0/16. The CIDR blocks can range from /16 to /30.

For the purposes of access control, you must provide the OCID of the compartment where you want the VCN to reside. Consult an Oracle Cloud Infrastructure administrator in your organization if you're not sure which compartment to use. Notice that the VCN doesn't have to be in the same compartment as the subnets or other Networking Service components. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the VCN, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

You can also add a DNS label for the VCN, which is required if you want the instances to use the Interent and VCN Resolver option for DNS in the VCN. For more information, see DNS in Your Virtual Cloud Network.

The VCN automatically comes with a default route table, default security list, and default set of DHCP options. The OCID for each is returned in the response. You can't delete these default objects, but you can change their contents (that is, change the route rules, security list rules, and so on).

The VCN and subnets you create are not accessible until you attach an internet gateway or set up a Site-to-Site VPN or FastConnect. For more information, see Overview of the Networking Service.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type Vcn



4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
 
# File 'lib/oci/core/virtual_network_client.rb', line 4967

def create_vcn(create_vcn_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_vcn.' if logger

  raise "Missing the required parameter 'create_vcn_details' when calling create_vcn." if create_vcn_details.nil?

  path = '/vcns'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_vcn_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_vcn') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Vcn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_virtual_circuit(create_virtual_circuit_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_virtual_circuit API.

Creates a new virtual circuit to use with Oracle Cloud Infrastructure FastConnect. For more information, see FastConnect Overview.

For the purposes of access control, you must provide the OCID of the compartment where you want the virtual circuit to reside. If you're not sure which compartment to use, put the virtual circuit in the same compartment with the DRG it's using. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the virtual circuit. It does not have to be unique, and you can change it. Avoid entering confidential information.

Important: When creating a virtual circuit, you specify a DRG for the traffic to flow through. Make sure you attach the DRG to your VCN and confirm the VCN's routing sends traffic to the DRG. Otherwise traffic will not flow. For more information, see Route Tables.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
 
# File 'lib/oci/core/virtual_network_client.rb', line 5047

def create_virtual_circuit(create_virtual_circuit_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_virtual_circuit.' if logger

  raise "Missing the required parameter 'create_virtual_circuit_details' when calling create_virtual_circuit." if create_virtual_circuit_details.nil?

  path = '/virtualCircuits'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_virtual_circuit_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_virtual_circuit') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::VirtualCircuit'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_vlan(create_vlan_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_vlan API.

Creates a VLAN in the specified VCN and the specified compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
 
# File 'lib/oci/core/virtual_network_client.rb', line 5110

def create_vlan(create_vlan_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_vlan.' if logger

  raise "Missing the required parameter 'create_vlan_details' when calling create_vlan." if create_vlan_details.nil?

  path = '/vlans'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_vlan_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_vlan') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Vlan'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_vtap(create_vtap_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_vtap API.

Creates a virtual test access point (VTAP) in the specified compartment.

For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
 
# File 'lib/oci/core/virtual_network_client.rb', line 5182

def create_vtap(create_vtap_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#create_vtap.' if logger

  raise "Missing the required parameter 'create_vtap_details' when calling create_vtap." if create_vtap_details.nil?

  path = '/vtaps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_vtap_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_vtap') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Vtap'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_byoasn(byoasn_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_byoasn API.

Deletes the specified Byoasn resource. The resource must be in one of the following states: CREATING, ACTIVE or FAILED. It must not be in use by any of the byoipRanges or deletion will fail. You must specify the OCID.

Parameters:

  • byoasn_id (String) —

    The OCID of the Byoasn resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
 
# File 'lib/oci/core/virtual_network_client.rb', line 5247

def delete_byoasn(byoasn_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_byoasn.' if logger

  raise "Missing the required parameter 'byoasn_id' when calling delete_byoasn." if byoasn_id.nil?
  raise "Parameter value for 'byoasn_id' must not be blank" if OCI::Internal::Util.blank_string?(byoasn_id)

  path = '/byoasns/{byoasnId}'.sub('{byoasnId}', byoasn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_byoasn') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_byoip_range(byoip_range_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_byoip_range API.

Deletes the specified ByoipRange resource. The resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED. It must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail. You must specify the OCID. If the ByoipRange resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted.

Parameters:

  • byoip_range_id (String) —

    The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
 
# File 'lib/oci/core/virtual_network_client.rb', line 5312

def delete_byoip_range(byoip_range_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_byoip_range.' if logger

  raise "Missing the required parameter 'byoip_range_id' when calling delete_byoip_range." if byoip_range_id.nil?
  raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id)

  path = '/byoipRanges/{byoipRangeId}'.sub('{byoipRangeId}', byoip_range_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_byoip_range') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_capture_filter(capture_filter_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_capture_filter API.

Deletes the specified VTAP capture filter. This is an asynchronous operation. The VTAP capture filter's lifecycleState will change to TERMINATING temporarily until the VTAP capture filter is completely removed.

Parameters:

  • capture_filter_id (String) —

    The OCID of the capture filter.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
 
# File 'lib/oci/core/virtual_network_client.rb', line 5374

def delete_capture_filter(capture_filter_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_capture_filter.' if logger

  raise "Missing the required parameter 'capture_filter_id' when calling delete_capture_filter." if capture_filter_id.nil?
  raise "Parameter value for 'capture_filter_id' must not be blank" if OCI::Internal::Util.blank_string?(capture_filter_id)

  path = '/captureFilters/{captureFilterId}'.sub('{captureFilterId}', capture_filter_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_capture_filter') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_cpe(cpe_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_cpe API.

Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous operation. The CPE's lifecycleState will change to TERMINATING temporarily until the CPE is completely removed.

Parameters:

  • cpe_id (String) —

    The OCID of the CPE.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
 
# File 'lib/oci/core/virtual_network_client.rb', line 5434

def delete_cpe(cpe_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_cpe.' if logger

  raise "Missing the required parameter 'cpe_id' when calling delete_cpe." if cpe_id.nil?
  raise "Parameter value for 'cpe_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_id)

  path = '/cpes/{cpeId}'.sub('{cpeId}', cpe_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_cpe') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_cross_connect(cross_connect_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_cross_connect API.

Deletes the specified cross-connect. It must not be mapped to a VirtualCircuit.

Parameters:

  • cross_connect_id (String) —

    The OCID of the cross-connect.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
 
# File 'lib/oci/core/virtual_network_client.rb', line 5492

def delete_cross_connect(cross_connect_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_cross_connect.' if logger

  raise "Missing the required parameter 'cross_connect_id' when calling delete_cross_connect." if cross_connect_id.nil?
  raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id)

  path = '/crossConnects/{crossConnectId}'.sub('{crossConnectId}', cross_connect_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_cross_connect') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_cross_connect_group(cross_connect_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_cross_connect_group API.

Deletes the specified cross-connect group. It must not contain any cross-connects, and it cannot be mapped to a VirtualCircuit.

Parameters:

  • cross_connect_group_id (String) —

    The OCID of the cross-connect group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
 
# File 'lib/oci/core/virtual_network_client.rb', line 5551

def delete_cross_connect_group(cross_connect_group_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_cross_connect_group.' if logger

  raise "Missing the required parameter 'cross_connect_group_id' when calling delete_cross_connect_group." if cross_connect_group_id.nil?
  raise "Parameter value for 'cross_connect_group_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_group_id)

  path = '/crossConnectGroups/{crossConnectGroupId}'.sub('{crossConnectGroupId}', cross_connect_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_cross_connect_group') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_dhcp_options(dhcp_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_dhcp_options API.

Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a VCN's default set of DHCP options.

This is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily until the set is completely removed.

Parameters:

  • dhcp_id (String) —

    The OCID for the set of DHCP options.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
 
# File 'lib/oci/core/virtual_network_client.rb', line 5612

def delete_dhcp_options(dhcp_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_dhcp_options.' if logger

  raise "Missing the required parameter 'dhcp_id' when calling delete_dhcp_options." if dhcp_id.nil?
  raise "Parameter value for 'dhcp_id' must not be blank" if OCI::Internal::Util.blank_string?(dhcp_id)

  path = '/dhcps/{dhcpId}'.sub('{dhcpId}', dhcp_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_dhcp_options') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_drg(drg_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_drg API.

Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise network. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous operation. The DRG's lifecycleState will change to TERMINATING temporarily until the DRG is completely removed.

Parameters:

  • drg_id (String) —

    The OCID of the DRG.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
 
# File 'lib/oci/core/virtual_network_client.rb', line 5672

def delete_drg(drg_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_drg.' if logger

  raise "Missing the required parameter 'drg_id' when calling delete_drg." if drg_id.nil?
  raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id)

  path = '/drgs/{drgId}'.sub('{drgId}', drg_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_drg') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_drg_attachment(drg_attachment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_drg_attachment API.

Detaches a DRG from a network resource by deleting the corresponding DrgAttachment resource. This is an asynchronous operation. The attachment's lifecycleState will temporarily change to DETACHING until the attachment is completely removed.

Parameters:

  • drg_attachment_id (String) —

    The OCID of the DRG attachment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
 
# File 'lib/oci/core/virtual_network_client.rb', line 5731

def delete_drg_attachment(drg_attachment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_drg_attachment.' if logger

  raise "Missing the required parameter 'drg_attachment_id' when calling delete_drg_attachment." if drg_attachment_id.nil?
  raise "Parameter value for 'drg_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_attachment_id)

  path = '/drgAttachments/{drgAttachmentId}'.sub('{drgAttachmentId}', drg_attachment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_drg_attachment') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_drg_route_distribution(drg_route_distribution_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_drg_route_distribution API.

Deletes the specified route distribution. You can't delete a route distribution currently in use by a DRG attachment or DRG route table.

Remove the DRG route distribution from a DRG attachment or DRG route table by using the "RemoveExportDrgRouteDistribution" or "RemoveImportDrgRouteDistribution' operations.

Parameters:

  • drg_route_distribution_id (String) —

    The OCID of the route distribution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
 
# File 'lib/oci/core/virtual_network_client.rb', line 5790

def delete_drg_route_distribution(drg_route_distribution_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_drg_route_distribution.' if logger

  raise "Missing the required parameter 'drg_route_distribution_id' when calling delete_drg_route_distribution." if drg_route_distribution_id.nil?
  raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id)

  path = '/drgRouteDistributions/{drgRouteDistributionId}'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_drg_route_distribution') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_drg_route_table(drg_route_table_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_drg_route_table API.

Deletes the specified DRG route table. There must not be any DRG attachments assigned.

Parameters:

  • drg_route_table_id (String) —

    The OCID of the DRG route table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
 
# File 'lib/oci/core/virtual_network_client.rb', line 5847

def delete_drg_route_table(drg_route_table_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_drg_route_table.' if logger

  raise "Missing the required parameter 'drg_route_table_id' when calling delete_drg_route_table." if drg_route_table_id.nil?
  raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id)

  path = '/drgRouteTables/{drgRouteTableId}'.sub('{drgRouteTableId}', drg_route_table_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_drg_route_table') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_internet_gateway(ig_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_internet_gateway API.

Deletes the specified internet gateway. The internet gateway does not have to be disabled, but there must not be a route table that lists it as a target.

This is an asynchronous operation. The gateway's lifecycleState will change to TERMINATING temporarily until the gateway is completely removed.

Parameters:

  • ig_id (String) —

    The OCID of the internet gateway.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
 
# File 'lib/oci/core/virtual_network_client.rb', line 5908

def delete_internet_gateway(ig_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_internet_gateway.' if logger

  raise "Missing the required parameter 'ig_id' when calling delete_internet_gateway." if ig_id.nil?
  raise "Parameter value for 'ig_id' must not be blank" if OCI::Internal::Util.blank_string?(ig_id)

  path = '/internetGateways/{igId}'.sub('{igId}', ig_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_internet_gateway') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_ip_sec_connection(ipsc_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_ip_sec_connection API.

Deletes the specified IPSec connection. If your goal is to disable the Site-to-Site VPN between your VCN and on-premises network, it's easiest to simply detach the DRG but keep all the Site-to-Site VPN components intact. If you were to delete all the components and then later need to create an Site-to-Site VPN again, you would need to configure your on-premises router again with the new information returned from create_ip_sec_connection.

This is an asynchronous operation. The connection's lifecycleState will change to TERMINATING temporarily until the connection is completely removed.

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
 
# File 'lib/oci/core/virtual_network_client.rb', line 5972

def delete_ip_sec_connection(ipsc_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_ip_sec_connection.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling delete_ip_sec_connection." if ipsc_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)

  path = '/ipsecConnections/{ipscId}'.sub('{ipscId}', ipsc_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_ip_sec_connection') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_ipv6(ipv6_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_ipv6 API.

Unassigns and deletes the specified IPv6. You must specify the object's OCID. The IPv6 address is returned to the subnet's pool of available addresses.

Parameters:

  • ipv6_id (String) —

    The OCID of the IPv6.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
 
# File 'lib/oci/core/virtual_network_client.rb', line 6033

def delete_ipv6(ipv6_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_ipv6.' if logger

  raise "Missing the required parameter 'ipv6_id' when calling delete_ipv6." if ipv6_id.nil?
  raise "Parameter value for 'ipv6_id' must not be blank" if OCI::Internal::Util.blank_string?(ipv6_id)

  path = '/ipv6/{ipv6Id}'.sub('{ipv6Id}', ipv6_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_ipv6') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_local_peering_gateway(local_peering_gateway_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_local_peering_gateway API.

Deletes the specified local peering gateway (LPG).

This is an asynchronous operation; the local peering gateway's lifecycleState changes to TERMINATING temporarily until the local peering gateway is completely removed.

Parameters:

  • local_peering_gateway_id (String) —

    The OCID of the local peering gateway.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
 
# File 'lib/oci/core/virtual_network_client.rb', line 6094

def delete_local_peering_gateway(local_peering_gateway_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_local_peering_gateway.' if logger

  raise "Missing the required parameter 'local_peering_gateway_id' when calling delete_local_peering_gateway." if local_peering_gateway_id.nil?
  raise "Parameter value for 'local_peering_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(local_peering_gateway_id)

  path = '/localPeeringGateways/{localPeeringGatewayId}'.sub('{localPeeringGatewayId}', local_peering_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_local_peering_gateway') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_nat_gateway(nat_gateway_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_nat_gateway API.

Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there must not be a route rule that lists the NAT gateway as a target.

This is an asynchronous operation. The NAT gateway's lifecycleState will change to TERMINATING temporarily until the NAT gateway is completely removed.

Parameters:

  • nat_gateway_id (String) —

    The NAT gateway's OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
 
# File 'lib/oci/core/virtual_network_client.rb', line 6155

def delete_nat_gateway(nat_gateway_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_nat_gateway.' if logger

  raise "Missing the required parameter 'nat_gateway_id' when calling delete_nat_gateway." if nat_gateway_id.nil?
  raise "Parameter value for 'nat_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(nat_gateway_id)

  path = '/natGateways/{natGatewayId}'.sub('{natGatewayId}', nat_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_nat_gateway') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_network_security_group(network_security_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_network_security_group API.

Deletes the specified network security group. The group must not contain any VNICs.

To get a list of the VNICs in a network security group, use #list_network_security_group_vnics list_network_security_group_vnics}. Each returned NetworkSecurityGroupVnic object contains both the {OCID of the VNIC and the OCID of the VNIC's parent resource (for example, the Compute instance that the VNIC is attached to).

Parameters:

  • network_security_group_id (String) —

    The OCID of the network security group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
 
# File 'lib/oci/core/virtual_network_client.rb', line 6218

def delete_network_security_group(network_security_group_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_network_security_group.' if logger

  raise "Missing the required parameter 'network_security_group_id' when calling delete_network_security_group." if network_security_group_id.nil?
  raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id)

  path = '/networkSecurityGroups/{networkSecurityGroupId}'.sub('{networkSecurityGroupId}', network_security_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_network_security_group') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_private_ip(private_ip_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_private_ip API.

Unassigns and deletes the specified private IP. You must specify the object's OCID. The private IP address is returned to the subnet's pool of available addresses.

This operation cannot be used with primary private IPs, which are automatically unassigned and deleted when the VNIC is terminated.

Important: If a secondary private IP is the target of a route rule, unassigning it from the VNIC causes that route rule to blackhole and the traffic will be dropped.

Parameters:

  • private_ip_id (String) —

    The OCID of the private IP or IPv6.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
 
# File 'lib/oci/core/virtual_network_client.rb', line 6285

def delete_private_ip(private_ip_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_private_ip.' if logger

  raise "Missing the required parameter 'private_ip_id' when calling delete_private_ip." if private_ip_id.nil?
  raise "Parameter value for 'private_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(private_ip_id)

  path = '/privateIps/{privateIpId}'.sub('{privateIpId}', private_ip_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_private_ip') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_public_ip(public_ip_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_public_ip API.

Unassigns and deletes the specified public IP (either ephemeral or reserved). You must specify the object's OCID. The public IP address is returned to the Oracle Cloud Infrastructure public IP pool.

Note: You cannot update, unassign, or delete the public IP that Oracle automatically assigned to an entity for you (such as a load balancer or NAT gateway). The public IP is automatically deleted if the assigned entity is terminated.

For an assigned reserved public IP, the initial unassignment portion of this operation is asynchronous. Poll the public IP's lifecycleState to determine if the operation succeeded.

If you want to simply unassign a reserved public IP and return it to your pool of reserved public IPs, instead use update_public_ip.

Parameters:

  • public_ip_id (String) —

    The OCID of the public IP.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
 
# File 'lib/oci/core/virtual_network_client.rb', line 6356

def delete_public_ip(public_ip_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_public_ip.' if logger

  raise "Missing the required parameter 'public_ip_id' when calling delete_public_ip." if public_ip_id.nil?
  raise "Parameter value for 'public_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_id)

  path = '/publicIps/{publicIpId}'.sub('{publicIpId}', public_ip_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_public_ip') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_public_ip_pool(public_ip_pool_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_public_ip_pool API.

Deletes the specified public IP pool. To delete a public IP pool it must not have any active IP address allocations. You must specify the object's OCID when deleting an IP pool.

Parameters:

  • public_ip_pool_id (String) —

    The OCID of the public IP pool.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
 
# File 'lib/oci/core/virtual_network_client.rb', line 6418

def delete_public_ip_pool(public_ip_pool_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_public_ip_pool.' if logger

  raise "Missing the required parameter 'public_ip_pool_id' when calling delete_public_ip_pool." if public_ip_pool_id.nil?
  raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id)

  path = '/publicIpPools/{publicIpPoolId}'.sub('{publicIpPoolId}', public_ip_pool_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_public_ip_pool') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_remote_peering_connection(remote_peering_connection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_remote_peering_connection API.

Deletes the remote peering connection (RPC).

This is an asynchronous operation; the RPC's lifecycleState changes to TERMINATING temporarily until the RPC is completely removed.

Parameters:

  • remote_peering_connection_id (String) —

    The OCID of the remote peering connection (RPC).

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
 
# File 'lib/oci/core/virtual_network_client.rb', line 6479

def delete_remote_peering_connection(remote_peering_connection_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_remote_peering_connection.' if logger

  raise "Missing the required parameter 'remote_peering_connection_id' when calling delete_remote_peering_connection." if remote_peering_connection_id.nil?
  raise "Parameter value for 'remote_peering_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(remote_peering_connection_id)

  path = '/remotePeeringConnections/{remotePeeringConnectionId}'.sub('{remotePeeringConnectionId}', remote_peering_connection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_remote_peering_connection') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_route_table(rt_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_route_table API.

Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a VCN's default route table.

This is an asynchronous operation. The route table's lifecycleState will change to TERMINATING temporarily until the route table is completely removed.

Parameters:

  • rt_id (String) —

    The OCID of the route table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
 
# File 'lib/oci/core/virtual_network_client.rb', line 6540

def delete_route_table(rt_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_route_table.' if logger

  raise "Missing the required parameter 'rt_id' when calling delete_route_table." if rt_id.nil?
  raise "Parameter value for 'rt_id' must not be blank" if OCI::Internal::Util.blank_string?(rt_id)

  path = '/routeTables/{rtId}'.sub('{rtId}', rt_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_route_table') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_security_list(security_list_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_security_list API.

Deletes the specified security list, but only if it's not associated with a subnet. You can't delete a VCN's default security list.

This is an asynchronous operation. The security list's lifecycleState will change to TERMINATING temporarily until the security list is completely removed.

Parameters:

  • security_list_id (String) —

    The OCID of the security list.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
 
# File 'lib/oci/core/virtual_network_client.rb', line 6601

def delete_security_list(security_list_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_security_list.' if logger

  raise "Missing the required parameter 'security_list_id' when calling delete_security_list." if security_list_id.nil?
  raise "Parameter value for 'security_list_id' must not be blank" if OCI::Internal::Util.blank_string?(security_list_id)

  path = '/securityLists/{securityListId}'.sub('{securityListId}', security_list_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_security_list') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_service_gateway(service_gateway_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_service_gateway API.

Deletes the specified service gateway. There must not be a route table that lists the service gateway as a target.

Parameters:

  • service_gateway_id (String) —

    The service gateway's OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
 
# File 'lib/oci/core/virtual_network_client.rb', line 6659

def delete_service_gateway(service_gateway_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_service_gateway.' if logger

  raise "Missing the required parameter 'service_gateway_id' when calling delete_service_gateway." if service_gateway_id.nil?
  raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id)

  path = '/serviceGateways/{serviceGatewayId}'.sub('{serviceGatewayId}', service_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_service_gateway') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_subnet(subnet_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_subnet API.

Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous operation. The subnet's lifecycleState will change to TERMINATING temporarily. If there are any instances in the subnet, the state will instead change back to AVAILABLE.

Parameters:

  • subnet_id (String) —

    Specify the OCID of the subnet.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
 
# File 'lib/oci/core/virtual_network_client.rb', line 6718

def delete_subnet(subnet_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_subnet.' if logger

  raise "Missing the required parameter 'subnet_id' when calling delete_subnet." if subnet_id.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/subnets/{subnetId}'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_subnet') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_vcn(vcn_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_vcn API.

Deletes the specified VCN. The VCN must be completely empty and have no attached gateways. This is an asynchronous operation.

A deleted VCN's lifecycleState changes to TERMINATING and then TERMINATED temporarily until the VCN is completely removed. A completely removed VCN does not appear in the results of a ListVcns operation and can't be used in a GetVcn operation.

Parameters:

  • vcn_id (String) —

    Specify the OCID of the VCN.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
 
# File 'lib/oci/core/virtual_network_client.rb', line 6780

def delete_vcn(vcn_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_vcn.' if logger

  raise "Missing the required parameter 'vcn_id' when calling delete_vcn." if vcn_id.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/vcns/{vcnId}'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_vcn') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_virtual_circuit(virtual_circuit_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_virtual_circuit API.

Deletes the specified virtual circuit.

Important: If you're using FastConnect via a provider, make sure to also terminate the connection with the provider, or else the provider may continue to bill you.

Parameters:

  • virtual_circuit_id (String) —

    The OCID of the virtual circuit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
 
# File 'lib/oci/core/virtual_network_client.rb', line 6841

def delete_virtual_circuit(virtual_circuit_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_virtual_circuit.' if logger

  raise "Missing the required parameter 'virtual_circuit_id' when calling delete_virtual_circuit." if virtual_circuit_id.nil?
  raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id)

  path = '/virtualCircuits/{virtualCircuitId}'.sub('{virtualCircuitId}', virtual_circuit_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_virtual_circuit') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_vlan(vlan_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_vlan API.

Deletes the specified VLAN, but only if there are no VNICs in the VLAN.

Parameters:

  • vlan_id (String) —

    The OCID of the VLAN.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
 
# File 'lib/oci/core/virtual_network_client.rb', line 6901

def delete_vlan(vlan_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_vlan.' if logger

  raise "Missing the required parameter 'vlan_id' when calling delete_vlan." if vlan_id.nil?
  raise "Parameter value for 'vlan_id' must not be blank" if OCI::Internal::Util.blank_string?(vlan_id)

  path = '/vlans/{vlanId}'.sub('{vlanId}', vlan_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_vlan') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_vtap(vtap_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_vtap API.

Deletes the specified VTAP. This is an asynchronous operation. The VTAP's lifecycleState will change to TERMINATING temporarily until the VTAP is completely removed.

Parameters:

  • vtap_id (String) —

    The OCID of the VTAP.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
 
# File 'lib/oci/core/virtual_network_client.rb', line 6963

def delete_vtap(vtap_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#delete_vtap.' if logger

  raise "Missing the required parameter 'vtap_id' when calling delete_vtap." if vtap_id.nil?
  raise "Parameter value for 'vtap_id' must not be blank" if OCI::Internal::Util.blank_string?(vtap_id)

  path = '/vtaps/{vtapId}'.sub('{vtapId}', vtap_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_vtap') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#detach_service_id(service_gateway_id, detach_service_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use detach_service_id API.

Removes the specified Service from the list of enabled Service objects for the specified gateway. You do not need to remove any route rules that specify this Service object's cidrBlock as the destination CIDR. However, consider removing the rules if your intent is to permanently disable use of the Service through this service gateway.

Note: The DetachServiceId operation is an easy way to remove an individual Service from the service gateway. Compare it with update_service_gateway, which replaces the entire existing list of enabled Service objects with the list that you provide in the Update call. UpdateServiceGateway also lets you block all traffic through the service gateway without having to remove each of the individual Service objects.

Parameters:

  • service_gateway_id (String) —

    The service gateway's OCID.

  • detach_service_details (OCI::Core::Models::ServiceIdRequestDetails) —

    ServiceId of Service to be detached from a service gateway.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
 
# File 'lib/oci/core/virtual_network_client.rb', line 7033

def detach_service_id(service_gateway_id, detach_service_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#detach_service_id.' if logger

  raise "Missing the required parameter 'service_gateway_id' when calling detach_service_id." if service_gateway_id.nil?
  raise "Missing the required parameter 'detach_service_details' when calling detach_service_id." if detach_service_details.nil?
  raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id)

  path = '/serviceGateways/{serviceGatewayId}/actions/detachService'.sub('{serviceGatewayId}', service_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(detach_service_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#detach_service_id') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::ServiceGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_all_drg_attachments(drg_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_all_drg_attachments API.

Returns a complete list of DRG attachments that belong to a particular DRG.

Parameters:

  • drg_id (String) —

    The OCID of the DRG.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :attachment_type (String) —

    The type for the network resource attached to the DRG. (default to VCN) Allowed values are: VCN, VIRTUAL_CIRCUIT, REMOTE_PEERING_CONNECTION, IPSEC_TUNNEL, ALL

  • :is_cross_tenancy (BOOLEAN) —

    Whether the DRG attachment lives in a different tenancy than the DRG. (default to false)

Returns:



7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
 
# File 'lib/oci/core/virtual_network_client.rb', line 7104

def get_all_drg_attachments(drg_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_all_drg_attachments.' if logger

  raise "Missing the required parameter 'drg_id' when calling get_all_drg_attachments." if drg_id.nil?

  if opts[:attachment_type] && !%w[VCN VIRTUAL_CIRCUIT REMOTE_PEERING_CONNECTION IPSEC_TUNNEL ALL].include?(opts[:attachment_type])
    raise 'Invalid value for "attachment_type", must be one of VCN, VIRTUAL_CIRCUIT, REMOTE_PEERING_CONNECTION, IPSEC_TUNNEL, ALL.'
  end
  raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id)

  path = '/drgs/{drgId}/actions/getAllDrgAttachments'.sub('{drgId}', drg_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:attachmentType] = opts[:attachment_type] if opts[:attachment_type]
  query_params[:isCrossTenancy] = opts[:is_cross_tenancy] if !opts[:is_cross_tenancy].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_all_drg_attachments') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::DrgAttachmentInfo>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_allowed_ike_ip_sec_parameters(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_allowed_ike_ip_sec_parameters API.

The parameters allowed for IKE IPSec tunnels.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
 
# File 'lib/oci/core/virtual_network_client.rb', line 7168

def get_allowed_ike_ip_sec_parameters(opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_allowed_ike_ip_sec_parameters.' if logger


  path = '/ipsecAlgorithms'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_allowed_ike_ip_sec_parameters') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::AllowedIkeIPSecParameters'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_byoasn(byoasn_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_byoasn API.

Gets the Byoasn resource. You must specify the OCID.

Parameters:

  • byoasn_id (String) —

    The OCID of the Byoasn resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
 
# File 'lib/oci/core/virtual_network_client.rb', line 7223

def get_byoasn(byoasn_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_byoasn.' if logger

  raise "Missing the required parameter 'byoasn_id' when calling get_byoasn." if byoasn_id.nil?
  raise "Parameter value for 'byoasn_id' must not be blank" if OCI::Internal::Util.blank_string?(byoasn_id)

  path = '/byoasns/{byoasnId}'.sub('{byoasnId}', byoasn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_byoasn') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Byoasn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_byoip_range(byoip_range_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_byoip_range API.

Gets the ByoipRange resource. You must specify the OCID.

Parameters:

  • byoip_range_id (String) —

    The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
 
# File 'lib/oci/core/virtual_network_client.rb', line 7280

def get_byoip_range(byoip_range_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_byoip_range.' if logger

  raise "Missing the required parameter 'byoip_range_id' when calling get_byoip_range." if byoip_range_id.nil?
  raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id)

  path = '/byoipRanges/{byoipRangeId}'.sub('{byoipRangeId}', byoip_range_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_byoip_range') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::ByoipRange'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_capture_filter(capture_filter_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_capture_filter API.

Gets information about the specified VTAP capture filter.

Parameters:

  • capture_filter_id (String) —

    The OCID of the capture filter.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
 
# File 'lib/oci/core/virtual_network_client.rb', line 7336

def get_capture_filter(capture_filter_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_capture_filter.' if logger

  raise "Missing the required parameter 'capture_filter_id' when calling get_capture_filter." if capture_filter_id.nil?
  raise "Parameter value for 'capture_filter_id' must not be blank" if OCI::Internal::Util.blank_string?(capture_filter_id)

  path = '/captureFilters/{captureFilterId}'.sub('{captureFilterId}', capture_filter_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_capture_filter') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CaptureFilter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cpe(cpe_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_cpe API.

Gets the specified CPE's information.

Parameters:

  • cpe_id (String) —

    The OCID of the CPE.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:

  • (Response) —

    A Response object with data of type Cpe



7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
 
# File 'lib/oci/core/virtual_network_client.rb', line 7390

def get_cpe(cpe_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_cpe.' if logger

  raise "Missing the required parameter 'cpe_id' when calling get_cpe." if cpe_id.nil?
  raise "Parameter value for 'cpe_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_id)

  path = '/cpes/{cpeId}'.sub('{cpeId}', cpe_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cpe') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Cpe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cpe_device_config_content(cpe_id, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use get_cpe_device_config_content API.

Renders a set of CPE configuration content that can help a network engineer configure the actual CPE device (for example, a hardware router) represented by the specified Cpe object.

The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the Cpe must have the CPE's device type specified by the cpeDeviceShapeId attribute. The content optionally includes answers that the customer provides (see update_tunnel_cpe_device_config), merged with a template of other information specific to the CPE device type.

The operation returns configuration information for all of the IPSecConnection objects that use the specified CPE. Here are similar operations:

Parameters:

  • cpe_id (String) —

    The OCID of the CPE.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
 
# File 'lib/oci/core/virtual_network_client.rb', line 7466

def get_cpe_device_config_content(cpe_id, opts = {}, &block)
  logger.debug 'Calling operation VirtualNetworkClient#get_cpe_device_config_content.' if logger

  raise "Missing the required parameter 'cpe_id' when calling get_cpe_device_config_content." if cpe_id.nil?
  raise "Parameter value for 'cpe_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_id)

  path = '/cpes/{cpeId}/cpeConfigContent'.sub('{cpeId}', cpe_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'text/plain; charset=utf-8'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cpe_device_config_content') do
    if !block.nil?
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cpe_device_shape(cpe_device_shape_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_cpe_device_shape API.

Gets the detailed information about the specified CPE device type. This might include a set of questions that are specific to the particular CPE device type. The customer must supply answers to those questions (see update_tunnel_cpe_device_config). The service merges the answers with a template of other information for the CPE device type. The following operations return the merged content:

Parameters:

  • cpe_device_shape_id (String) —

    The OCID of the CPE device shape.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
 
# File 'lib/oci/core/virtual_network_client.rb', line 7575

def get_cpe_device_shape(cpe_device_shape_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_cpe_device_shape.' if logger

  raise "Missing the required parameter 'cpe_device_shape_id' when calling get_cpe_device_shape." if cpe_device_shape_id.nil?
  raise "Parameter value for 'cpe_device_shape_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_device_shape_id)

  path = '/cpeDeviceShapes/{cpeDeviceShapeId}'.sub('{cpeDeviceShapeId}', cpe_device_shape_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cpe_device_shape') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CpeDeviceShapeDetail'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cross_connect(cross_connect_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_cross_connect API.

Gets the specified cross-connect's information.

Parameters:

  • cross_connect_id (String) —

    The OCID of the cross-connect.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
 
# File 'lib/oci/core/virtual_network_client.rb', line 7629

def get_cross_connect(cross_connect_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_cross_connect.' if logger

  raise "Missing the required parameter 'cross_connect_id' when calling get_cross_connect." if cross_connect_id.nil?
  raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id)

  path = '/crossConnects/{crossConnectId}'.sub('{crossConnectId}', cross_connect_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cross_connect') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CrossConnect'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cross_connect_group(cross_connect_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_cross_connect_group API.

Gets the specified cross-connect group's information.

Parameters:

  • cross_connect_group_id (String) —

    The OCID of the cross-connect group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
 
# File 'lib/oci/core/virtual_network_client.rb', line 7683

def get_cross_connect_group(cross_connect_group_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_cross_connect_group.' if logger

  raise "Missing the required parameter 'cross_connect_group_id' when calling get_cross_connect_group." if cross_connect_group_id.nil?
  raise "Parameter value for 'cross_connect_group_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_group_id)

  path = '/crossConnectGroups/{crossConnectGroupId}'.sub('{crossConnectGroupId}', cross_connect_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cross_connect_group') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CrossConnectGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cross_connect_letter_of_authority(cross_connect_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_cross_connect_letter_of_authority API.

Gets the Letter of Authority for the specified cross-connect.

Parameters:

  • cross_connect_id (String) —

    The OCID of the cross-connect.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
 
# File 'lib/oci/core/virtual_network_client.rb', line 7737

def get_cross_connect_letter_of_authority(cross_connect_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_cross_connect_letter_of_authority.' if logger

  raise "Missing the required parameter 'cross_connect_id' when calling get_cross_connect_letter_of_authority." if cross_connect_id.nil?
  raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id)

  path = '/crossConnects/{crossConnectId}/letterOfAuthority'.sub('{crossConnectId}', cross_connect_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, text/html'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cross_connect_letter_of_authority') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::LetterOfAuthority'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_cross_connect_status(cross_connect_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_cross_connect_status API.

Gets the status of the specified cross-connect.

Parameters:

  • cross_connect_id (String) —

    The OCID of the cross-connect.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
 
# File 'lib/oci/core/virtual_network_client.rb', line 7792

def get_cross_connect_status(cross_connect_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_cross_connect_status.' if logger

  raise "Missing the required parameter 'cross_connect_id' when calling get_cross_connect_status." if cross_connect_id.nil?
  raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id)

  path = '/crossConnects/{crossConnectId}/status'.sub('{crossConnectId}', cross_connect_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cross_connect_status') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CrossConnectStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_dhcp_options(dhcp_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_dhcp_options API.

Gets the specified set of DHCP options.

Parameters:

  • dhcp_id (String) —

    The OCID for the set of DHCP options.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
 
# File 'lib/oci/core/virtual_network_client.rb', line 7846

def get_dhcp_options(dhcp_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_dhcp_options.' if logger

  raise "Missing the required parameter 'dhcp_id' when calling get_dhcp_options." if dhcp_id.nil?
  raise "Parameter value for 'dhcp_id' must not be blank" if OCI::Internal::Util.blank_string?(dhcp_id)

  path = '/dhcps/{dhcpId}'.sub('{dhcpId}', dhcp_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_dhcp_options') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DhcpOptions'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_drg(drg_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_drg API.

Gets the specified DRG's information.

Parameters:

  • drg_id (String) —

    The OCID of the DRG.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:

  • (Response) —

    A Response object with data of type Drg



7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
 
# File 'lib/oci/core/virtual_network_client.rb', line 7900

def get_drg(drg_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_drg.' if logger

  raise "Missing the required parameter 'drg_id' when calling get_drg." if drg_id.nil?
  raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id)

  path = '/drgs/{drgId}'.sub('{drgId}', drg_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_drg') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Drg'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_drg_attachment(drg_attachment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_drg_attachment API.

Gets the DrgAttachment resource.

Parameters:

  • drg_attachment_id (String) —

    The OCID of the DRG attachment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
 
# File 'lib/oci/core/virtual_network_client.rb', line 7954

def get_drg_attachment(drg_attachment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_drg_attachment.' if logger

  raise "Missing the required parameter 'drg_attachment_id' when calling get_drg_attachment." if drg_attachment_id.nil?
  raise "Parameter value for 'drg_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_attachment_id)

  path = '/drgAttachments/{drgAttachmentId}'.sub('{drgAttachmentId}', drg_attachment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_drg_attachment') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgAttachment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_drg_redundancy_status(drg_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_drg_redundancy_status API.

Gets the redundancy status for the specified DRG. For more information, see Redundancy Remedies.

Parameters:

  • drg_id (String) —

    The OCID of the DRG.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
 
# File 'lib/oci/core/virtual_network_client.rb', line 8012

def get_drg_redundancy_status(drg_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_drg_redundancy_status.' if logger

  raise "Missing the required parameter 'drg_id' when calling get_drg_redundancy_status." if drg_id.nil?
  raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id)

  path = '/drgs/{drgId}/redundancyStatus'.sub('{drgId}', drg_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_drg_redundancy_status') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgRedundancyStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_drg_route_distribution(drg_route_distribution_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_drg_route_distribution API.

Gets the specified route distribution's information.

Parameters:

  • drg_route_distribution_id (String) —

    The OCID of the route distribution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
 
# File 'lib/oci/core/virtual_network_client.rb', line 8066

def get_drg_route_distribution(drg_route_distribution_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_drg_route_distribution.' if logger

  raise "Missing the required parameter 'drg_route_distribution_id' when calling get_drg_route_distribution." if drg_route_distribution_id.nil?
  raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id)

  path = '/drgRouteDistributions/{drgRouteDistributionId}'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_drg_route_distribution') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgRouteDistribution'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_drg_route_table(drg_route_table_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_drg_route_table API.

Gets the specified DRG route table's information.

Parameters:

  • drg_route_table_id (String) —

    The OCID of the DRG route table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
 
# File 'lib/oci/core/virtual_network_client.rb', line 8120

def get_drg_route_table(drg_route_table_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_drg_route_table.' if logger

  raise "Missing the required parameter 'drg_route_table_id' when calling get_drg_route_table." if drg_route_table_id.nil?
  raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id)

  path = '/drgRouteTables/{drgRouteTableId}'.sub('{drgRouteTableId}', drg_route_table_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_drg_route_table') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgRouteTable'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fast_connect_provider_service(provider_service_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_fast_connect_provider_service API.

Gets the specified provider service. For more information, see FastConnect Overview.

Parameters:

  • provider_service_id (String) —

    The OCID of the provider service.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
 
# File 'lib/oci/core/virtual_network_client.rb', line 8176

def get_fast_connect_provider_service(provider_service_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_fast_connect_provider_service.' if logger

  raise "Missing the required parameter 'provider_service_id' when calling get_fast_connect_provider_service." if provider_service_id.nil?
  raise "Parameter value for 'provider_service_id' must not be blank" if OCI::Internal::Util.blank_string?(provider_service_id)

  path = '/fastConnectProviderServices/{providerServiceId}'.sub('{providerServiceId}', provider_service_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_fast_connect_provider_service') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::FastConnectProviderService'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fast_connect_provider_service_key(provider_service_id, provider_service_key_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_fast_connect_provider_service_key API.

Gets the specified provider service key's information. Use this operation to validate a provider service key. An invalid key returns a 404 error.

Parameters:

  • provider_service_id (String) —

    The OCID of the provider service.

  • provider_service_key_name (String) —

    The provider service key that the provider gives you when you set up a virtual circuit connection from the provider to Oracle Cloud Infrastructure. You can set up that connection and get your provider service key at the provider's website or portal. For the portal location, see the description attribute of the FastConnectProviderService.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
 
# File 'lib/oci/core/virtual_network_client.rb', line 8237

def get_fast_connect_provider_service_key(provider_service_id, provider_service_key_name, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_fast_connect_provider_service_key.' if logger

  raise "Missing the required parameter 'provider_service_id' when calling get_fast_connect_provider_service_key." if provider_service_id.nil?
  raise "Missing the required parameter 'provider_service_key_name' when calling get_fast_connect_provider_service_key." if provider_service_key_name.nil?
  raise "Parameter value for 'provider_service_id' must not be blank" if OCI::Internal::Util.blank_string?(provider_service_id)
  raise "Parameter value for 'provider_service_key_name' must not be blank" if OCI::Internal::Util.blank_string?(provider_service_key_name)

  path = '/fastConnectProviderServices/{providerServiceId}/providerServiceKeys/{providerServiceKeyName}'.sub('{providerServiceId}', provider_service_id.to_s).sub('{providerServiceKeyName}', provider_service_key_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_fast_connect_provider_service_key') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::FastConnectProviderServiceKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_internet_gateway(ig_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_internet_gateway API.

Gets the specified internet gateway's information.

Parameters:

  • ig_id (String) —

    The OCID of the internet gateway.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
 
# File 'lib/oci/core/virtual_network_client.rb', line 8293

def get_internet_gateway(ig_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_internet_gateway.' if logger

  raise "Missing the required parameter 'ig_id' when calling get_internet_gateway." if ig_id.nil?
  raise "Parameter value for 'ig_id' must not be blank" if OCI::Internal::Util.blank_string?(ig_id)

  path = '/internetGateways/{igId}'.sub('{igId}', ig_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_internet_gateway') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::InternetGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ip_sec_connection(ipsc_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_ip_sec_connection API.

Gets the specified IPSec connection's basic information, including the static routes for the on-premises router. If you want the status of the connection (whether it's up or down), use get_ip_sec_connection_tunnel.

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
 
# File 'lib/oci/core/virtual_network_client.rb', line 8350

def get_ip_sec_connection(ipsc_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection." if ipsc_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)

  path = '/ipsecConnections/{ipscId}'.sub('{ipscId}', ipsc_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IPSecConnection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ip_sec_connection_device_config(ipsc_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_ip_sec_connection_device_config API.

Deprecated. To get tunnel information, instead use:

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
 
# File 'lib/oci/core/virtual_network_client.rb', line 8408

def get_ip_sec_connection_device_config(ipsc_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection_device_config.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_device_config." if ipsc_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)

  path = '/ipsecConnections/{ipscId}/deviceConfig'.sub('{ipscId}', ipsc_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection_device_config') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IPSecConnectionDeviceConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ip_sec_connection_device_status(ipsc_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_ip_sec_connection_device_status API.

Deprecated. To get the tunnel status, instead use get_ip_sec_connection_tunnel.

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
 
# File 'lib/oci/core/virtual_network_client.rb', line 8464

def get_ip_sec_connection_device_status(ipsc_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection_device_status.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_device_status." if ipsc_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)

  path = '/ipsecConnections/{ipscId}/deviceStatus'.sub('{ipscId}', ipsc_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection_device_status') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IPSecConnectionDeviceStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ip_sec_connection_tunnel(ipsc_id, tunnel_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_ip_sec_connection_tunnel API.

Gets the specified tunnel's information. The resulting object does not include the tunnel's shared secret (pre-shared key). To retrieve that, use get_ip_sec_connection_tunnel_shared_secret.

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • tunnel_id (String) —

    The OCID of the tunnel.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
 
# File 'lib/oci/core/virtual_network_client.rb', line 8522

def get_ip_sec_connection_tunnel(ipsc_id, tunnel_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection_tunnel.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_tunnel." if ipsc_id.nil?
  raise "Missing the required parameter 'tunnel_id' when calling get_ip_sec_connection_tunnel." if tunnel_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)
  raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id)

  path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection_tunnel') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IPSecConnectionTunnel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ip_sec_connection_tunnel_error(ipsc_id, tunnel_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_ip_sec_connection_tunnel_error API.

Gets the identified error for the specified IPSec tunnel ID.

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • tunnel_id (String) —

    The OCID of the tunnel.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
 
# File 'lib/oci/core/virtual_network_client.rb', line 8580

def get_ip_sec_connection_tunnel_error(ipsc_id, tunnel_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection_tunnel_error.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_tunnel_error." if ipsc_id.nil?
  raise "Missing the required parameter 'tunnel_id' when calling get_ip_sec_connection_tunnel_error." if tunnel_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)
  raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id)

  path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/error'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection_tunnel_error') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IPSecConnectionTunnelErrorDetails'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_ip_sec_connection_tunnel_shared_secret API.

Gets the specified tunnel's shared secret (pre-shared key). To get other information about the tunnel, use get_ip_sec_connection_tunnel.

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • tunnel_id (String) —

    The OCID of the tunnel.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
 
# File 'lib/oci/core/virtual_network_client.rb', line 8639

def get_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection_tunnel_shared_secret.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_tunnel_shared_secret." if ipsc_id.nil?
  raise "Missing the required parameter 'tunnel_id' when calling get_ip_sec_connection_tunnel_shared_secret." if tunnel_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)
  raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id)

  path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection_tunnel_shared_secret') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IPSecConnectionTunnelSharedSecret'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ipsec_cpe_device_config_content(ipsc_id, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use get_ipsec_cpe_device_config_content API.

Renders a set of CPE configuration content for the specified IPSec connection (for all the tunnels in the connection). The content helps a network engineer configure the actual CPE device (for example, a hardware router) that the specified IPSec connection terminates on.

The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the Cpe used by the specified IPSecConnection must have the CPE's device type specified by the cpeDeviceShapeId attribute. The content optionally includes answers that the customer provides (see update_tunnel_cpe_device_config), merged with a template of other information specific to the CPE device type.

The operation returns configuration information for all tunnels in the single specified IPSecConnection object. Here are other similar operations:

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
 
# File 'lib/oci/core/virtual_network_client.rb', line 8718

def get_ipsec_cpe_device_config_content(ipsc_id, opts = {}, &block)
  logger.debug 'Calling operation VirtualNetworkClient#get_ipsec_cpe_device_config_content.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling get_ipsec_cpe_device_config_content." if ipsc_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)

  path = '/ipsecConnections/{ipscId}/cpeConfigContent'.sub('{ipscId}', ipsc_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'text/plain; charset=utf-8'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ipsec_cpe_device_config_content') do
    if !block.nil?
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ipv6(ipv6_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_ipv6 API.

Gets the specified IPv6. You must specify the object's OCID. Alternatively, you can get the object by using #list_ipv6s list_ipv6s} with the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet {OCID.

Parameters:

  • ipv6_id (String) —

    The OCID of the IPv6.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
 
# File 'lib/oci/core/virtual_network_client.rb', line 8822

def get_ipv6(ipv6_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_ipv6.' if logger

  raise "Missing the required parameter 'ipv6_id' when calling get_ipv6." if ipv6_id.nil?
  raise "Parameter value for 'ipv6_id' must not be blank" if OCI::Internal::Util.blank_string?(ipv6_id)

  path = '/ipv6/{ipv6Id}'.sub('{ipv6Id}', ipv6_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ipv6') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Ipv6'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_local_peering_gateway(local_peering_gateway_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_local_peering_gateway API.

Gets the specified local peering gateway's information.

Parameters:

  • local_peering_gateway_id (String) —

    The OCID of the local peering gateway.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
 
# File 'lib/oci/core/virtual_network_client.rb', line 8876

def get_local_peering_gateway(local_peering_gateway_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_local_peering_gateway.' if logger

  raise "Missing the required parameter 'local_peering_gateway_id' when calling get_local_peering_gateway." if local_peering_gateway_id.nil?
  raise "Parameter value for 'local_peering_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(local_peering_gateway_id)

  path = '/localPeeringGateways/{localPeeringGatewayId}'.sub('{localPeeringGatewayId}', local_peering_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_local_peering_gateway') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::LocalPeeringGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_nat_gateway(nat_gateway_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_nat_gateway API.

Gets the specified NAT gateway's information.

Parameters:

  • nat_gateway_id (String) —

    The NAT gateway's OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
 
# File 'lib/oci/core/virtual_network_client.rb', line 8930

def get_nat_gateway(nat_gateway_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_nat_gateway.' if logger

  raise "Missing the required parameter 'nat_gateway_id' when calling get_nat_gateway." if nat_gateway_id.nil?
  raise "Parameter value for 'nat_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(nat_gateway_id)

  path = '/natGateways/{natGatewayId}'.sub('{natGatewayId}', nat_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_nat_gateway') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::NatGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_network_security_group(network_security_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_network_security_group API.

Gets the specified network security group's information.

To list the VNICs in an NSG, see list_network_security_group_vnics.

To list the security rules in an NSG, see list_network_security_group_security_rules.

Parameters:

  • network_security_group_id (String) —

    The OCID of the network security group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
 
# File 'lib/oci/core/virtual_network_client.rb', line 8991

def get_network_security_group(network_security_group_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_network_security_group.' if logger

  raise "Missing the required parameter 'network_security_group_id' when calling get_network_security_group." if network_security_group_id.nil?
  raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id)

  path = '/networkSecurityGroups/{networkSecurityGroupId}'.sub('{networkSecurityGroupId}', network_security_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_network_security_group') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::NetworkSecurityGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_networking_topology(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_networking_topology API.

Gets a virtual networking topology for the current region.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :access_level (String) —

    Valid values are ANY and ACCESSIBLE. The default is ANY. Setting this to ACCESSIBLE returns only compartments for which a user has INSPECT permissions, either directly or indirectly (permissions can be on a resource in a subcompartment). A restricted set of fields is returned for compartments in which a user has indirect INSPECT permissions.

    When set to ANY permissions are not checked.

    Allowed values are: ANY, ACCESSIBLE

  • :query_compartment_subtree (BOOLEAN) —

    When set to true, the hierarchy of compartments is traversed and the specified compartment and its subcompartments are inspected depending on the the setting of accessLevel. Default is false.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_none_match (String) —

    For querying if there is a cached value on the server. The If-None-Match HTTP request header makes the request conditional. For GET and HEAD methods, the server will send back the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. For other methods, the request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed.

  • :cache_control (String) —

    The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

Returns:



9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
 
# File 'lib/oci/core/virtual_network_client.rb', line 9070

def get_networking_topology(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_networking_topology.' if logger

  raise "Missing the required parameter 'compartment_id' when calling get_networking_topology." if compartment_id.nil?

  if opts[:access_level] && !%w[ANY ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of ANY, ACCESSIBLE.'
  end

  path = '/networkingTopology'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:queryCompartmentSubtree] = opts[:query_compartment_subtree] if !opts[:query_compartment_subtree].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'cache-control'] = opts[:cache_control] if opts[:cache_control]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_networking_topology') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::NetworkingTopology'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_private_ip(private_ip_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_private_ip API.

Gets the specified private IP. You must specify the object's OCID. Alternatively, you can get the object by using #list_private_ips list_private_ips} with the private IP address (for example, 10.0.3.3) and subnet {OCID.

Parameters:

  • private_ip_id (String) —

    The OCID of the private IP or IPv6.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
 
# File 'lib/oci/core/virtual_network_client.rb', line 9136

def get_private_ip(private_ip_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_private_ip.' if logger

  raise "Missing the required parameter 'private_ip_id' when calling get_private_ip." if private_ip_id.nil?
  raise "Parameter value for 'private_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(private_ip_id)

  path = '/privateIps/{privateIpId}'.sub('{privateIpId}', private_ip_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_private_ip') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PrivateIp'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_public_ip(public_ip_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_public_ip API.

Gets the specified public IP. You must specify the object's OCID.

Alternatively, you can get the object by using get_public_ip_by_ip_address with the public IP address (for example, 203.0.113.2).

Or you can use #get_public_ip_by_private_ip_id get_public_ip_by_private_ip_id} with the {OCID of the private IP that the public IP is assigned to.

Note: If you're fetching a reserved public IP that is in the process of being moved to a different private IP, the service returns the public IP object with lifecycleState = ASSIGNING and assignedEntityId = OCID of the target private IP.

Parameters:

  • public_ip_id (String) —

    The OCID of the public IP.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
 
# File 'lib/oci/core/virtual_network_client.rb', line 9201

def get_public_ip(public_ip_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_public_ip.' if logger

  raise "Missing the required parameter 'public_ip_id' when calling get_public_ip." if public_ip_id.nil?
  raise "Parameter value for 'public_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_id)

  path = '/publicIps/{publicIpId}'.sub('{publicIpId}', public_ip_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_public_ip') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PublicIp'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_public_ip_by_ip_address(get_public_ip_by_ip_address_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_public_ip_by_ip_address API.

Gets the public IP based on the public IP address (for example, 203.0.113.2).

Note: If you're fetching a reserved public IP that is in the process of being moved to a different private IP, the service returns the public IP object with lifecycleState = ASSIGNING and assignedEntityId = OCID of the target private IP.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
 
# File 'lib/oci/core/virtual_network_client.rb', line 9260

def get_public_ip_by_ip_address(get_public_ip_by_ip_address_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_public_ip_by_ip_address.' if logger

  raise "Missing the required parameter 'get_public_ip_by_ip_address_details' when calling get_public_ip_by_ip_address." if get_public_ip_by_ip_address_details.nil?

  path = '/publicIps/actions/getByIpAddress'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(get_public_ip_by_ip_address_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_public_ip_by_ip_address') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PublicIp'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_public_ip_by_private_ip_id(get_public_ip_by_private_ip_id_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_public_ip_by_private_ip_id API.

Gets the public IP assigned to the specified private IP. You must specify the OCID of the private IP. If no public IP is assigned, a 404 is returned.

Note: If you're fetching a reserved public IP that is in the process of being moved to a different private IP, and you provide the OCID of the original private IP, this operation returns a 404. If you instead provide the OCID of the target private IP, or if you instead call #get_public_ip get_public_ip} or get_public_ip_by_ip_address, the service returns the public IP object with lifecycleState = ASSIGNING and assignedEntityId = {OCID of the target private IP.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
 
# File 'lib/oci/core/virtual_network_client.rb', line 9324

def get_public_ip_by_private_ip_id(get_public_ip_by_private_ip_id_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_public_ip_by_private_ip_id.' if logger

  raise "Missing the required parameter 'get_public_ip_by_private_ip_id_details' when calling get_public_ip_by_private_ip_id." if get_public_ip_by_private_ip_id_details.nil?

  path = '/publicIps/actions/getByPrivateIpId'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(get_public_ip_by_private_ip_id_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_public_ip_by_private_ip_id') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PublicIp'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_public_ip_pool(public_ip_pool_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_public_ip_pool API.

Gets the specified PublicIpPool object. You must specify the object's OCID.

Parameters:

  • public_ip_pool_id (String) —

    The OCID of the public IP pool.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
 
# File 'lib/oci/core/virtual_network_client.rb', line 9380

def get_public_ip_pool(public_ip_pool_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_public_ip_pool.' if logger

  raise "Missing the required parameter 'public_ip_pool_id' when calling get_public_ip_pool." if public_ip_pool_id.nil?
  raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id)

  path = '/publicIpPools/{publicIpPoolId}'.sub('{publicIpPoolId}', public_ip_pool_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_public_ip_pool') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PublicIpPool'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_remote_peering_connection(remote_peering_connection_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_remote_peering_connection API.

Get the specified remote peering connection's information.

Parameters:

  • remote_peering_connection_id (String) —

    The OCID of the remote peering connection (RPC).

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
 
# File 'lib/oci/core/virtual_network_client.rb', line 9435

def get_remote_peering_connection(remote_peering_connection_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_remote_peering_connection.' if logger

  raise "Missing the required parameter 'remote_peering_connection_id' when calling get_remote_peering_connection." if remote_peering_connection_id.nil?
  raise "Parameter value for 'remote_peering_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(remote_peering_connection_id)

  path = '/remotePeeringConnections/{remotePeeringConnectionId}'.sub('{remotePeeringConnectionId}', remote_peering_connection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_remote_peering_connection') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::RemotePeeringConnection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_resource_ip_inventory(data_request_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_resource_ip_inventory API.

Gets the IpInventory resource.

Parameters:

  • data_request_id (String) —

    Specify the ID of the resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
 
# File 'lib/oci/core/virtual_network_client.rb', line 9492

def get_resource_ip_inventory(data_request_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_resource_ip_inventory.' if logger

  raise "Missing the required parameter 'data_request_id' when calling get_resource_ip_inventory." if data_request_id.nil?
  raise "Parameter value for 'data_request_id' must not be blank" if OCI::Internal::Util.blank_string?(data_request_id)

  path = '/ipinventory/DataRequestId/{dataRequestId}'.sub('{dataRequestId}', data_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_resource_ip_inventory') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IpInventoryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_route_table(rt_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_route_table API.

Gets the specified route table's information.

Parameters:

  • rt_id (String) —

    The OCID of the route table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
 
# File 'lib/oci/core/virtual_network_client.rb', line 9546

def get_route_table(rt_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_route_table.' if logger

  raise "Missing the required parameter 'rt_id' when calling get_route_table." if rt_id.nil?
  raise "Parameter value for 'rt_id' must not be blank" if OCI::Internal::Util.blank_string?(rt_id)

  path = '/routeTables/{rtId}'.sub('{rtId}', rt_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_route_table') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::RouteTable'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_security_list(security_list_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_security_list API.

Gets the specified security list's information.

Parameters:

  • security_list_id (String) —

    The OCID of the security list.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
 
# File 'lib/oci/core/virtual_network_client.rb', line 9600

def get_security_list(security_list_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_security_list.' if logger

  raise "Missing the required parameter 'security_list_id' when calling get_security_list." if security_list_id.nil?
  raise "Parameter value for 'security_list_id' must not be blank" if OCI::Internal::Util.blank_string?(security_list_id)

  path = '/securityLists/{securityListId}'.sub('{securityListId}', security_list_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_security_list') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::SecurityList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_service(service_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_service API.

Gets the specified Service object.

Parameters:

  • service_id (String) —

    The service's OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
 
# File 'lib/oci/core/virtual_network_client.rb', line 9655

def get_service(service_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_service.' if logger

  raise "Missing the required parameter 'service_id' when calling get_service." if service_id.nil?
  raise "Parameter value for 'service_id' must not be blank" if OCI::Internal::Util.blank_string?(service_id)

  path = '/services/{serviceId}'.sub('{serviceId}', service_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_service') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Service'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_service_gateway(service_gateway_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_service_gateway API.

Gets the specified service gateway's information.

Parameters:

  • service_gateway_id (String) —

    The service gateway's OCID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
 
# File 'lib/oci/core/virtual_network_client.rb', line 9709

def get_service_gateway(service_gateway_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_service_gateway.' if logger

  raise "Missing the required parameter 'service_gateway_id' when calling get_service_gateway." if service_gateway_id.nil?
  raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id)

  path = '/serviceGateways/{serviceGatewayId}'.sub('{serviceGatewayId}', service_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_service_gateway') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::ServiceGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_subnet(subnet_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_subnet API.

Gets the specified subnet's information.

Parameters:

  • subnet_id (String) —

    Specify the OCID of the subnet.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
 
# File 'lib/oci/core/virtual_network_client.rb', line 9763

def get_subnet(subnet_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_subnet.' if logger

  raise "Missing the required parameter 'subnet_id' when calling get_subnet." if subnet_id.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/subnets/{subnetId}'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_subnet') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Subnet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_subnet_cidr_utilization(subnet_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_subnet_cidr_utilization API.

Gets the CIDR utilization data of the specified subnet. Specify the OCID.

Parameters:

  • subnet_id (String) —

    Specify the OCID of the subnet.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
 
# File 'lib/oci/core/virtual_network_client.rb', line 9820

def get_subnet_cidr_utilization(subnet_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_subnet_cidr_utilization.' if logger

  raise "Missing the required parameter 'subnet_id' when calling get_subnet_cidr_utilization." if subnet_id.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/ipInventory/subnets/{subnetId}/cidrs'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_subnet_cidr_utilization') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IpInventoryCidrUtilizationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_subnet_ip_inventory(subnet_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_subnet_ip_inventory API.

Gets the IP Inventory data of the specified subnet. Specify the OCID.

Parameters:

  • subnet_id (String) —

    Specify the OCID of the subnet.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
 
# File 'lib/oci/core/virtual_network_client.rb', line 9877

def get_subnet_ip_inventory(subnet_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_subnet_ip_inventory.' if logger

  raise "Missing the required parameter 'subnet_id' when calling get_subnet_ip_inventory." if subnet_id.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/ipInventory/subnets/{subnetId}'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_subnet_ip_inventory') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IpInventorySubnetResourceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_subnet_topology(compartment_id, subnet_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_subnet_topology API.

Gets a topology for a given subnet.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • subnet_id (String) —

    The OCID of the subnet.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :access_level (String) —

    Valid values are ANY and ACCESSIBLE. The default is ANY. Setting this to ACCESSIBLE returns only compartments for which a user has INSPECT permissions, either directly or indirectly (permissions can be on a resource in a subcompartment). A restricted set of fields is returned for compartments in which a user has indirect INSPECT permissions.

    When set to ANY permissions are not checked.

    Allowed values are: ANY, ACCESSIBLE

  • :query_compartment_subtree (BOOLEAN) —

    When set to true, the hierarchy of compartments is traversed and the specified compartment and its subcompartments are inspected depending on the the setting of accessLevel. Default is false.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_none_match (String) —

    For querying if there is a cached value on the server. The If-None-Match HTTP request header makes the request conditional. For GET and HEAD methods, the server will send back the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. For other methods, the request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed.

  • :cache_control (String) —

    The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

Returns:



9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
 
# File 'lib/oci/core/virtual_network_client.rb', line 9957

def get_subnet_topology(compartment_id, subnet_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_subnet_topology.' if logger

  raise "Missing the required parameter 'compartment_id' when calling get_subnet_topology." if compartment_id.nil?
  raise "Missing the required parameter 'subnet_id' when calling get_subnet_topology." if subnet_id.nil?

  if opts[:access_level] && !%w[ANY ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of ANY, ACCESSIBLE.'
  end

  path = '/subnetTopology'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:subnetId] = subnet_id
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:queryCompartmentSubtree] = opts[:query_compartment_subtree] if !opts[:query_compartment_subtree].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'cache-control'] = opts[:cache_control] if opts[:cache_control]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_subnet_topology') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::SubnetTopology'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_tunnel_cpe_device_config(ipsc_id, tunnel_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_tunnel_cpe_device_config API.

Gets the set of CPE configuration answers for the tunnel, which the customer provided in update_tunnel_cpe_device_config. To get the full set of content for the tunnel (any answers merged with the template of other information specific to the CPE device type), use get_tunnel_cpe_device_config_content.

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • tunnel_id (String) —

    The OCID of the tunnel.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
 
# File 'lib/oci/core/virtual_network_client.rb', line 10029

def get_tunnel_cpe_device_config(ipsc_id, tunnel_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_tunnel_cpe_device_config.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling get_tunnel_cpe_device_config." if ipsc_id.nil?
  raise "Missing the required parameter 'tunnel_id' when calling get_tunnel_cpe_device_config." if tunnel_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)
  raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id)

  path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_tunnel_cpe_device_config') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::TunnelCpeDeviceConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_tunnel_cpe_device_config_content(ipsc_id, tunnel_id, opts = {}, &block) ⇒ Response

Note:

Click here to see an example of how to use get_tunnel_cpe_device_config_content API.

Renders a set of CPE configuration content for the specified IPSec tunnel. The content helps a network engineer configure the actual CPE device (for example, a hardware router) that the specified IPSec tunnel terminates on.

The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the Cpe used by the specified IPSecConnection must have the CPE's device type specified by the cpeDeviceShapeId attribute. The content optionally includes answers that the customer provides (see update_tunnel_cpe_device_config), merged with a template of other information specific to the CPE device type.

The operation returns configuration information for only the specified IPSec tunnel. Here are other similar operations:

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • tunnel_id (String) —

    The OCID of the tunnel.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
 
# File 'lib/oci/core/virtual_network_client.rb', line 10108

def get_tunnel_cpe_device_config_content(ipsc_id, tunnel_id, opts = {}, &block)
  logger.debug 'Calling operation VirtualNetworkClient#get_tunnel_cpe_device_config_content.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling get_tunnel_cpe_device_config_content." if ipsc_id.nil?
  raise "Missing the required parameter 'tunnel_id' when calling get_tunnel_cpe_device_config_content." if tunnel_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)
  raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id)

  path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig/content'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'text/plain; charset=utf-8'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_tunnel_cpe_device_config_content') do
    if !block.nil?
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @api_client.call_api(
          :GET,
          path,
          endpoint,
          header_params: header_params,
          query_params: query_params,
          operation_signing_strategy: operation_signing_strategy,
          body: post_body,
          return_type: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_upgrade_status(drg_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_upgrade_status API.

Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed.

Parameters:

  • drg_id (String) —

    The OCID of the DRG.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
 
# File 'lib/oci/core/virtual_network_client.rb', line 10211

def get_upgrade_status(drg_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_upgrade_status.' if logger

  raise "Missing the required parameter 'drg_id' when calling get_upgrade_status." if drg_id.nil?
  raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id)

  path = '/drgs/{drgId}/actions/upgradeStatus'.sub('{drgId}', drg_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_upgrade_status') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::UpgradeStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vcn(vcn_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_vcn API.

Gets the specified VCN's information.

Parameters:

  • vcn_id (String) —

    Specify the OCID of the VCN.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:

  • (Response) —

    A Response object with data of type Vcn



10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
 
# File 'lib/oci/core/virtual_network_client.rb', line 10265

def get_vcn(vcn_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_vcn.' if logger

  raise "Missing the required parameter 'vcn_id' when calling get_vcn." if vcn_id.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/vcns/{vcnId}'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vcn') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Vcn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vcn_dns_resolver_association(vcn_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_vcn_dns_resolver_association API.

Get the associated DNS resolver information with a vcn

Parameters:

  • vcn_id (String) —

    Specify the OCID of the VCN.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
 
# File 'lib/oci/core/virtual_network_client.rb', line 10321

def get_vcn_dns_resolver_association(vcn_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_vcn_dns_resolver_association.' if logger

  raise "Missing the required parameter 'vcn_id' when calling get_vcn_dns_resolver_association." if vcn_id.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/vcns/{vcnId}/dnsResolverAssociation'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vcn_dns_resolver_association') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::VcnDnsResolverAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vcn_overlap(vcn_id, get_vcn_overlap_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_vcn_overlap API.

Gets the CIDR overlap information of the specified VCN in selected compartments. Specify the OCID.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
 
# File 'lib/oci/core/virtual_network_client.rb', line 10385

def get_vcn_overlap(vcn_id, get_vcn_overlap_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_vcn_overlap.' if logger

  raise "Missing the required parameter 'vcn_id' when calling get_vcn_overlap." if vcn_id.nil?
  raise "Missing the required parameter 'get_vcn_overlap_details' when calling get_vcn_overlap." if get_vcn_overlap_details.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/ipInventory/vcns/{vcnId}/overlaps'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(get_vcn_overlap_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vcn_overlap') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IpInventoryVcnOverlapCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vcn_topology(compartment_id, vcn_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_vcn_topology API.

Gets a virtual network topology for a given VCN.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • vcn_id (String) —

    The OCID of the VCN.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :access_level (String) —

    Valid values are ANY and ACCESSIBLE. The default is ANY. Setting this to ACCESSIBLE returns only compartments for which a user has INSPECT permissions, either directly or indirectly (permissions can be on a resource in a subcompartment). A restricted set of fields is returned for compartments in which a user has indirect INSPECT permissions.

    When set to ANY permissions are not checked.

    Allowed values are: ANY, ACCESSIBLE

  • :query_compartment_subtree (BOOLEAN) —

    When set to true, the hierarchy of compartments is traversed and the specified compartment and its subcompartments are inspected depending on the the setting of accessLevel. Default is false.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_none_match (String) —

    For querying if there is a cached value on the server. The If-None-Match HTTP request header makes the request conditional. For GET and HEAD methods, the server will send back the requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. For other methods, the request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed.

  • :cache_control (String) —

    The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

Returns:



10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
 
# File 'lib/oci/core/virtual_network_client.rb', line 10468

def get_vcn_topology(compartment_id, vcn_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_vcn_topology.' if logger

  raise "Missing the required parameter 'compartment_id' when calling get_vcn_topology." if compartment_id.nil?
  raise "Missing the required parameter 'vcn_id' when calling get_vcn_topology." if vcn_id.nil?

  if opts[:access_level] && !%w[ANY ACCESSIBLE].include?(opts[:access_level])
    raise 'Invalid value for "access_level", must be one of ANY, ACCESSIBLE.'
  end

  path = '/vcnTopology'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:vcnId] = vcn_id
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:queryCompartmentSubtree] = opts[:query_compartment_subtree] if !opts[:query_compartment_subtree].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match]
  header_params[:'cache-control'] = opts[:cache_control] if opts[:cache_control]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vcn_topology') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::VcnTopology'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_virtual_circuit(virtual_circuit_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_virtual_circuit API.

Gets the specified virtual circuit's information.

Parameters:

  • virtual_circuit_id (String) —

    The OCID of the virtual circuit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
 
# File 'lib/oci/core/virtual_network_client.rb', line 10532

def get_virtual_circuit(virtual_circuit_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_virtual_circuit.' if logger

  raise "Missing the required parameter 'virtual_circuit_id' when calling get_virtual_circuit." if virtual_circuit_id.nil?
  raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id)

  path = '/virtualCircuits/{virtualCircuitId}'.sub('{virtualCircuitId}', virtual_circuit_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_virtual_circuit') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::VirtualCircuit'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vlan(vlan_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_vlan API.

Gets the specified VLAN's information.

Parameters:

  • vlan_id (String) —

    The OCID of the VLAN.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
 
# File 'lib/oci/core/virtual_network_client.rb', line 10588

def get_vlan(vlan_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_vlan.' if logger

  raise "Missing the required parameter 'vlan_id' when calling get_vlan." if vlan_id.nil?
  raise "Parameter value for 'vlan_id' must not be blank" if OCI::Internal::Util.blank_string?(vlan_id)

  path = '/vlans/{vlanId}'.sub('{vlanId}', vlan_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vlan') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Vlan'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vnic(vnic_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_vnic API.

Gets the information for the specified virtual network interface card (VNIC). You can get the VNIC OCID from the list_vnic_attachments operation.

Parameters:

  • vnic_id (String) —

    The OCID of the VNIC.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
 
# File 'lib/oci/core/virtual_network_client.rb', line 10646

def get_vnic(vnic_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_vnic.' if logger

  raise "Missing the required parameter 'vnic_id' when calling get_vnic." if vnic_id.nil?
  raise "Parameter value for 'vnic_id' must not be blank" if OCI::Internal::Util.blank_string?(vnic_id)

  path = '/vnics/{vnicId}'.sub('{vnicId}', vnic_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vnic') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Vnic'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_vtap(vtap_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_vtap API.

Gets the specified Vtap resource.

Parameters:

  • vtap_id (String) —

    The OCID of the VTAP.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
 
# File 'lib/oci/core/virtual_network_client.rb', line 10702

def get_vtap(vtap_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#get_vtap.' if logger

  raise "Missing the required parameter 'vtap_id' when calling get_vtap." if vtap_id.nil?
  raise "Parameter value for 'vtap_id' must not be blank" if OCI::Internal::Util.blank_string?(vtap_id)

  path = '/vtaps/{vtapId}'.sub('{vtapId}', vtap_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vtap') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Vtap'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#ipv6_vnic_detach(ipv6_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use ipv6_vnic_detach API.

Unassign the specified IPv6 address from Virtual Network Interface Card (VNIC). You must specify the IPv6 OCID.

Parameters:

  • ipv6_id (String) —

    The OCID of the IPv6.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
 
# File 'lib/oci/core/virtual_network_client.rb', line 10769

def ipv6_vnic_detach(ipv6_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#ipv6_vnic_detach.' if logger

  raise "Missing the required parameter 'ipv6_id' when calling ipv6_vnic_detach." if ipv6_id.nil?
  raise "Parameter value for 'ipv6_id' must not be blank" if OCI::Internal::Util.blank_string?(ipv6_id)

  path = '/ipv6/{ipv6Id}/actions/detach'.sub('{ipv6Id}', ipv6_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#ipv6_vnic_detach') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Ipv6'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_allowed_peer_regions_for_remote_peering(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_allowed_peer_regions_for_remote_peering API.

Lists the regions that support remote VCN peering (which is peering across regions). For more information, see VCN Peering.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
 
# File 'lib/oci/core/virtual_network_client.rb', line 10827

def list_allowed_peer_regions_for_remote_peering(opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_allowed_peer_regions_for_remote_peering.' if logger


  path = '/allowedPeerRegionsForRemotePeering'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_allowed_peer_regions_for_remote_peering') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::PeerRegionForRemotePeering>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_byoasns(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_byoasns API.

Lists the Byoasn resources in the specified compartment. You can filter the list using query parameters.

Allowed values are: TIMECREATED, DISPLAYNAME

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state name exactly.

  • :sort_by (String) —

    The field to sort by, for byoasn List operation. (default to TIMECREATED)

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

Returns:



10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
 
# File 'lib/oci/core/virtual_network_client.rb', line 10904

def list_byoasns(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_byoasns.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_byoasns." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/byoasns'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_byoasns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::ByoasnCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_byoip_allocated_ranges(byoip_range_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_byoip_allocated_ranges API.

Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool. Each ByoipAllocatedRange object also lists the IP pool where it is allocated.

Parameters:

  • byoip_range_id (String) —

    The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
 
# File 'lib/oci/core/virtual_network_client.rb', line 10986

def list_byoip_allocated_ranges(byoip_range_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_byoip_allocated_ranges.' if logger

  raise "Missing the required parameter 'byoip_range_id' when calling list_byoip_allocated_ranges." if byoip_range_id.nil?
  raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id)

  path = '/byoipRanges/{byoipRangeId}/byoipAllocatedRanges'.sub('{byoipRangeId}', byoip_range_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_byoip_allocated_ranges') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::ByoipAllocatedRangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_byoip_ranges(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_byoip_ranges API.

Lists the ByoipRange resources in the specified compartment. You can filter the list using query parameters.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

Returns:



11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
 
# File 'lib/oci/core/virtual_network_client.rb', line 11074

def list_byoip_ranges(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_byoip_ranges.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_byoip_ranges." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/byoipRanges'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_byoip_ranges') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::ByoipRangeCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_capture_filters(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_capture_filters API.

Lists the capture filters in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given capture filter lifecycle state. The state value is case-insensitive.

  • :filter_type (String) —

    A filter to only return resources that match the given capture filterType. The filterType value is the string representation of enum - VTAP, FLOWLOG.

Returns:



11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
 
# File 'lib/oci/core/virtual_network_client.rb', line 11175

def list_capture_filters(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_capture_filters.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_capture_filters." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::CaptureFilter::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::CaptureFilter::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:filter_type] && !OCI::Core::Models::CaptureFilter::FILTER_TYPE_ENUM.include?(opts[:filter_type])
    raise 'Invalid value for "filter_type", must be one of the values in OCI::Core::Models::CaptureFilter::FILTER_TYPE_ENUM.'
  end

  path = '/captureFilters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:filterType] = opts[:filter_type] if opts[:filter_type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_capture_filters') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::CaptureFilter>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cpe_device_shapes(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_cpe_device_shapes API.

Lists the CPE device types that the Networking service provides CPE configuration content for (example: Cisco ASA). The content helps a network engineer configure the actual CPE device represented by a Cpe object.

If you want to generate CPE configuration content for one of the returned CPE device types, ensure that the Cpe} object’s cpeDeviceShapeId attribute is set to the CPE device type’s (returned by this operation).

For information about generating CPE configuration content, see these operations:

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
 
# File 'lib/oci/core/virtual_network_client.rb', line 11276

def list_cpe_device_shapes(opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_cpe_device_shapes.' if logger


  path = '/cpeDeviceShapes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cpe_device_shapes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::CpeDeviceShapeSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cpes(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_cpes API.

Lists the customer-premises equipment objects (CPEs) in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:

  • (Response) —

    A Response object with data of type Array<Cpe>



11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
 
# File 'lib/oci/core/virtual_network_client.rb', line 11340

def list_cpes(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_cpes.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_cpes." if compartment_id.nil?

  path = '/cpes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cpes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::Cpe>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cross_connect_groups(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_cross_connect_groups API.

Lists the cross-connect groups in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Returns:



11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
 
# File 'lib/oci/core/virtual_network_client.rb', line 11424

def list_cross_connect_groups(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_cross_connect_groups.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_cross_connect_groups." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::CrossConnectGroup::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::CrossConnectGroup::LIFECYCLE_STATE_ENUM.'
  end

  path = '/crossConnectGroups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cross_connect_groups') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::CrossConnectGroup>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cross_connect_locations(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_cross_connect_locations API.

Lists the available FastConnect locations for cross-connect installation. You need this information so you can specify your desired location when you create a cross-connect.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
 
# File 'lib/oci/core/virtual_network_client.rb', line 11506

def list_cross_connect_locations(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_cross_connect_locations.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_cross_connect_locations." if compartment_id.nil?

  path = '/crossConnectLocations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cross_connect_locations') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::CrossConnectLocation>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cross_connect_mappings(virtual_circuit_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_cross_connect_mappings API.

Lists the Cross Connect mapping Details for the specified virtual circuit.

Parameters:

  • virtual_circuit_id (String) —

    The OCID of the virtual circuit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
 
# File 'lib/oci/core/virtual_network_client.rb', line 11565

def list_cross_connect_mappings(virtual_circuit_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_cross_connect_mappings.' if logger

  raise "Missing the required parameter 'virtual_circuit_id' when calling list_cross_connect_mappings." if virtual_circuit_id.nil?
  raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id)

  path = '/virtualCircuits/{virtualCircuitId}/crossConnectMappings'.sub('{virtualCircuitId}', virtual_circuit_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cross_connect_mappings') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CrossConnectMappingDetailsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_cross_connects(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_cross_connects API.

Lists the cross-connects in the specified compartment. You can filter the list by specifying the OCID of a cross-connect group.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :cross_connect_group_id (String) —

    The OCID of the cross-connect group.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Returns:



11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
 
# File 'lib/oci/core/virtual_network_client.rb', line 11650

def list_cross_connects(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_cross_connects.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_cross_connects." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::CrossConnect::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::CrossConnect::LIFECYCLE_STATE_ENUM.'
  end

  path = '/crossConnects'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:crossConnectGroupId] = opts[:cross_connect_group_id] if opts[:cross_connect_group_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cross_connects') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::CrossConnect>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_crossconnect_port_speed_shapes(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_crossconnect_port_speed_shapes API.

Lists the available port speeds for cross-connects. You need this information so you can specify your desired port speed (that is, shape) when you create a cross-connect.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
 
# File 'lib/oci/core/virtual_network_client.rb', line 11734

def list_crossconnect_port_speed_shapes(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_crossconnect_port_speed_shapes.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_crossconnect_port_speed_shapes." if compartment_id.nil?

  path = '/crossConnectPortSpeedShapes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_crossconnect_port_speed_shapes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::CrossConnectPortSpeedShape>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_dhcp_options(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_dhcp_options API.

Lists the sets of DHCP options in the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the sets of DHCP options from all VCNs in the specified compartment. The response includes the default set of options that automatically comes with each VCN, plus any other sets you've created.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :vcn_id (String) —

    The OCID of the VCN.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Returns:



11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
 
# File 'lib/oci/core/virtual_network_client.rb', line 11822

def list_dhcp_options(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_dhcp_options.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_dhcp_options." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::DhcpOptions::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::DhcpOptions::LIFECYCLE_STATE_ENUM.'
  end

  path = '/dhcps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_dhcp_options') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::DhcpOptions>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_drg_attachments(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_drg_attachments API.

Lists the DrgAttachment resource for the specified compartment. You can filter the results by DRG, attached network, attachment type, DRG route table or VCN route table.

The LIST API lists DRG attachments by attachment type. It will default to list VCN attachments, but you may request to list ALL attachments of ALL types.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :vcn_id (String) —

    The OCID of the VCN.

  • :drg_id (String) —

    The OCID of the DRG.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :network_id (String) —

    The OCID of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG.

  • :attachment_type (String) —

    The type for the network resource attached to the DRG. (default to VCN) Allowed values are: VCN, VIRTUAL_CIRCUIT, REMOTE_PEERING_CONNECTION, IPSEC_TUNNEL, ALL

  • :drg_route_table_id (String) —

    The OCID of the DRG route table assigned to the DRG attachment.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Returns:



11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
 
# File 'lib/oci/core/virtual_network_client.rb', line 11934

def list_drg_attachments(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_drg_attachments.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_drg_attachments." if compartment_id.nil?

  if opts[:attachment_type] && !%w[VCN VIRTUAL_CIRCUIT REMOTE_PEERING_CONNECTION IPSEC_TUNNEL ALL].include?(opts[:attachment_type])
    raise 'Invalid value for "attachment_type", must be one of VCN, VIRTUAL_CIRCUIT, REMOTE_PEERING_CONNECTION, IPSEC_TUNNEL, ALL.'
  end

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::DrgAttachment::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::DrgAttachment::LIFECYCLE_STATE_ENUM.'
  end

  path = '/drgAttachments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:drgId] = opts[:drg_id] if opts[:drg_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:networkId] = opts[:network_id] if opts[:network_id]
  query_params[:attachmentType] = opts[:attachment_type] if opts[:attachment_type]
  query_params[:drgRouteTableId] = opts[:drg_route_table_id] if opts[:drg_route_table_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drg_attachments') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::DrgAttachment>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_drg_route_distribution_statements(drg_route_distribution_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_drg_route_distribution_statements API.

Lists the statements for the specified route distribution.

Parameters:

  • drg_route_distribution_id (String) —

    The OCID of the route distribution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_by (String) —

    The field to sort by. Allowed values are: TIMECREATED

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

Returns:



12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
 
# File 'lib/oci/core/virtual_network_client.rb', line 12029

def list_drg_route_distribution_statements(drg_route_distribution_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_drg_route_distribution_statements.' if logger

  raise "Missing the required parameter 'drg_route_distribution_id' when calling list_drg_route_distribution_statements." if drg_route_distribution_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id)

  path = '/drgRouteDistributions/{drgRouteDistributionId}/drgRouteDistributionStatements'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drg_route_distribution_statements') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::DrgRouteDistributionStatement>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_drg_route_distributions(drg_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_drg_route_distributions API.

Lists the route distributions in the specified DRG.

To retrieve the statements in a distribution, use the ListDrgRouteDistributionStatements operation.

Parameters:

  • drg_id (String) —

    The OCID of the DRG.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter that only returns resources that match the specified lifecycle state. The value is case insensitive.

Returns:



12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
 
# File 'lib/oci/core/virtual_network_client.rb', line 12126

def list_drg_route_distributions(drg_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_drg_route_distributions.' if logger

  raise "Missing the required parameter 'drg_id' when calling list_drg_route_distributions." if drg_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::DrgRouteDistribution::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::DrgRouteDistribution::LIFECYCLE_STATE_ENUM.'
  end

  path = '/drgRouteDistributions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:drgId] = drg_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drg_route_distributions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::DrgRouteDistribution>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_drg_route_rules(drg_route_table_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_drg_route_rules API.

Lists the route rules in the specified DRG route table.

Parameters:

  • drg_route_table_id (String) —

    The OCID of the DRG route table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :route_type (String) —

    Static routes are specified through the DRG route table API. Dynamic routes are learned by the DRG from the DRG attachments through various routing protocols.

    Allowed values are: STATIC, DYNAMIC

Returns:



12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
 
# File 'lib/oci/core/virtual_network_client.rb', line 12210

def list_drg_route_rules(drg_route_table_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_drg_route_rules.' if logger

  raise "Missing the required parameter 'drg_route_table_id' when calling list_drg_route_rules." if drg_route_table_id.nil?

  if opts[:route_type] && !%w[STATIC DYNAMIC].include?(opts[:route_type])
    raise 'Invalid value for "route_type", must be one of STATIC, DYNAMIC.'
  end
  raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id)

  path = '/drgRouteTables/{drgRouteTableId}/drgRouteRules'.sub('{drgRouteTableId}', drg_route_table_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:routeType] = opts[:route_type] if opts[:route_type]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drg_route_rules') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::DrgRouteRule>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_drg_route_tables(drg_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_drg_route_tables API.

Lists the DRG route tables for the specified DRG.

Use the ListDrgRouteRules operation to retrieve the route rules in a table.

Parameters:

  • drg_id (String) —

    The OCID of the DRG.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :import_drg_route_distribution_id (String) —

    The OCID of the import route distribution.

  • :lifecycle_state (String) —

    A filter that only returns matches for the specified lifecycle state. The value is case insensitive.

Returns:



12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
 
# File 'lib/oci/core/virtual_network_client.rb', line 12303

def list_drg_route_tables(drg_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_drg_route_tables.' if logger

  raise "Missing the required parameter 'drg_id' when calling list_drg_route_tables." if drg_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::DrgRouteTable::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::DrgRouteTable::LIFECYCLE_STATE_ENUM.'
  end

  path = '/drgRouteTables'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:drgId] = drg_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:importDrgRouteDistributionId] = opts[:import_drg_route_distribution_id] if opts[:import_drg_route_distribution_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drg_route_tables') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::DrgRouteTable>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_drgs(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_drgs API.

Lists the DRGs in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:

  • (Response) —

    A Response object with data of type Array<Drg>



12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
 
# File 'lib/oci/core/virtual_network_client.rb', line 12385

def list_drgs(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_drgs.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_drgs." if compartment_id.nil?

  path = '/drgs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drgs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::Drg>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_fast_connect_provider_services(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_fast_connect_provider_services API.

Lists the service offerings from supported providers. You need this information so you can specify your desired provider and service offering when you create a virtual circuit.

For the compartment ID, provide the OCID of your tenancy (the root compartment).

For more information, see FastConnect Overview.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
 
# File 'lib/oci/core/virtual_network_client.rb', line 12456

def list_fast_connect_provider_services(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_fast_connect_provider_services.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_fast_connect_provider_services." if compartment_id.nil?

  path = '/fastConnectProviderServices'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_fast_connect_provider_services') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::FastConnectProviderService>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_fast_connect_provider_virtual_circuit_bandwidth_shapes(provider_service_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_fast_connect_provider_virtual_circuit_bandwidth_shapes API.

Gets the list of available virtual circuit bandwidth levels for a provider. You need this information so you can specify your desired bandwidth level (shape) when you create a virtual circuit.

For more information about virtual circuits, see FastConnect Overview.

Parameters:

  • provider_service_id (String) —

    The OCID of the provider service.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
 
# File 'lib/oci/core/virtual_network_client.rb', line 12524

def list_fast_connect_provider_virtual_circuit_bandwidth_shapes(provider_service_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_fast_connect_provider_virtual_circuit_bandwidth_shapes.' if logger

  raise "Missing the required parameter 'provider_service_id' when calling list_fast_connect_provider_virtual_circuit_bandwidth_shapes." if provider_service_id.nil?
  raise "Parameter value for 'provider_service_id' must not be blank" if OCI::Internal::Util.blank_string?(provider_service_id)

  path = '/fastConnectProviderServices/{providerServiceId}/virtualCircuitBandwidthShapes'.sub('{providerServiceId}', provider_service_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_fast_connect_provider_virtual_circuit_bandwidth_shapes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::VirtualCircuitBandwidthShape>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_internet_gateways(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_internet_gateways API.

Lists the internet gateways in the specified VCN and the specified compartment. If the VCN ID is not provided, then the list includes the internet gateways from all VCNs in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :vcn_id (String) —

    The OCID of the VCN.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Returns:



12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
 
# File 'lib/oci/core/virtual_network_client.rb', line 12610

def list_internet_gateways(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_internet_gateways.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_internet_gateways." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::InternetGateway::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::InternetGateway::LIFECYCLE_STATE_ENUM.'
  end

  path = '/internetGateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_internet_gateways') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::InternetGateway>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_ip_inventory(list_ip_inventory_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_ip_inventory API.

Lists the IP Inventory information in the selected compartments.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
 
# File 'lib/oci/core/virtual_network_client.rb', line 12685

def list_ip_inventory(list_ip_inventory_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_ip_inventory.' if logger

  raise "Missing the required parameter 'list_ip_inventory_details' when calling list_ip_inventory." if list_ip_inventory_details.nil?

  path = '/ipInventory'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(list_ip_inventory_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ip_inventory') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IpInventoryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_ip_sec_connection_tunnel_routes(ipsc_id, tunnel_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_ip_sec_connection_tunnel_routes API.

The routes advertised to the on-premises network and the routes received from the on-premises network.

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • tunnel_id (String) —

    The OCID of the tunnel.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :advertiser (String) —

    Specifies the advertiser of the routes. If set to ORACLE, this returns only the routes advertised by Oracle. When set to CUSTOMER, this returns only the routes advertised by the CPE.

Returns:



12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
 
# File 'lib/oci/core/virtual_network_client.rb', line 12753

def list_ip_sec_connection_tunnel_routes(ipsc_id, tunnel_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_ip_sec_connection_tunnel_routes.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling list_ip_sec_connection_tunnel_routes." if ipsc_id.nil?
  raise "Missing the required parameter 'tunnel_id' when calling list_ip_sec_connection_tunnel_routes." if tunnel_id.nil?

  if opts[:advertiser] && !OCI::Core::Models::TunnelRouteSummary::ADVERTISER_ENUM.include?(opts[:advertiser])
    raise 'Invalid value for "advertiser", must be one of the values in OCI::Core::Models::TunnelRouteSummary::ADVERTISER_ENUM.'
  end
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)
  raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id)

  path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/routes'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:advertiser] = opts[:advertiser] if opts[:advertiser]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ip_sec_connection_tunnel_routes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::TunnelRouteSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_ip_sec_connection_tunnel_security_associations(ipsc_id, tunnel_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_ip_sec_connection_tunnel_security_associations API.

Lists the tunnel security associations information for the specified IPSec tunnel ID.

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • tunnel_id (String) —

    The OCID of the tunnel.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
 
# File 'lib/oci/core/virtual_network_client.rb', line 12826

def list_ip_sec_connection_tunnel_security_associations(ipsc_id, tunnel_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_ip_sec_connection_tunnel_security_associations.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling list_ip_sec_connection_tunnel_security_associations." if ipsc_id.nil?
  raise "Missing the required parameter 'tunnel_id' when calling list_ip_sec_connection_tunnel_security_associations." if tunnel_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)
  raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id)

  path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelSecurityAssociations'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ip_sec_connection_tunnel_security_associations') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::TunnelSecurityAssociationSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_ip_sec_connection_tunnels(ipsc_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_ip_sec_connection_tunnels API.

Lists the tunnel information for the specified IPSec connection.

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
 
# File 'lib/oci/core/virtual_network_client.rb', line 12893

def list_ip_sec_connection_tunnels(ipsc_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_ip_sec_connection_tunnels.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling list_ip_sec_connection_tunnels." if ipsc_id.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)

  path = '/ipsecConnections/{ipscId}/tunnels'.sub('{ipscId}', ipsc_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ip_sec_connection_tunnels') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::IPSecConnectionTunnel>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_ip_sec_connections(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_ip_sec_connections API.

Lists the IPSec connections for the specified compartment. You can filter the results by DRG or CPE.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :drg_id (String) —

    The OCID of the DRG.

  • :cpe_id (String) —

    The OCID of the CPE.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
 
# File 'lib/oci/core/virtual_network_client.rb', line 12961

def list_ip_sec_connections(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_ip_sec_connections.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_ip_sec_connections." if compartment_id.nil?

  path = '/ipsecConnections'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:drgId] = opts[:drg_id] if opts[:drg_id]
  query_params[:cpeId] = opts[:cpe_id] if opts[:cpe_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ip_sec_connections') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::IPSecConnection>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_ipv6s(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_ipv6s API.

Lists the Ipv6 objects based on one of these filters:

  • Subnet OCID.

  • VNIC OCID.

  • Both IPv6 address and subnet OCID: This lets you get an Ipv6 object based on its private IPv6 address (for example, 2001:0db8:0123:1111:abcd:ef01:2345:6789) and not its OCID. For comparison, #get_ipv6 get_ipv6} requires the {OCID.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :ip_address (String) —

    An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

  • :subnet_id (String) —

    The OCID of the subnet.

  • :vnic_id (String) —

    The OCID of the VNIC.

  • :ip_state (String) —

    State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

  • :lifetime (String) —

    Lifetime of the IP address. There are two types of IPs: - Ephemeral - Reserved

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type Array<Ipv6>



13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
 
# File 'lib/oci/core/virtual_network_client.rb', line 13048

def list_ipv6s(opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_ipv6s.' if logger


  path = '/ipv6'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:ipAddress] = opts[:ip_address] if opts[:ip_address]
  query_params[:subnetId] = opts[:subnet_id] if opts[:subnet_id]
  query_params[:vnicId] = opts[:vnic_id] if opts[:vnic_id]
  query_params[:ipState] = opts[:ip_state] if opts[:ip_state]
  query_params[:lifetime] = opts[:lifetime] if opts[:lifetime]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ipv6s') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::Ipv6>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_local_peering_gateways(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_local_peering_gateways API.

Lists the local peering gateways (LPGs) for the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the LPGs from all VCNs in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :vcn_id (String) —

    The OCID of the VCN.

Returns:



13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
 
# File 'lib/oci/core/virtual_network_client.rb', line 13119

def list_local_peering_gateways(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_local_peering_gateways.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_local_peering_gateways." if compartment_id.nil?

  path = '/localPeeringGateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_local_peering_gateways') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::LocalPeeringGateway>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_nat_gateways(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_nat_gateways API.

Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :vcn_id (String) —

    The OCID of the VCN.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Returns:



13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
 
# File 'lib/oci/core/virtual_network_client.rb', line 13206

def list_nat_gateways(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_nat_gateways.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_nat_gateways." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::NatGateway::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::NatGateway::LIFECYCLE_STATE_ENUM.'
  end

  path = '/natGateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_nat_gateways') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::NatGateway>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_network_security_group_security_rules(network_security_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_network_security_group_security_rules API.

Lists the security rules in the specified network security group.

Parameters:

  • network_security_group_id (String) —

    The OCID of the network security group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :direction (String) —

    Direction of the security rule. Set to EGRESS for rules that allow outbound IP packets, or INGRESS for rules that allow inbound IP packets.

    Allowed values are: EGRESS, INGRESS

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_by (String) —

    The field to sort by. Allowed values are: TIMECREATED

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

Returns:



13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
 
# File 'lib/oci/core/virtual_network_client.rb', line 13298

def list_network_security_group_security_rules(network_security_group_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_network_security_group_security_rules.' if logger

  raise "Missing the required parameter 'network_security_group_id' when calling list_network_security_group_security_rules." if network_security_group_id.nil?

  if opts[:direction] && !%w[EGRESS INGRESS].include?(opts[:direction])
    raise 'Invalid value for "direction", must be one of EGRESS, INGRESS.'
  end

  if opts[:sort_by] && !%w[TIMECREATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id)

  path = '/networkSecurityGroups/{networkSecurityGroupId}/securityRules'.sub('{networkSecurityGroupId}', network_security_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:direction] = opts[:direction] if opts[:direction]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_network_security_group_security_rules') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::SecurityRule>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_network_security_group_vnics(network_security_group_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_network_security_group_vnics API.

Lists the VNICs in the specified network security group.

Parameters:

  • network_security_group_id (String) —

    The OCID of the network security group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_by (String) —

    The field to sort by. Allowed values are: TIMEASSOCIATED

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

Returns:



13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
 
# File 'lib/oci/core/virtual_network_client.rb', line 13384

def list_network_security_group_vnics(network_security_group_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_network_security_group_vnics.' if logger

  raise "Missing the required parameter 'network_security_group_id' when calling list_network_security_group_vnics." if network_security_group_id.nil?

  if opts[:sort_by] && !%w[TIMEASSOCIATED].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMEASSOCIATED.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end
  raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id)

  path = '/networkSecurityGroups/{networkSecurityGroupId}/vnics'.sub('{networkSecurityGroupId}', network_security_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_network_security_group_vnics') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::NetworkSecurityGroupVnic>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_network_security_groups(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_network_security_groups API.

Lists either the network security groups in the specified compartment, or those associated with the specified VLAN. You must specify either a vlanId or a compartmentId, but not both. If you specify a vlanId, all other parameters are ignored.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :compartment_id (String) —

    The OCID of the compartment.

  • :vlan_id (String) —

    The OCID of the VLAN.

  • :vcn_id (String) —

    The OCID of the VCN.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Returns:



13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
 
# File 'lib/oci/core/virtual_network_client.rb', line 13481

def list_network_security_groups(opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_network_security_groups.' if logger


  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::NetworkSecurityGroup::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::NetworkSecurityGroup::LIFECYCLE_STATE_ENUM.'
  end

  path = '/networkSecurityGroups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:vlanId] = opts[:vlan_id] if opts[:vlan_id]
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_network_security_groups') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::NetworkSecurityGroup>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_private_ips(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_private_ips API.

Lists the PrivateIp objects based on one of these filters:

If you're listing all the private IPs associated with a given subnet or VNIC, the response includes both primary and secondary private IPs.

If you are an Oracle Cloud VMware Solution customer and have VLANs in your VCN, you can filter the list by VLAN OCID. See {Vlan.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :ip_address (String) —

    An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3

  • :subnet_id (String) —

    The OCID of the subnet.

  • :vnic_id (String) —

    The OCID of the VNIC.

  • :ip_state (String) —

    State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE

  • :lifetime (String) —

    Lifetime of the IP address. There are two types of IPs: - Ephemeral - Reserved

  • :vlan_id (String) —

    The OCID of the VLAN.

Returns:



13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
 
# File 'lib/oci/core/virtual_network_client.rb', line 13589

def list_private_ips(opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_private_ips.' if logger


  path = '/privateIps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:ipAddress] = opts[:ip_address] if opts[:ip_address]
  query_params[:subnetId] = opts[:subnet_id] if opts[:subnet_id]
  query_params[:vnicId] = opts[:vnic_id] if opts[:vnic_id]
  query_params[:ipState] = opts[:ip_state] if opts[:ip_state]
  query_params[:lifetime] = opts[:lifetime] if opts[:lifetime]
  query_params[:vlanId] = opts[:vlan_id] if opts[:vlan_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_private_ips') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::PrivateIp>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_public_ip_pools(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_public_ip_pools API.

Lists the public IP pools in the specified compartment. You can filter the list using query parameters.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :byoip_range_id (String) —

    A filter to return only resources that match the given BYOIP CIDR block.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

Returns:



13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
 
# File 'lib/oci/core/virtual_network_client.rb', line 13680

def list_public_ip_pools(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_public_ip_pools.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_public_ip_pools." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = '/publicIpPools'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:byoipRangeId] = opts[:byoip_range_id] if opts[:byoip_range_id]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_public_ip_pools') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PublicIpPoolCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_public_ips(scope, compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_public_ips API.

Lists the PublicIp objects in the specified compartment. You can filter the list by using query parameters.

To list your reserved public IPs: * Set scope = REGION (required) * Leave the availabilityDomain parameter empty * Set lifetime = RESERVED

To list the ephemeral public IPs assigned to a regional entity such as a NAT gateway: * Set scope = REGION (required) * Leave the availabilityDomain parameter empty * Set lifetime = EPHEMERAL

To list the ephemeral public IPs assigned to private IPs: * Set scope = AVAILABILITY_DOMAIN (required) * Set the availabilityDomain parameter to the desired availability domain (required) * Set lifetime = EPHEMERAL

Note: An ephemeral public IP assigned to a private IP is always in the same availability domain and compartment as the private IP.

Parameters:

  • scope (String) —

    Whether the public IP is regional or specific to a particular availability domain.

    • REGION: The public IP exists within a region and is assigned to a regional entity (such as a NatGateway), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs have scope = REGION, as do ephemeral public IPs assigned to a regional entity.

    • AVAILABILITY_DOMAIN: The public IP exists within the availability domain of the entity it's assigned to, which is specified by the availabilityDomain property of the public IP object. Ephemeral public IPs that are assigned to private IPs have scope = AVAILABILITY_DOMAIN.

    Allowed values are: REGION, AVAILABILITY_DOMAIN

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :availability_domain (String) —

    The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • :lifetime (String) —

    A filter to return only public IPs that match given lifetime.

    Allowed values are: EPHEMERAL, RESERVED

  • :public_ip_pool_id (String) —

    A filter to return only resources that belong to the given public IP pool.

Returns:



13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
 
# File 'lib/oci/core/virtual_network_client.rb', line 13798

def list_public_ips(scope, compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_public_ips.' if logger

  raise "Missing the required parameter 'scope' when calling list_public_ips." if scope.nil?
  unless %w[REGION AVAILABILITY_DOMAIN].include?(scope)
    raise "Invalid value for 'scope', must be one of REGION, AVAILABILITY_DOMAIN."
  end
  raise "Missing the required parameter 'compartment_id' when calling list_public_ips." if compartment_id.nil?

  if opts[:lifetime] && !%w[EPHEMERAL RESERVED].include?(opts[:lifetime])
    raise 'Invalid value for "lifetime", must be one of EPHEMERAL, RESERVED.'
  end

  path = '/publicIps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:scope] = scope
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain]
  query_params[:lifetime] = opts[:lifetime] if opts[:lifetime]
  query_params[:publicIpPoolId] = opts[:public_ip_pool_id] if opts[:public_ip_pool_id]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_public_ips') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::PublicIp>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_remote_peering_connections(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_remote_peering_connections API.

Lists the remote peering connections (RPCs) for the specified DRG and compartment (the RPC's compartment).

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :drg_id (String) —

    The OCID of the DRG.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
 
# File 'lib/oci/core/virtual_network_client.rb', line 13877

def list_remote_peering_connections(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_remote_peering_connections.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_remote_peering_connections." if compartment_id.nil?

  path = '/remotePeeringConnections'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:drgId] = opts[:drg_id] if opts[:drg_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_remote_peering_connections') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::RemotePeeringConnection>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_route_tables(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_route_tables API.

Lists the route tables in the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the route tables from all VCNs in the specified compartment. The response includes the default route table that automatically comes with each VCN in the specified compartment, plus any route tables you've created.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :vcn_id (String) —

    The OCID of the VCN.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Returns:



13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
 
# File 'lib/oci/core/virtual_network_client.rb', line 13966

def list_route_tables(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_route_tables.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_route_tables." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::RouteTable::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::RouteTable::LIFECYCLE_STATE_ENUM.'
  end

  path = '/routeTables'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_route_tables') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::RouteTable>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_security_lists(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_security_lists API.

Lists the security lists in the specified VCN and compartment. If the VCN ID is not provided, then the list includes the security lists from all VCNs in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :vcn_id (String) —

    The OCID of the VCN.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Returns:



14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
 
# File 'lib/oci/core/virtual_network_client.rb', line 14069

def list_security_lists(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_security_lists.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_security_lists." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::SecurityList::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::SecurityList::LIFECYCLE_STATE_ENUM.'
  end

  path = '/securityLists'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_security_lists') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::SecurityList>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_service_gateways(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_service_gateways API.

Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :vcn_id (String) —

    The OCID of the VCN.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

Returns:



14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
 
# File 'lib/oci/core/virtual_network_client.rb', line 14170

def list_service_gateways(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_service_gateways.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_service_gateways." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::ServiceGateway::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::ServiceGateway::LIFECYCLE_STATE_ENUM.'
  end

  path = '/serviceGateways'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_service_gateways') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::ServiceGateway>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_services(opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_services API.

Lists the available Service objects that you can enable for a service gateway in this region.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
 
# File 'lib/oci/core/virtual_network_client.rb', line 14251

def list_services(opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_services.' if logger


  path = '/services'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_services') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::Service>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_subnets(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_subnets API.

Lists the subnets in the specified VCN and the specified compartment. If the VCN ID is not provided, then the list includes the subnets from all VCNs in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :vcn_id (String) —

    The OCID of the VCN.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Returns:



14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
 
# File 'lib/oci/core/virtual_network_client.rb', line 14335

def list_subnets(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_subnets.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_subnets." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::Subnet::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::Subnet::LIFECYCLE_STATE_ENUM.'
  end

  path = '/subnets'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_subnets') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::Subnet>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vcns(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_vcns API.

Lists the virtual cloud networks (VCNs) in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Returns:

  • (Response) —

    A Response object with data of type Array<Vcn>



14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
 
# File 'lib/oci/core/virtual_network_client.rb', line 14436

def list_vcns(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_vcns.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_vcns." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::Vcn::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::Vcn::LIFECYCLE_STATE_ENUM.'
  end

  path = '/vcns'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_vcns') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::Vcn>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_virtual_circuit_associated_tunnels(virtual_circuit_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_virtual_circuit_associated_tunnels API.

Gets the specified virtual circuit's associatedTunnelsInfo.

Parameters:

  • virtual_circuit_id (String) —

    The OCID of the virtual circuit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
 
# File 'lib/oci/core/virtual_network_client.rb', line 14516

def list_virtual_circuit_associated_tunnels(virtual_circuit_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_virtual_circuit_associated_tunnels.' if logger

  raise "Missing the required parameter 'virtual_circuit_id' when calling list_virtual_circuit_associated_tunnels." if virtual_circuit_id.nil?
  raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id)

  path = '/virtualCircuits/{virtualCircuitId}/associatedTunnels'.sub('{virtualCircuitId}', virtual_circuit_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_virtual_circuit_associated_tunnels') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::VirtualCircuitAssociatedTunnelDetails>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_virtual_circuit_bandwidth_shapes(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_virtual_circuit_bandwidth_shapes API.

The operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the OCID of your tenancy (the root compartment).

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Returns:



14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
 
# File 'lib/oci/core/virtual_network_client.rb', line 14581

def list_virtual_circuit_bandwidth_shapes(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_virtual_circuit_bandwidth_shapes.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_virtual_circuit_bandwidth_shapes." if compartment_id.nil?

  path = '/virtualCircuitBandwidthShapes'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_virtual_circuit_bandwidth_shapes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::VirtualCircuitBandwidthShape>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_virtual_circuit_public_prefixes(virtual_circuit_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_virtual_circuit_public_prefixes API.

Lists the public IP prefixes and their details for the specified public virtual circuit.

Parameters:

  • virtual_circuit_id (String) —

    The OCID of the virtual circuit.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :verification_state (String) —

    A filter to only return resources that match the given verification state.

    The state value is case-insensitive.

Returns:



14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
 
# File 'lib/oci/core/virtual_network_client.rb', line 14642

def list_virtual_circuit_public_prefixes(virtual_circuit_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_virtual_circuit_public_prefixes.' if logger

  raise "Missing the required parameter 'virtual_circuit_id' when calling list_virtual_circuit_public_prefixes." if virtual_circuit_id.nil?

  if opts[:verification_state] && !OCI::Core::Models::VirtualCircuitPublicPrefix::VERIFICATION_STATE_ENUM.include?(opts[:verification_state])
    raise 'Invalid value for "verification_state", must be one of the values in OCI::Core::Models::VirtualCircuitPublicPrefix::VERIFICATION_STATE_ENUM.'
  end
  raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id)

  path = '/virtualCircuits/{virtualCircuitId}/publicPrefixes'.sub('{virtualCircuitId}', virtual_circuit_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:verificationState] = opts[:verification_state] if opts[:verification_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_virtual_circuit_public_prefixes') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::VirtualCircuitPublicPrefix>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_virtual_circuits(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_virtual_circuits API.

Lists the virtual circuits in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :lifecycle_state (String) —

    A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Returns:



14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
 
# File 'lib/oci/core/virtual_network_client.rb', line 14729

def list_virtual_circuits(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_virtual_circuits.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_virtual_circuits." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::VirtualCircuit::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::VirtualCircuit::LIFECYCLE_STATE_ENUM.'
  end

  path = '/virtualCircuits'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_virtual_circuits') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::VirtualCircuit>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vlans(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_vlans API.

Lists the VLANs in the specified VCN and the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :vcn_id (String) —

    The OCID of the VCN.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :lifecycle_state (String) —

    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

Returns:

  • (Response) —

    A Response object with data of type Array<Vlan>



14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
 
# File 'lib/oci/core/virtual_network_client.rb', line 14833

def list_vlans(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_vlans.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_vlans." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::Vlan::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::Vlan::LIFECYCLE_STATE_ENUM.'
  end

  path = '/vlans'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_vlans') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::Vlan>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_vtaps(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_vtaps API.

Lists the virtual test access points (VTAPs) in the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :vcn_id (String) —

    The OCID of the VCN.

  • :source (String) —

    The OCID of the VTAP source.

  • :target_id (String) —

    The OCID of the VTAP target.

  • :target_ip (String) —

    The IP address of the VTAP target.

  • :is_vtap_enabled (BOOLEAN) —

    Indicates whether to list all VTAPs or only running VTAPs.

    • When FALSE, lists ALL running and stopped VTAPs.

    • When TRUE, lists only running VTAPs (VTAPs where isVtapEnabled = TRUE). (default to false)

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: TIMECREATED, DISPLAYNAME

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC) Allowed values are: ASC, DESC

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given VTAP administrative lifecycle state. The state value is case-insensitive.

Returns:

  • (Response) —

    A Response object with data of type Array<Vtap>



14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
 
# File 'lib/oci/core/virtual_network_client.rb', line 14947

def list_vtaps(compartment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#list_vtaps.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_vtaps." if compartment_id.nil?

  if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  if opts[:lifecycle_state] && !OCI::Core::Models::Vtap::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::Vtap::LIFECYCLE_STATE_ENUM.'
  end

  path = '/vtaps'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id]
  query_params[:source] = opts[:source] if opts[:source]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:targetIp] = opts[:target_ip] if opts[:target_ip]
  query_params[:isVtapEnabled] = opts[:is_vtap_enabled] if !opts[:is_vtap_enabled].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_vtaps') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::Vtap>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



100
101
102
 
# File 'lib/oci/core/virtual_network_client.rb', line 100

def logger
  @api_client.config.logger
end

#modify_ipv4_subnet_cidr(subnet_id, modify_ipv4_subnet_cidr_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use modify_ipv4_subnet_cidr API.

Updates the specified Ipv4 CIDR block of a Subnet. The new Ipv4 CIDR IP range must meet the following criteria:

  • Must be valid.

  • Must not overlap with another Ipv4 CIDR block in the Subnet or the on-premises network CIDR block.

  • Must not exceed the limit of Ipv4 CIDR blocks allowed per Subnet.

  • Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules.

  • No IP address in an existing subnet should be outside of the new CIDR block range.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
 
# File 'lib/oci/core/virtual_network_client.rb', line 15044

def modify_ipv4_subnet_cidr(subnet_id, modify_ipv4_subnet_cidr_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#modify_ipv4_subnet_cidr.' if logger

  raise "Missing the required parameter 'subnet_id' when calling modify_ipv4_subnet_cidr." if subnet_id.nil?
  raise "Missing the required parameter 'modify_ipv4_subnet_cidr_details' when calling modify_ipv4_subnet_cidr." if modify_ipv4_subnet_cidr_details.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/subnets/{subnetId}/actions/modifyIpv4Cidr'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(modify_ipv4_subnet_cidr_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#modify_ipv4_subnet_cidr') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#modify_vcn_cidr(vcn_id, modify_vcn_cidr_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use modify_vcn_cidr API.

Updates the specified CIDR block of a VCN. The new CIDR IP range must meet the following criteria:

  • Must be valid.

  • Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.

  • Must not exceed the limit of CIDR blocks allowed per VCN.

  • Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules.

  • No IP address in an existing subnet should be outside of the new CIDR block range.

Note: Modifying a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can vary depending on the size of your network. Updating a small network could take about a minute, and updating a large network could take up to an hour. You can use the GetWorkRequest operation to check the status of the update.

Parameters:

  • vcn_id (String) —

    Specify the OCID of the VCN.

  • modify_vcn_cidr_details (OCI::Core::Models::ModifyVcnCidrDetails) —

    Details object for updating a VCN CIDR.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
 
# File 'lib/oci/core/virtual_network_client.rb', line 15123

def modify_vcn_cidr(vcn_id, modify_vcn_cidr_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#modify_vcn_cidr.' if logger

  raise "Missing the required parameter 'vcn_id' when calling modify_vcn_cidr." if vcn_id.nil?
  raise "Missing the required parameter 'modify_vcn_cidr_details' when calling modify_vcn_cidr." if modify_vcn_cidr_details.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/vcns/{vcnId}/actions/modifyCidr'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(modify_vcn_cidr_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#modify_vcn_cidr') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_subnet(subnet_id, patch_subnet_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_subnet API.

Updates a Subnet by evaluating a sequence of patch instructions (JSON List Patch). This operation is restricted to IPv6 CIDR-related fields only. Supported selections (exact match) are: - ipv6CidrBlock - ipv6CidrBlocks Only the REPLACE operation is supported. The request must include the If-Match header for optimistic concurrency control. This is an asynchronous operation. The subnetu2019s lifecycleState is set to UPDATING while the patch work request is in progress, and changes back to AVAILABLE after the patch operation is complete. All patch instructions are applied atomically as a single operation; either all succeed or none are applied.

Parameters:

  • subnet_id (String) —

    Specify the OCID of the subnet.

  • patch_subnet_details (OCI::Core::Models::PatchSubnetDetails) —

    Details object for patching a subnet.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
 
# File 'lib/oci/core/virtual_network_client.rb', line 15203

def patch_subnet(subnet_id, patch_subnet_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#patch_subnet.' if logger

  raise "Missing the required parameter 'subnet_id' when calling patch_subnet." if subnet_id.nil?
  raise "Missing the required parameter 'patch_subnet_details' when calling patch_subnet." if patch_subnet_details.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/subnets/{subnetId}'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(patch_subnet_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#patch_subnet') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#patch_vcn(vcn_id, patch_vcn_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use patch_vcn API.

Updates a VCN by evaluating a sequence of patch instructions (JSON List Patch). This operation is restricted to IPv6 CIDR-related fields only. Supported selections (exact match) are: - ipv6CidrBlock - ipv6PublicCidrBlock - ipv6PrivateCidrBlocks - byoipv6CidrDetails Only the REPLACE operation is supported. The request must include the If-Match header for optimistic concurrency control. This is an asynchronous operation. The VCNu2019s lifecycleState is set to UPDATING while the patch work request is in progress, and changes back to AVAILABLE after the patch operation is complete. All patch instructions are applied atomically as a single operation; either all succeed or none are applied. NOTE: ipv6PublicCidrBlock represents Oracle provided GUA on VCN. With PATCH API, customer can only remove it if present. Since this is Oracle provided CIDR, there is no concept of replacing with customer provided CIDR.

Parameters:

  • vcn_id (String) —

    Specify the OCID of the VCN.

  • patch_vcn_details (OCI::Core::Models::PatchVcnDetails) —

    Details object for patching a VCN.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
 
# File 'lib/oci/core/virtual_network_client.rb', line 15288

def patch_vcn(vcn_id, patch_vcn_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#patch_vcn.' if logger

  raise "Missing the required parameter 'vcn_id' when calling patch_vcn." if vcn_id.nil?
  raise "Missing the required parameter 'patch_vcn_details' when calling patch_vcn." if patch_vcn_details.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/vcns/{vcnId}'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(patch_vcn_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#patch_vcn') do
    @api_client.call_api(
      :PATCH,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#private_ip_vnic_detach(private_ip_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use private_ip_vnic_detach API.

Unassign the specified PrivateIP address from Virtual Network Interface Card (VNIC). You must specify the PrivateIP OCID.

Parameters:

  • private_ip_id (String) —

    The OCID of the private IP or IPv6.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
 
# File 'lib/oci/core/virtual_network_client.rb', line 15358

def private_ip_vnic_detach(private_ip_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#private_ip_vnic_detach.' if logger

  raise "Missing the required parameter 'private_ip_id' when calling private_ip_vnic_detach." if private_ip_id.nil?
  raise "Parameter value for 'private_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(private_ip_id)

  path = '/privateIps/{privateIpId}/actions/detach'.sub('{privateIpId}', private_ip_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#private_ip_vnic_detach') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PrivateIp'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_drg_route_distribution_statements(drg_route_distribution_id, remove_drg_route_distribution_statements_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_drg_route_distribution_statements API.

Removes one or more route distribution statements from the specified route distribution's map.

Parameters:

  • drg_route_distribution_id (String) —

    The OCID of the route distribution.

  • remove_drg_route_distribution_statements_details (OCI::Core::Models::RemoveDrgRouteDistributionStatementsDetails) —

    Request with one or more route distribution statements to remove from the route distribution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:

  • (Response) —

    A Response object with data of type nil



15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
 
# File 'lib/oci/core/virtual_network_client.rb', line 15418

def remove_drg_route_distribution_statements(drg_route_distribution_id, remove_drg_route_distribution_statements_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#remove_drg_route_distribution_statements.' if logger

  raise "Missing the required parameter 'drg_route_distribution_id' when calling remove_drg_route_distribution_statements." if drg_route_distribution_id.nil?
  raise "Missing the required parameter 'remove_drg_route_distribution_statements_details' when calling remove_drg_route_distribution_statements." if remove_drg_route_distribution_statements_details.nil?
  raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id)

  path = '/drgRouteDistributions/{drgRouteDistributionId}/actions/removeDrgRouteDistributionStatements'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(remove_drg_route_distribution_statements_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_drg_route_distribution_statements') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_drg_route_rules(drg_route_table_id, remove_drg_route_rules_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_drg_route_rules API.

Removes one or more route rules from the specified DRG route table.

Parameters:

  • drg_route_table_id (String) —

    The OCID of the DRG route table.

  • remove_drg_route_rules_details (OCI::Core::Models::RemoveDrgRouteRulesDetails) —

    Request to remove one or more route rules in the DRG route table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:

  • (Response) —

    A Response object with data of type nil



15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
 
# File 'lib/oci/core/virtual_network_client.rb', line 15475

def remove_drg_route_rules(drg_route_table_id, remove_drg_route_rules_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#remove_drg_route_rules.' if logger

  raise "Missing the required parameter 'drg_route_table_id' when calling remove_drg_route_rules." if drg_route_table_id.nil?
  raise "Missing the required parameter 'remove_drg_route_rules_details' when calling remove_drg_route_rules." if remove_drg_route_rules_details.nil?
  raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id)

  path = '/drgRouteTables/{drgRouteTableId}/actions/removeDrgRouteRules'.sub('{drgRouteTableId}', drg_route_table_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(remove_drg_route_rules_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_drg_route_rules') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_export_drg_route_distribution(drg_attachment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_export_drg_route_distribution API.

Removes the export route distribution from the DRG attachment so no routes are advertised to it.

Parameters:

  • drg_attachment_id (String) —

    The OCID of the DRG attachment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
 
# File 'lib/oci/core/virtual_network_client.rb', line 15536

def remove_export_drg_route_distribution(drg_attachment_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#remove_export_drg_route_distribution.' if logger

  raise "Missing the required parameter 'drg_attachment_id' when calling remove_export_drg_route_distribution." if drg_attachment_id.nil?
  raise "Parameter value for 'drg_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_attachment_id)

  path = '/drgAttachments/{drgAttachmentId}/actions/removeExportDrgRouteDistribution'.sub('{drgAttachmentId}', drg_attachment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_export_drg_route_distribution') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgAttachment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_import_drg_route_distribution(drg_route_table_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_import_drg_route_distribution API.

Removes the import route distribution from the DRG route table so no routes are imported into it.

Parameters:

  • drg_route_table_id (String) —

    The OCID of the DRG route table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
 
# File 'lib/oci/core/virtual_network_client.rb', line 15599

def remove_import_drg_route_distribution(drg_route_table_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#remove_import_drg_route_distribution.' if logger

  raise "Missing the required parameter 'drg_route_table_id' when calling remove_import_drg_route_distribution." if drg_route_table_id.nil?
  raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id)

  path = '/drgRouteTables/{drgRouteTableId}/actions/removeImportDrgRouteDistribution'.sub('{drgRouteTableId}', drg_route_table_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_import_drg_route_distribution') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgRouteTable'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_ipv4_subnet_cidr(subnet_id, remove_ipv4_subnet_cidr_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_ipv4_subnet_cidr API.

Remove an IPv4 prefix from a subnet

Parameters:

  • subnet_id (String) —

    Specify the OCID of the subnet.

  • remove_ipv4_subnet_cidr_details (OCI::Core::Models::RemoveIpv4SubnetCidrDetails) —

    Details object for removing an IPv4 SUBNET prefix.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
 
# File 'lib/oci/core/virtual_network_client.rb', line 15668

def remove_ipv4_subnet_cidr(subnet_id, remove_ipv4_subnet_cidr_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#remove_ipv4_subnet_cidr.' if logger

  raise "Missing the required parameter 'subnet_id' when calling remove_ipv4_subnet_cidr." if subnet_id.nil?
  raise "Missing the required parameter 'remove_ipv4_subnet_cidr_details' when calling remove_ipv4_subnet_cidr." if remove_ipv4_subnet_cidr_details.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/subnets/{subnetId}/actions/removeIpv4Cidr'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_ipv4_subnet_cidr_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_ipv4_subnet_cidr') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_ipv6_subnet_cidr(subnet_id, remove_subnet_ipv6_cidr_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_ipv6_subnet_cidr API.

Remove an IPv6 prefix from a subnet. At least one IPv6 CIDR should remain.

Parameters:

  • subnet_id (String) —

    Specify the OCID of the subnet.

  • remove_subnet_ipv6_cidr_details (OCI::Core::Models::RemoveSubnetIpv6CidrDetails) —

    Details object for removing an IPv6 SUBNET prefix.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
 
# File 'lib/oci/core/virtual_network_client.rb', line 15739

def remove_ipv6_subnet_cidr(subnet_id, remove_subnet_ipv6_cidr_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#remove_ipv6_subnet_cidr.' if logger

  raise "Missing the required parameter 'subnet_id' when calling remove_ipv6_subnet_cidr." if subnet_id.nil?
  raise "Missing the required parameter 'remove_subnet_ipv6_cidr_details' when calling remove_ipv6_subnet_cidr." if remove_subnet_ipv6_cidr_details.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/subnets/{subnetId}/actions/removeIpv6Cidr'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_subnet_ipv6_cidr_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_ipv6_subnet_cidr') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_ipv6_vcn_cidr(vcn_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_ipv6_vcn_cidr API.

Removing an existing IPv6 prefix from a VCN.

Parameters:

  • vcn_id (String) —

    Specify the OCID of the VCN.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :remove_vcn_ipv6_cidr_details (OCI::Core::Models::RemoveVcnIpv6CidrDetails) —

    Details object for removing a VCN IPv6 prefix.

Returns:

  • (Response) —

    A Response object with data of type nil



15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
 
# File 'lib/oci/core/virtual_network_client.rb', line 15810

def remove_ipv6_vcn_cidr(vcn_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#remove_ipv6_vcn_cidr.' if logger

  raise "Missing the required parameter 'vcn_id' when calling remove_ipv6_vcn_cidr." if vcn_id.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/vcns/{vcnId}/actions/removeIpv6Cidr'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(opts[:remove_vcn_ipv6_cidr_details])

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_ipv6_vcn_cidr') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_network_security_group_security_rules(network_security_group_id, remove_network_security_group_security_rules_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_network_security_group_security_rules API.

Removes one or more security rules from the specified network security group.

Parameters:

  • network_security_group_id (String) —

    The OCID of the network security group.

  • remove_network_security_group_security_rules_details (OCI::Core::Models::RemoveNetworkSecurityGroupSecurityRulesDetails) —

    Request with one or more security rules associated with the network security group that will be removed.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:

  • (Response) —

    A Response object with data of type nil



15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
 
# File 'lib/oci/core/virtual_network_client.rb', line 15870

def remove_network_security_group_security_rules(network_security_group_id, remove_network_security_group_security_rules_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#remove_network_security_group_security_rules.' if logger

  raise "Missing the required parameter 'network_security_group_id' when calling remove_network_security_group_security_rules." if network_security_group_id.nil?
  raise "Missing the required parameter 'remove_network_security_group_security_rules_details' when calling remove_network_security_group_security_rules." if remove_network_security_group_security_rules_details.nil?
  raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id)

  path = '/networkSecurityGroups/{networkSecurityGroupId}/actions/removeSecurityRules'.sub('{networkSecurityGroupId}', network_security_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(remove_network_security_group_security_rules_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_network_security_group_security_rules') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_public_ip_pool_capacity(public_ip_pool_id, remove_public_ip_pool_capacity_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_public_ip_pool_capacity API.

Removes a CIDR block from the referenced public IP pool.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:



15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
 
# File 'lib/oci/core/virtual_network_client.rb', line 15934

def remove_public_ip_pool_capacity(public_ip_pool_id, remove_public_ip_pool_capacity_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#remove_public_ip_pool_capacity.' if logger

  raise "Missing the required parameter 'public_ip_pool_id' when calling remove_public_ip_pool_capacity." if public_ip_pool_id.nil?
  raise "Missing the required parameter 'remove_public_ip_pool_capacity_details' when calling remove_public_ip_pool_capacity." if remove_public_ip_pool_capacity_details.nil?
  raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id)

  path = '/publicIpPools/{publicIpPoolId}/actions/removeCapacity'.sub('{publicIpPoolId}', public_ip_pool_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_public_ip_pool_capacity_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_public_ip_pool_capacity') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PublicIpPool'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#remove_vcn_cidr(vcn_id, remove_vcn_cidr_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use remove_vcn_cidr API.

Removes a specified CIDR block from a VCN.

Notes: - You cannot remove a CIDR block if an IP address in its range is in use. - Removing a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the GetWorkRequest operation to check the status of the update.

Parameters:

  • vcn_id (String) —

    Specify the OCID of the VCN.

  • remove_vcn_cidr_details (OCI::Core::Models::RemoveVcnCidrDetails) —

    Details object for removing a VCN CIDR.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
 
# File 'lib/oci/core/virtual_network_client.rb', line 16009

def remove_vcn_cidr(vcn_id, remove_vcn_cidr_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#remove_vcn_cidr.' if logger

  raise "Missing the required parameter 'vcn_id' when calling remove_vcn_cidr." if vcn_id.nil?
  raise "Missing the required parameter 'remove_vcn_cidr_details' when calling remove_vcn_cidr." if remove_vcn_cidr_details.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/vcns/{vcnId}/actions/removeCidr'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(remove_vcn_cidr_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_vcn_cidr') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#set_origin_asn(byoip_range_id, set_origin_asn_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use set_origin_asn API.

Update BYOIP's origin ASN to byoasn.

Parameters:

  • byoip_range_id (String) —

    The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • set_origin_asn_details (OCI::Core::Models::SetOriginAsnDetails) —

    ASN details

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
 
# File 'lib/oci/core/virtual_network_client.rb', line 16080

def set_origin_asn(byoip_range_id, set_origin_asn_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#set_origin_asn.' if logger

  raise "Missing the required parameter 'byoip_range_id' when calling set_origin_asn." if byoip_range_id.nil?
  raise "Missing the required parameter 'set_origin_asn_details' when calling set_origin_asn." if set_origin_asn_details.nil?
  raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id)

  path = '/byoipRanges/{byoipRangeId}/actions/setOrigin/byoasn'.sub('{byoipRangeId}', byoip_range_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(set_origin_asn_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#set_origin_asn') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#set_origin_asn_to_oracle(byoip_range_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use set_origin_asn_to_oracle API.

Update prefix's origin ASN to OCI

Parameters:

  • byoip_range_id (String) —

    The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



16144
16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
 
# File 'lib/oci/core/virtual_network_client.rb', line 16144

def set_origin_asn_to_oracle(byoip_range_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#set_origin_asn_to_oracle.' if logger

  raise "Missing the required parameter 'byoip_range_id' when calling set_origin_asn_to_oracle." if byoip_range_id.nil?
  raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id)

  path = '/byoipRanges/{byoipRangeId}/actions/setOrigin/oracleAsn'.sub('{byoipRangeId}', byoip_range_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#set_origin_asn_to_oracle') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_byoasn(byoasn_id, update_byoasn_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_byoasn API.

Updates the tags or display name associated with the specified BYOASN Resource.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



16206
16207
16208
16209
16210
16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
 
# File 'lib/oci/core/virtual_network_client.rb', line 16206

def update_byoasn(byoasn_id, update_byoasn_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_byoasn.' if logger

  raise "Missing the required parameter 'byoasn_id' when calling update_byoasn." if byoasn_id.nil?
  raise "Missing the required parameter 'update_byoasn_details' when calling update_byoasn." if update_byoasn_details.nil?
  raise "Parameter value for 'byoasn_id' must not be blank" if OCI::Internal::Util.blank_string?(byoasn_id)

  path = '/byoasns/{byoasnId}'.sub('{byoasnId}', byoasn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_byoasn_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_byoasn') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Byoasn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_byoip_range(byoip_range_id, update_byoip_range_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_byoip_range API.

Updates the tags or display name associated to the specified BYOIP CIDR block.

Parameters:

  • byoip_range_id (String) —

    The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • update_byoip_range_details (OCI::Core::Models::UpdateByoipRangeDetails) —

    Byoip Range details.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
16305
16306
16307
16308
 
# File 'lib/oci/core/virtual_network_client.rb', line 16270

def update_byoip_range(byoip_range_id, update_byoip_range_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_byoip_range.' if logger

  raise "Missing the required parameter 'byoip_range_id' when calling update_byoip_range." if byoip_range_id.nil?
  raise "Missing the required parameter 'update_byoip_range_details' when calling update_byoip_range." if update_byoip_range_details.nil?
  raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id)

  path = '/byoipRanges/{byoipRangeId}'.sub('{byoipRangeId}', byoip_range_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_byoip_range_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_byoip_range') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::ByoipRange'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_capture_filter(capture_filter_id, update_capture_filter_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_capture_filter API.

Updates the specified VTAP capture filter's display name or tags.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
 
# File 'lib/oci/core/virtual_network_client.rb', line 16334

def update_capture_filter(capture_filter_id, update_capture_filter_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_capture_filter.' if logger

  raise "Missing the required parameter 'capture_filter_id' when calling update_capture_filter." if capture_filter_id.nil?
  raise "Missing the required parameter 'update_capture_filter_details' when calling update_capture_filter." if update_capture_filter_details.nil?
  raise "Parameter value for 'capture_filter_id' must not be blank" if OCI::Internal::Util.blank_string?(capture_filter_id)

  path = '/captureFilters/{captureFilterId}'.sub('{captureFilterId}', capture_filter_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_capture_filter_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_capture_filter') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CaptureFilter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_cpe(cpe_id, update_cpe_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_cpe API.

Updates the specified CPE's display name or tags. Avoid entering confidential information.

Parameters:

  • cpe_id (String) —

    The OCID of the CPE.

  • update_cpe_details (OCI::Core::Models::UpdateCpeDetails) —

    Details object for updating a CPE.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type Cpe



16396
16397
16398
16399
16400
16401
16402
16403
16404
16405
16406
16407
16408
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
 
# File 'lib/oci/core/virtual_network_client.rb', line 16396

def update_cpe(cpe_id, update_cpe_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_cpe.' if logger

  raise "Missing the required parameter 'cpe_id' when calling update_cpe." if cpe_id.nil?
  raise "Missing the required parameter 'update_cpe_details' when calling update_cpe." if update_cpe_details.nil?
  raise "Parameter value for 'cpe_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_id)

  path = '/cpes/{cpeId}'.sub('{cpeId}', cpe_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_cpe_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_cpe') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Cpe'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_cross_connect(cross_connect_id, update_cross_connect_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_cross_connect API.

Updates the specified cross-connect.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
16470
16471
16472
16473
16474
16475
16476
16477
16478
16479
16480
16481
16482
16483
16484
16485
16486
16487
16488
16489
16490
16491
16492
 
# File 'lib/oci/core/virtual_network_client.rb', line 16455

def update_cross_connect(cross_connect_id, update_cross_connect_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_cross_connect.' if logger

  raise "Missing the required parameter 'cross_connect_id' when calling update_cross_connect." if cross_connect_id.nil?
  raise "Missing the required parameter 'update_cross_connect_details' when calling update_cross_connect." if update_cross_connect_details.nil?
  raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id)

  path = '/crossConnects/{crossConnectId}'.sub('{crossConnectId}', cross_connect_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_cross_connect_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_cross_connect') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CrossConnect'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_cross_connect_group(cross_connect_group_id, update_cross_connect_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_cross_connect_group API.

Updates the specified cross-connect group's display name. Avoid entering confidential information.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
16540
16541
16542
16543
16544
16545
16546
16547
16548
16549
16550
16551
16552
16553
 
# File 'lib/oci/core/virtual_network_client.rb', line 16516

def update_cross_connect_group(cross_connect_group_id, update_cross_connect_group_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_cross_connect_group.' if logger

  raise "Missing the required parameter 'cross_connect_group_id' when calling update_cross_connect_group." if cross_connect_group_id.nil?
  raise "Missing the required parameter 'update_cross_connect_group_details' when calling update_cross_connect_group." if update_cross_connect_group_details.nil?
  raise "Parameter value for 'cross_connect_group_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_group_id)

  path = '/crossConnectGroups/{crossConnectGroupId}'.sub('{crossConnectGroupId}', cross_connect_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_cross_connect_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_cross_connect_group') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::CrossConnectGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_dhcp_options(dhcp_id, update_dhcp_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_dhcp_options API.

Updates the specified set of DHCP options. You can update the display name or the options themselves. Avoid entering confidential information.

Note that the options object you provide replaces the entire existing set of options.

Parameters:

  • dhcp_id (String) —

    The OCID for the set of DHCP options.

  • update_dhcp_details (OCI::Core::Models::UpdateDhcpDetails) —

    Request object for updating a set of DHCP options.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
 
# File 'lib/oci/core/virtual_network_client.rb', line 16579

def update_dhcp_options(dhcp_id, update_dhcp_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_dhcp_options.' if logger

  raise "Missing the required parameter 'dhcp_id' when calling update_dhcp_options." if dhcp_id.nil?
  raise "Missing the required parameter 'update_dhcp_details' when calling update_dhcp_options." if update_dhcp_details.nil?
  raise "Parameter value for 'dhcp_id' must not be blank" if OCI::Internal::Util.blank_string?(dhcp_id)

  path = '/dhcps/{dhcpId}'.sub('{dhcpId}', dhcp_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_dhcp_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_dhcp_options') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DhcpOptions'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_drg(drg_id, update_drg_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_drg API.

Updates the specified DRG's display name or tags. Avoid entering confidential information.

Parameters:

  • drg_id (String) —

    The OCID of the DRG.

  • update_drg_details (OCI::Core::Models::UpdateDrgDetails) —

    Details object for updating a DRG.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type Drg



16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
 
# File 'lib/oci/core/virtual_network_client.rb', line 16639

def update_drg(drg_id, update_drg_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_drg.' if logger

  raise "Missing the required parameter 'drg_id' when calling update_drg." if drg_id.nil?
  raise "Missing the required parameter 'update_drg_details' when calling update_drg." if update_drg_details.nil?
  raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id)

  path = '/drgs/{drgId}'.sub('{drgId}', drg_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_drg_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Drg'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_drg_attachment(drg_attachment_id, update_drg_attachment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_drg_attachment API.

Updates the display name and routing information for the specified DrgAttachment. Avoid entering confidential information.

Parameters:

  • drg_attachment_id (String) —

    The OCID of the DRG attachment.

  • update_drg_attachment_details (OCI::Core::Models::UpdateDrgAttachmentDetails) —

    Details object for updating a DrgAttachment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
16734
16735
16736
16737
 
# File 'lib/oci/core/virtual_network_client.rb', line 16700

def update_drg_attachment(drg_attachment_id, update_drg_attachment_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_drg_attachment.' if logger

  raise "Missing the required parameter 'drg_attachment_id' when calling update_drg_attachment." if drg_attachment_id.nil?
  raise "Missing the required parameter 'update_drg_attachment_details' when calling update_drg_attachment." if update_drg_attachment_details.nil?
  raise "Parameter value for 'drg_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_attachment_id)

  path = '/drgAttachments/{drgAttachmentId}'.sub('{drgAttachmentId}', drg_attachment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_drg_attachment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg_attachment') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgAttachment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_drg_route_distribution(drg_route_distribution_id, update_drg_route_distribution_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_drg_route_distribution API.

Updates the specified route distribution

Parameters:

  • drg_route_distribution_id (String) —

    The OCID of the route distribution.

  • update_drg_route_distribution_details (OCI::Core::Models::UpdateDrgRouteDistributionDetails) —

    Details object for updating a route distribution

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
 
# File 'lib/oci/core/virtual_network_client.rb', line 16760

def update_drg_route_distribution(drg_route_distribution_id, update_drg_route_distribution_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_drg_route_distribution.' if logger

  raise "Missing the required parameter 'drg_route_distribution_id' when calling update_drg_route_distribution." if drg_route_distribution_id.nil?
  raise "Missing the required parameter 'update_drg_route_distribution_details' when calling update_drg_route_distribution." if update_drg_route_distribution_details.nil?
  raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id)

  path = '/drgRouteDistributions/{drgRouteDistributionId}'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_drg_route_distribution_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg_route_distribution') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgRouteDistribution'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_drg_route_distribution_statements(drg_route_distribution_id, update_drg_route_distribution_statements_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_drg_route_distribution_statements API.

Updates one or more route distribution statements in the specified route distribution.

Parameters:

  • drg_route_distribution_id (String) —

    The OCID of the route distribution.

  • update_drg_route_distribution_statements_details (OCI::Core::Models::UpdateDrgRouteDistributionStatementsDetails) —

    Request to update one or more route distribution statements in the route distribution.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



16818
16819
16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
 
# File 'lib/oci/core/virtual_network_client.rb', line 16818

def update_drg_route_distribution_statements(drg_route_distribution_id, update_drg_route_distribution_statements_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_drg_route_distribution_statements.' if logger

  raise "Missing the required parameter 'drg_route_distribution_id' when calling update_drg_route_distribution_statements." if drg_route_distribution_id.nil?
  raise "Missing the required parameter 'update_drg_route_distribution_statements_details' when calling update_drg_route_distribution_statements." if update_drg_route_distribution_statements_details.nil?
  raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id)

  path = '/drgRouteDistributions/{drgRouteDistributionId}/actions/updateDrgRouteDistributionStatements'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_drg_route_distribution_statements_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg_route_distribution_statements') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::DrgRouteDistributionStatement>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_drg_route_rules(drg_route_table_id, update_drg_route_rules_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_drg_route_rules API.

Updates one or more route rules in the specified DRG route table.

Parameters:

  • drg_route_table_id (String) —

    The OCID of the DRG route table.

  • update_drg_route_rules_details (OCI::Core::Models::UpdateDrgRouteRulesDetails) —

    Request to update one or more route rules in the DRG route table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



16876
16877
16878
16879
16880
16881
16882
16883
16884
16885
16886
16887
16888
16889
16890
16891
16892
16893
16894
16895
16896
16897
16898
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
 
# File 'lib/oci/core/virtual_network_client.rb', line 16876

def update_drg_route_rules(drg_route_table_id, update_drg_route_rules_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_drg_route_rules.' if logger

  raise "Missing the required parameter 'drg_route_table_id' when calling update_drg_route_rules." if drg_route_table_id.nil?
  raise "Missing the required parameter 'update_drg_route_rules_details' when calling update_drg_route_rules." if update_drg_route_rules_details.nil?
  raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id)

  path = '/drgRouteTables/{drgRouteTableId}/actions/updateDrgRouteRules'.sub('{drgRouteTableId}', drg_route_table_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_drg_route_rules_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg_route_rules') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'Array<OCI::Core::Models::DrgRouteRule>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_drg_route_table(drg_route_table_id, update_drg_route_table_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_drg_route_table API.

Updates the specified DRG route table.

Parameters:

  • drg_route_table_id (String) —

    The OCID of the DRG route table.

  • update_drg_route_table_details (OCI::Core::Models::UpdateDrgRouteTableDetails) —

    Details object used to updating a DRG route table.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
 
# File 'lib/oci/core/virtual_network_client.rb', line 16936

def update_drg_route_table(drg_route_table_id, update_drg_route_table_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_drg_route_table.' if logger

  raise "Missing the required parameter 'drg_route_table_id' when calling update_drg_route_table." if drg_route_table_id.nil?
  raise "Missing the required parameter 'update_drg_route_table_details' when calling update_drg_route_table." if update_drg_route_table_details.nil?
  raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id)

  path = '/drgRouteTables/{drgRouteTableId}'.sub('{drgRouteTableId}', drg_route_table_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_drg_route_table_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg_route_table') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::DrgRouteTable'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_internet_gateway(ig_id, update_internet_gateway_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_internet_gateway API.

Updates the specified internet gateway. You can disable/enable it, or change its display name or tags. Avoid entering confidential information.

If the gateway is disabled, that means no traffic will flow to/from the internet even if there's a route rule that enables that traffic.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
 
# File 'lib/oci/core/virtual_network_client.rb', line 17000

def update_internet_gateway(ig_id, update_internet_gateway_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_internet_gateway.' if logger

  raise "Missing the required parameter 'ig_id' when calling update_internet_gateway." if ig_id.nil?
  raise "Missing the required parameter 'update_internet_gateway_details' when calling update_internet_gateway." if update_internet_gateway_details.nil?
  raise "Parameter value for 'ig_id' must not be blank" if OCI::Internal::Util.blank_string?(ig_id)

  path = '/internetGateways/{igId}'.sub('{igId}', ig_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_internet_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_internet_gateway') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::InternetGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_ip_sec_connection(ipsc_id, update_ip_sec_connection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_ip_sec_connection API.

Updates the specified IPSec connection.

To update an individual IPSec tunnel's attributes, use update_ip_sec_connection_tunnel.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
 
# File 'lib/oci/core/virtual_network_client.rb', line 17063

def update_ip_sec_connection(ipsc_id, update_ip_sec_connection_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_ip_sec_connection.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling update_ip_sec_connection." if ipsc_id.nil?
  raise "Missing the required parameter 'update_ip_sec_connection_details' when calling update_ip_sec_connection." if update_ip_sec_connection_details.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)

  path = '/ipsecConnections/{ipscId}'.sub('{ipscId}', ipsc_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_ip_sec_connection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_ip_sec_connection') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IPSecConnection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_ip_sec_connection_tunnel(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_ip_sec_connection_tunnel API.

Updates the specified tunnel. This operation lets you change tunnel attributes such as the routing type (BGP dynamic routing or static routing). Here are some important notes:

  • If you change the tunnel's routing type or BGP session configuration, the tunnel will go down while it's reprovisioned.

  • If you want to switch the tunnel's routing from STATIC to BGP, make sure the tunnel's BGP session configuration attributes have been set (bgp_session_info).

  • If you want to switch the tunnel's routing from BGP to STATIC, make sure the IPSecConnection already has at least one valid CIDR static route.

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • tunnel_id (String) —

    The OCID of the tunnel.

  • update_ip_sec_connection_tunnel_details (OCI::Core::Models::UpdateIPSecConnectionTunnelDetails) —

    Details object for updating a IPSecConnection tunnel's details.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
 
# File 'lib/oci/core/virtual_network_client.rb', line 17138

def update_ip_sec_connection_tunnel(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_ip_sec_connection_tunnel.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling update_ip_sec_connection_tunnel." if ipsc_id.nil?
  raise "Missing the required parameter 'tunnel_id' when calling update_ip_sec_connection_tunnel." if tunnel_id.nil?
  raise "Missing the required parameter 'update_ip_sec_connection_tunnel_details' when calling update_ip_sec_connection_tunnel." if update_ip_sec_connection_tunnel_details.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)
  raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id)

  path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_ip_sec_connection_tunnel_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_ip_sec_connection_tunnel') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IPSecConnectionTunnel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_shared_secret_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_ip_sec_connection_tunnel_shared_secret API.

Updates the shared secret (pre-shared key) for the specified tunnel.

Important: If you change the shared secret, the tunnel will go down while it's reprovisioned.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17204
17205
17206
17207
17208
17209
17210
17211
17212
17213
17214
17215
17216
17217
17218
17219
17220
17221
17222
17223
17224
17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
 
# File 'lib/oci/core/virtual_network_client.rb', line 17204

def update_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_shared_secret_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_ip_sec_connection_tunnel_shared_secret.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling update_ip_sec_connection_tunnel_shared_secret." if ipsc_id.nil?
  raise "Missing the required parameter 'tunnel_id' when calling update_ip_sec_connection_tunnel_shared_secret." if tunnel_id.nil?
  raise "Missing the required parameter 'update_ip_sec_connection_tunnel_shared_secret_details' when calling update_ip_sec_connection_tunnel_shared_secret." if update_ip_sec_connection_tunnel_shared_secret_details.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)
  raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id)

  path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_ip_sec_connection_tunnel_shared_secret_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_ip_sec_connection_tunnel_shared_secret') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::IPSecConnectionTunnelSharedSecret'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_ipv6(ipv6_id, update_ipv6_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_ipv6 API.

Updates the specified IPv6. You must specify the object's OCID. Use this operation if you want to:

  • Move an IPv6 to a different VNIC in the same subnet.

  • Enable/disable internet access for an IPv6.

  • Change the display name for an IPv6.

  • Update resource tags for an IPv6.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



17275
17276
17277
17278
17279
17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
17293
17294
17295
17296
17297
17298
17299
17300
17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
 
# File 'lib/oci/core/virtual_network_client.rb', line 17275

def update_ipv6(ipv6_id, update_ipv6_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_ipv6.' if logger

  raise "Missing the required parameter 'ipv6_id' when calling update_ipv6." if ipv6_id.nil?
  raise "Missing the required parameter 'update_ipv6_details' when calling update_ipv6." if update_ipv6_details.nil?
  raise "Parameter value for 'ipv6_id' must not be blank" if OCI::Internal::Util.blank_string?(ipv6_id)

  path = '/ipv6/{ipv6Id}'.sub('{ipv6Id}', ipv6_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_ipv6_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_ipv6') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Ipv6'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_local_peering_gateway(local_peering_gateway_id, update_local_peering_gateway_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_local_peering_gateway API.

Updates the specified local peering gateway (LPG).

Parameters:

  • local_peering_gateway_id (String) —

    The OCID of the local peering gateway.

  • update_local_peering_gateway_details (OCI::Core::Models::UpdateLocalPeeringGatewayDetails) —

    Details object for updating a local peering gateway.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
 
# File 'lib/oci/core/virtual_network_client.rb', line 17336

def update_local_peering_gateway(local_peering_gateway_id, update_local_peering_gateway_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_local_peering_gateway.' if logger

  raise "Missing the required parameter 'local_peering_gateway_id' when calling update_local_peering_gateway." if local_peering_gateway_id.nil?
  raise "Missing the required parameter 'update_local_peering_gateway_details' when calling update_local_peering_gateway." if update_local_peering_gateway_details.nil?
  raise "Parameter value for 'local_peering_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(local_peering_gateway_id)

  path = '/localPeeringGateways/{localPeeringGatewayId}'.sub('{localPeeringGatewayId}', local_peering_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_local_peering_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_local_peering_gateway') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::LocalPeeringGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_nat_gateway(nat_gateway_id, update_nat_gateway_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_nat_gateway API.

Updates the specified NAT gateway.

Parameters:

  • nat_gateway_id (String) —

    The NAT gateway's OCID.

  • update_nat_gateway_details (OCI::Core::Models::UpdateNatGatewayDetails) —

    Details object for updating a NAT gateway.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
 
# File 'lib/oci/core/virtual_network_client.rb', line 17396

def update_nat_gateway(nat_gateway_id, update_nat_gateway_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_nat_gateway.' if logger

  raise "Missing the required parameter 'nat_gateway_id' when calling update_nat_gateway." if nat_gateway_id.nil?
  raise "Missing the required parameter 'update_nat_gateway_details' when calling update_nat_gateway." if update_nat_gateway_details.nil?
  raise "Parameter value for 'nat_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(nat_gateway_id)

  path = '/natGateways/{natGatewayId}'.sub('{natGatewayId}', nat_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_nat_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_nat_gateway') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::NatGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_network_security_group(network_security_group_id, update_network_security_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_network_security_group API.

Updates the specified network security group.

To add or remove an existing VNIC from the group, use update_vnic.

To add a VNIC to the group when you create the VNIC, specify the NSG's OCID during creation. For example, see the nsgIds attribute in create_vnic_details.

To add or remove security rules from the group, use add_network_security_group_security_rules or remove_network_security_group_security_rules.

To edit the contents of existing security rules in the group, use update_network_security_group_security_rules.

Parameters:

  • network_security_group_id (String) —

    The OCID of the network security group.

  • update_network_security_group_details (OCI::Core::Models::UpdateNetworkSecurityGroupDetails) —

    Details object for updating a network security group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
17485
17486
17487
17488
17489
17490
17491
17492
17493
17494
17495
17496
17497
17498
17499
17500
17501
17502
17503
17504
17505
17506
17507
 
# File 'lib/oci/core/virtual_network_client.rb', line 17470

def update_network_security_group(network_security_group_id, update_network_security_group_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_network_security_group.' if logger

  raise "Missing the required parameter 'network_security_group_id' when calling update_network_security_group." if network_security_group_id.nil?
  raise "Missing the required parameter 'update_network_security_group_details' when calling update_network_security_group." if update_network_security_group_details.nil?
  raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id)

  path = '/networkSecurityGroups/{networkSecurityGroupId}'.sub('{networkSecurityGroupId}', network_security_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_network_security_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_network_security_group') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::NetworkSecurityGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_network_security_group_security_rules(network_security_group_id, update_network_security_group_security_rules_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_network_security_group_security_rules API.

Updates one or more security rules in the specified network security group.

Parameters:

  • network_security_group_id (String) —

    The OCID of the network security group.

  • update_network_security_group_security_rules_details (OCI::Core::Models::UpdateNetworkSecurityGroupSecurityRulesDetails) —

    Request with one or more security rules associated with the network security group that will be updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

Returns:



17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
17549
17550
17551
17552
17553
17554
17555
17556
17557
17558
17559
17560
17561
17562
17563
17564
17565
 
# File 'lib/oci/core/virtual_network_client.rb', line 17529

def update_network_security_group_security_rules(network_security_group_id, update_network_security_group_security_rules_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_network_security_group_security_rules.' if logger

  raise "Missing the required parameter 'network_security_group_id' when calling update_network_security_group_security_rules." if network_security_group_id.nil?
  raise "Missing the required parameter 'update_network_security_group_security_rules_details' when calling update_network_security_group_security_rules." if update_network_security_group_security_rules_details.nil?
  raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id)

  path = '/networkSecurityGroups/{networkSecurityGroupId}/actions/updateSecurityRules'.sub('{networkSecurityGroupId}', network_security_group_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_network_security_group_security_rules_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_network_security_group_security_rules') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::UpdatedNetworkSecurityGroupSecurityRules'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_private_ip(private_ip_id, update_private_ip_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_private_ip API.

Updates the specified private IP. You must specify the object's OCID. Use this operation if you want to:

  • Move a secondary private IP to a different VNIC in the same subnet.

  • Change the display name for a secondary private IP.

  • Change the hostname for a secondary private IP.

This operation cannot be used with primary private IPs. To update the hostname for the primary IP on a VNIC, use update_vnic.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628
17629
17630
17631
17632
17633
17634
17635
 
# File 'lib/oci/core/virtual_network_client.rb', line 17598

def update_private_ip(private_ip_id, update_private_ip_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_private_ip.' if logger

  raise "Missing the required parameter 'private_ip_id' when calling update_private_ip." if private_ip_id.nil?
  raise "Missing the required parameter 'update_private_ip_details' when calling update_private_ip." if update_private_ip_details.nil?
  raise "Parameter value for 'private_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(private_ip_id)

  path = '/privateIps/{privateIpId}'.sub('{privateIpId}', private_ip_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_private_ip_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_private_ip') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PrivateIp'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_public_ip(public_ip_id, update_public_ip_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_public_ip API.

Updates the specified public IP. You must specify the object's OCID. Use this operation if you want to:

  • Assign a reserved public IP in your pool to a private IP.

  • Move a reserved public IP to a different private IP.

  • Unassign a reserved public IP from a private IP (which returns it to your pool of reserved public IPs).

  • Change the display name or tags for a public IP.

Assigning, moving, and unassigning a reserved public IP are asynchronous operations. Poll the public IP's lifecycleState to determine if the operation succeeded.

Note: When moving a reserved public IP, the target private IP must not already have a public IP with lifecycleState = ASSIGNING or ASSIGNED. If it does, an error is returned. Also, the initial unassignment from the original private IP always succeeds, but the assignment to the target private IP is asynchronous and could fail silently (for example, if the target private IP is deleted or has a different public IP assigned to it in the interim). If that occurs, the public IP remains unassigned and its lifecycleState switches to AVAILABLE (it is not reassigned to its original private IP). You must poll the public IP's lifecycleState to determine if the move succeeded.

Regarding ephemeral public IPs:

  • If you want to assign an ephemeral public IP to a primary private IP, use create_public_ip.

  • You can't move an ephemeral public IP to a different private IP.

  • If you want to unassign an ephemeral public IP from its private IP, use delete_public_ip, which unassigns and deletes the ephemeral public IP.

Note: If a public IP is assigned to a secondary private IP (see PrivateIp), and you move that secondary private IP to another VNIC, the public IP moves with it.

Note: There's a limit to the number of PublicIp} a VNIC or instance can have. If you try to move a reserved public IP to a VNIC or instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see {Public IP Addresses.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
 
# File 'lib/oci/core/virtual_network_client.rb', line 17696

def update_public_ip(public_ip_id, update_public_ip_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_public_ip.' if logger

  raise "Missing the required parameter 'public_ip_id' when calling update_public_ip." if public_ip_id.nil?
  raise "Missing the required parameter 'update_public_ip_details' when calling update_public_ip." if update_public_ip_details.nil?
  raise "Parameter value for 'public_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_id)

  path = '/publicIps/{publicIpId}'.sub('{publicIpId}', public_ip_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_public_ip_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_public_ip') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PublicIp'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_public_ip_pool(public_ip_pool_id, update_public_ip_pool_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_public_ip_pool API.

Updates the specified public IP pool.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17759
17760
17761
17762
17763
17764
17765
17766
17767
17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
 
# File 'lib/oci/core/virtual_network_client.rb', line 17759

def update_public_ip_pool(public_ip_pool_id, update_public_ip_pool_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_public_ip_pool.' if logger

  raise "Missing the required parameter 'public_ip_pool_id' when calling update_public_ip_pool." if public_ip_pool_id.nil?
  raise "Missing the required parameter 'update_public_ip_pool_details' when calling update_public_ip_pool." if update_public_ip_pool_details.nil?
  raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id)

  path = '/publicIpPools/{publicIpPoolId}'.sub('{publicIpPoolId}', public_ip_pool_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_public_ip_pool_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_public_ip_pool') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::PublicIpPool'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_remote_peering_connection(remote_peering_connection_id, update_remote_peering_connection_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_remote_peering_connection API.

Updates the specified remote peering connection (RPC).

Parameters:

  • remote_peering_connection_id (String) —

    The OCID of the remote peering connection (RPC).

  • update_remote_peering_connection_details (OCI::Core::Models::UpdateRemotePeeringConnectionDetails) —

    Request to the update the peering connection to remote region

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17820
17821
17822
17823
17824
17825
17826
17827
17828
17829
17830
17831
17832
17833
17834
17835
17836
17837
17838
17839
17840
17841
17842
17843
17844
17845
17846
17847
17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
 
# File 'lib/oci/core/virtual_network_client.rb', line 17820

def update_remote_peering_connection(remote_peering_connection_id, update_remote_peering_connection_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_remote_peering_connection.' if logger

  raise "Missing the required parameter 'remote_peering_connection_id' when calling update_remote_peering_connection." if remote_peering_connection_id.nil?
  raise "Missing the required parameter 'update_remote_peering_connection_details' when calling update_remote_peering_connection." if update_remote_peering_connection_details.nil?
  raise "Parameter value for 'remote_peering_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(remote_peering_connection_id)

  path = '/remotePeeringConnections/{remotePeeringConnectionId}'.sub('{remotePeeringConnectionId}', remote_peering_connection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_remote_peering_connection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_remote_peering_connection') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::RemotePeeringConnection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_route_table(rt_id, update_route_table_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_route_table API.

Updates the specified route table's display name or route rules. Avoid entering confidential information.

Note that the routeRules object you provide replaces the entire existing set of rules.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893
17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
17905
17906
17907
17908
17909
17910
17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
 
# File 'lib/oci/core/virtual_network_client.rb', line 17883

def update_route_table(rt_id, update_route_table_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_route_table.' if logger

  raise "Missing the required parameter 'rt_id' when calling update_route_table." if rt_id.nil?
  raise "Missing the required parameter 'update_route_table_details' when calling update_route_table." if update_route_table_details.nil?
  raise "Parameter value for 'rt_id' must not be blank" if OCI::Internal::Util.blank_string?(rt_id)

  path = '/routeTables/{rtId}'.sub('{rtId}', rt_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_route_table_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_route_table') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::RouteTable'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_security_list(security_list_id, update_security_list_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_security_list API.

Updates the specified security list's display name or rules. Avoid entering confidential information.

Note that the egressSecurityRules or ingressSecurityRules objects you provide replace the entire existing objects.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
17972
17973
17974
17975
17976
17977
17978
17979
17980
17981
17982
17983
17984
 
# File 'lib/oci/core/virtual_network_client.rb', line 17947

def update_security_list(security_list_id, update_security_list_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_security_list.' if logger

  raise "Missing the required parameter 'security_list_id' when calling update_security_list." if security_list_id.nil?
  raise "Missing the required parameter 'update_security_list_details' when calling update_security_list." if update_security_list_details.nil?
  raise "Parameter value for 'security_list_id' must not be blank" if OCI::Internal::Util.blank_string?(security_list_id)

  path = '/securityLists/{securityListId}'.sub('{securityListId}', security_list_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_security_list_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_security_list') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::SecurityList'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_service_gateway(service_gateway_id, update_service_gateway_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_service_gateway API.

Updates the specified service gateway. The information you provide overwrites the existing attributes of the gateway.

Parameters:

  • service_gateway_id (String) —

    The service gateway's OCID.

  • update_service_gateway_details (OCI::Core::Models::UpdateServiceGatewayDetails) —

    Details object for updating a service gateway.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
18040
18041
18042
18043
18044
18045
 
# File 'lib/oci/core/virtual_network_client.rb', line 18008

def update_service_gateway(service_gateway_id, update_service_gateway_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_service_gateway.' if logger

  raise "Missing the required parameter 'service_gateway_id' when calling update_service_gateway." if service_gateway_id.nil?
  raise "Missing the required parameter 'update_service_gateway_details' when calling update_service_gateway." if update_service_gateway_details.nil?
  raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id)

  path = '/serviceGateways/{serviceGatewayId}'.sub('{serviceGatewayId}', service_gateway_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_service_gateway_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_service_gateway') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::ServiceGateway'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_subnet(subnet_id, update_subnet_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_subnet API.

Updates the specified subnet.

Parameters:

  • subnet_id (String) —

    Specify the OCID of the subnet.

  • update_subnet_details (OCI::Core::Models::UpdateSubnetDetails) —

    Details object for updating a subnet.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



18068
18069
18070
18071
18072
18073
18074
18075
18076
18077
18078
18079
18080
18081
18082
18083
18084
18085
18086
18087
18088
18089
18090
18091
18092
18093
18094
18095
18096
18097
18098
18099
18100
18101
18102
18103
18104
18105
 
# File 'lib/oci/core/virtual_network_client.rb', line 18068

def update_subnet(subnet_id, update_subnet_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_subnet.' if logger

  raise "Missing the required parameter 'subnet_id' when calling update_subnet." if subnet_id.nil?
  raise "Missing the required parameter 'update_subnet_details' when calling update_subnet." if update_subnet_details.nil?
  raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id)

  path = '/subnets/{subnetId}'.sub('{subnetId}', subnet_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_subnet_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_subnet') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Subnet'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_tunnel_cpe_device_config(ipsc_id, tunnel_id, update_tunnel_cpe_device_config_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_tunnel_cpe_device_config API.

Creates or updates the set of CPE configuration answers for the specified tunnel. The answers correlate to the questions that are specific to the CPE device type (see the parameters attribute of CpeDeviceShapeDetail).

Parameters:

  • ipsc_id (String) —

    The OCID of the IPSec connection.

  • tunnel_id (String) —

    The OCID of the tunnel.

  • update_tunnel_cpe_device_config_details (OCI::Core::Models::UpdateTunnelCpeDeviceConfigDetails) —

    Request to input the tunnel's cpe configuration parameters

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



18140
18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158
18159
18160
18161
18162
18163
18164
18165
18166
18167
18168
18169
18170
18171
18172
18173
18174
18175
18176
18177
18178
18179
18180
18181
18182
 
# File 'lib/oci/core/virtual_network_client.rb', line 18140

def update_tunnel_cpe_device_config(ipsc_id, tunnel_id, update_tunnel_cpe_device_config_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_tunnel_cpe_device_config.' if logger

  raise "Missing the required parameter 'ipsc_id' when calling update_tunnel_cpe_device_config." if ipsc_id.nil?
  raise "Missing the required parameter 'tunnel_id' when calling update_tunnel_cpe_device_config." if tunnel_id.nil?
  raise "Missing the required parameter 'update_tunnel_cpe_device_config_details' when calling update_tunnel_cpe_device_config." if update_tunnel_cpe_device_config_details.nil?
  raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id)
  raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id)

  path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(update_tunnel_cpe_device_config_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_tunnel_cpe_device_config') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::TunnelCpeDeviceConfig'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_vcn(vcn_id, update_vcn_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_vcn API.

Updates the specified VCN.

Parameters:

  • vcn_id (String) —

    Specify the OCID of the VCN.

  • update_vcn_details (OCI::Core::Models::UpdateVcnDetails) —

    Details object for updating a VCN.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type Vcn



18205
18206
18207
18208
18209
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219
18220
18221
18222
18223
18224
18225
18226
18227
18228
18229
18230
18231
18232
18233
18234
18235
18236
18237
18238
18239
18240
18241
18242
 
# File 'lib/oci/core/virtual_network_client.rb', line 18205

def update_vcn(vcn_id, update_vcn_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_vcn.' if logger

  raise "Missing the required parameter 'vcn_id' when calling update_vcn." if vcn_id.nil?
  raise "Missing the required parameter 'update_vcn_details' when calling update_vcn." if update_vcn_details.nil?
  raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id)

  path = '/vcns/{vcnId}'.sub('{vcnId}', vcn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_vcn_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_vcn') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Vcn'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_virtual_circuit(virtual_circuit_id, update_virtual_circuit_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_virtual_circuit API.

Updates the specified virtual circuit. This can be called by either the customer who owns the virtual circuit, or the provider (when provisioning or de-provisioning the virtual circuit from their end). The documentation for update_virtual_circuit_details indicates who can update each property of the virtual circuit.

Important: If the virtual circuit is working and in the PROVISIONED state, updating any of the network-related properties (such as the DRG being used, the BGP ASN, and so on) will cause the virtual circuit's state to switch to PROVISIONING and the related BGP session to go down. After Oracle re-provisions the virtual circuit, its state will return to PROVISIONED. Make sure you confirm that the associated BGP session is back up. For more information about the various states and how to test connectivity, see FastConnect Overview.

To change the list of public IP prefixes for a public virtual circuit, use bulk_add_virtual_circuit_public_prefixes and bulk_delete_virtual_circuit_public_prefixes. Updating the list of prefixes does NOT cause the BGP session to go down. However, Oracle must verify the customer's ownership of each added prefix before traffic for that prefix will flow across the virtual circuit.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
18299
18300
18301
18302
18303
18304
18305
18306
18307
18308
18309
18310
18311
18312
18313
18314
18315
18316
18317
18318
18319
18320
18321
18322
18323
18324
18325
 
# File 'lib/oci/core/virtual_network_client.rb', line 18288

def update_virtual_circuit(virtual_circuit_id, update_virtual_circuit_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_virtual_circuit.' if logger

  raise "Missing the required parameter 'virtual_circuit_id' when calling update_virtual_circuit." if virtual_circuit_id.nil?
  raise "Missing the required parameter 'update_virtual_circuit_details' when calling update_virtual_circuit." if update_virtual_circuit_details.nil?
  raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id)

  path = '/virtualCircuits/{virtualCircuitId}'.sub('{virtualCircuitId}', virtual_circuit_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_virtual_circuit_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_virtual_circuit') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::VirtualCircuit'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_vlan(vlan_id, update_vlan_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_vlan API.

Updates the specified VLAN. Note that this operation might require changes to all the VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.

Parameters:

  • vlan_id (String) —

    The OCID of the VLAN.

  • update_vlan_details (OCI::Core::Models::UpdateVlanDetails) —

    Details object for updating a subnet.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



18352
18353
18354
18355
18356
18357
18358
18359
18360
18361
18362
18363
18364
18365
18366
18367
18368
18369
18370
18371
18372
18373
18374
18375
18376
18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
 
# File 'lib/oci/core/virtual_network_client.rb', line 18352

def update_vlan(vlan_id, update_vlan_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_vlan.' if logger

  raise "Missing the required parameter 'vlan_id' when calling update_vlan." if vlan_id.nil?
  raise "Missing the required parameter 'update_vlan_details' when calling update_vlan." if update_vlan_details.nil?
  raise "Parameter value for 'vlan_id' must not be blank" if OCI::Internal::Util.blank_string?(vlan_id)

  path = '/vlans/{vlanId}'.sub('{vlanId}', vlan_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_vlan_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_vlan') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Vlan'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_vnic(vnic_id, update_vnic_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_vnic API.

Updates the specified VNIC.

Parameters:

  • vnic_id (String) —

    The OCID of the VNIC.

  • update_vnic_details (OCI::Core::Models::UpdateVnicDetails) —

    Details object for updating a VNIC.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



18413
18414
18415
18416
18417
18418
18419
18420
18421
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442
18443
18444
18445
18446
18447
18448
18449
18450
 
# File 'lib/oci/core/virtual_network_client.rb', line 18413

def update_vnic(vnic_id, update_vnic_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_vnic.' if logger

  raise "Missing the required parameter 'vnic_id' when calling update_vnic." if vnic_id.nil?
  raise "Missing the required parameter 'update_vnic_details' when calling update_vnic." if update_vnic_details.nil?
  raise "Parameter value for 'vnic_id' must not be blank" if OCI::Internal::Util.blank_string?(vnic_id)

  path = '/vnics/{vnicId}'.sub('{vnicId}', vnic_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_vnic_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_vnic') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Vnic'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_vtap(vtap_id, update_vtap_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_vtap API.

Updates the specified VTAP's display name or tags.

Parameters:

  • vtap_id (String) —

    The OCID of the VTAP.

  • update_vtap_details (OCI::Core::Models::UpdateVtapDetails) —

    Details object for updating a VTAP.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



18476
18477
18478
18479
18480
18481
18482
18483
18484
18485
18486
18487
18488
18489
18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
18504
18505
18506
18507
18508
18509
18510
18511
18512
18513
18514
 
# File 'lib/oci/core/virtual_network_client.rb', line 18476

def update_vtap(vtap_id, update_vtap_details, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#update_vtap.' if logger

  raise "Missing the required parameter 'vtap_id' when calling update_vtap." if vtap_id.nil?
  raise "Missing the required parameter 'update_vtap_details' when calling update_vtap." if update_vtap_details.nil?
  raise "Parameter value for 'vtap_id' must not be blank" if OCI::Internal::Util.blank_string?(vtap_id)

  path = '/vtaps/{vtapId}'.sub('{vtapId}', vtap_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_vtap_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_vtap') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Core::Models::Vtap'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#upgrade_drg(drg_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use upgrade_drg API.

Upgrades the DRG. After upgrade, you can control routing inside your DRG via DRG attachments, route distributions, and DRG route tables.

Parameters:

  • drg_id (String) —

    The OCID of the DRG.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



18542
18543
18544
18545
18546
18547
18548
18549
18550
18551
18552
18553
18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
 
# File 'lib/oci/core/virtual_network_client.rb', line 18542

def upgrade_drg(drg_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#upgrade_drg.' if logger

  raise "Missing the required parameter 'drg_id' when calling upgrade_drg." if drg_id.nil?
  raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id)

  path = '/drgs/{drgId}/actions/upgrade'.sub('{drgId}', drg_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#upgrade_drg') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#validate_byoasn(byoasn_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use validate_byoasn API.

Submits the BYOASN for validation. Please do not submit to Oracle for validation if the information for the BYOASN is not already modified in the Regional Internet Registry. See To import a BYOASN for details.

Parameters:

  • byoasn_id (String) —

    The OCID of the Byoasn resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Returns:

  • (Response) —

    A Response object with data of type nil



18611
18612
18613
18614
18615
18616
18617
18618
18619
18620
18621
18622
18623
18624
18625
18626
18627
18628
18629
18630
18631
18632
18633
18634
18635
18636
18637
18638
18639
18640
18641
18642
18643
18644
18645
18646
18647
18648
18649
 
# File 'lib/oci/core/virtual_network_client.rb', line 18611

def validate_byoasn(byoasn_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#validate_byoasn.' if logger

  raise "Missing the required parameter 'byoasn_id' when calling validate_byoasn." if byoasn_id.nil?
  raise "Parameter value for 'byoasn_id' must not be blank" if OCI::Internal::Util.blank_string?(byoasn_id)

  path = '/byoasns/{byoasnId}/actions/validate'.sub('{byoasnId}', byoasn_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#validate_byoasn') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#validate_byoip_range(byoip_range_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use validate_byoip_range API.

Submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already modified the information for the BYOIP CIDR block with your Regional Internet Registry. See To import a CIDR block for details.

Parameters:

  • byoip_range_id (String) —

    The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



18671
18672
18673
18674
18675
18676
18677
18678
18679
18680
18681
18682
18683
18684
18685
18686
18687
18688
18689
18690
18691
18692
18693
18694
18695
18696
18697
18698
18699
18700
18701
18702
18703
18704
18705
18706
 
# File 'lib/oci/core/virtual_network_client.rb', line 18671

def validate_byoip_range(byoip_range_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#validate_byoip_range.' if logger

  raise "Missing the required parameter 'byoip_range_id' when calling validate_byoip_range." if byoip_range_id.nil?
  raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id)

  path = '/byoipRanges/{byoipRangeId}/actions/validate'.sub('{byoipRangeId}', byoip_range_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#validate_byoip_range') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#withdraw_byoip_range(byoip_range_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use withdraw_byoip_range API.

Withdraws BGP route advertisement for the BYOIP CIDR block.

Parameters:

  • byoip_range_id (String) —

    The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



18727
18728
18729
18730
18731
18732
18733
18734
18735
18736
18737
18738
18739
18740
18741
18742
18743
18744
18745
18746
18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
 
# File 'lib/oci/core/virtual_network_client.rb', line 18727

def withdraw_byoip_range(byoip_range_id, opts = {})
  logger.debug 'Calling operation VirtualNetworkClient#withdraw_byoip_range.' if logger

  raise "Missing the required parameter 'byoip_range_id' when calling withdraw_byoip_range." if byoip_range_id.nil?
  raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id)

  path = '/byoipRanges/{byoipRangeId}/actions/withdraw'.sub('{byoipRangeId}', byoip_range_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#withdraw_byoip_range') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end