lib/oci/core/virtual_network_client.rb
# 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.
#
# @param [String] vcn_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.
# @param [OCI::Core::Models::RemoveVcnCidrDetails] remove_vcn_cidr_details Details object for removing a VCN CIDR.
# @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] :opc_request_id Unique identifier for the request.
#   If you need to contact Oracle about a particular request, please provide the request ID.
#
# @option opts [String] :opc_retry_token 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).
#
# @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
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/core/remove_vcn_cidr.rb.html) 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.
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 .
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
      query_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]
      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token
      post_body = @api_client.object_to_http_body(remove_vcn_cidr_details)
      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
    end
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 query_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 ] header_params [ :' opc-retry-token ' ] ||= OCI :: Retry . generate_opc_retry_token post_body = @api_client . object_to_http_body ( remove_vcn_cidr_details ) 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 end
Removes a specified CIDR block from a VCN.
Removes a specified CIDR block from a VCN .
# 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
vcn_id
remove_vcn_cidr_details
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 .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use remove_vcn_cidr API.
Click [ here ] to see an example of how to use remove_vcn_cidr API .