lib/oci/core/virtual_network_client.rb
# 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](https://docs.cloud.oracle.com/Content/Network/Tasks/managingroutetables.htm#privateip),
# unassigning it from the VNIC causes that route rule to blackhole and the traffic
# will be dropped.
#
# @param [String] private_ip_id The OCID of the private IP.
# @param [Hash] opts the optional parameters
# @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
#   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
# @option opts [String] :if_match 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.
#
# @return [Response] A Response object with data of type nil
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.

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.
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 . 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 .
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
      query_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]
      post_body = nil
      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
    end
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 query_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 ] post_body = nil 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 end
Unassigns and deletes the specified private IP.
Unassigns and deletes the specified private IP .
# rubocop:disable Style/NegatedIf # Query Params # Header Params # rubocop:enable Style/NegatedIf # rubocop:disable Metrics/BlockLength # rubocop:enable Metrics/BlockLength
A Response object with data of type nil
A Response object with data of type nil
Response
private_ip_id
<not_specific>
opts
:if_match 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.
: if_match 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 .
<not_specific>
opts the optional parameters
opts the optional parameters