lib/oci/core/virtual_network_client.rb
# Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For
# more information, see [IPSec VPNs](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPsec.htm).
#
# For the purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
# For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
#
# You must provide the public IP address of your on-premises router. See
# [Configuring Your On-Premises Router for an IPSec VPN](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/configuringCPE.htm).
#
# 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.
#
# @param [OCI::Core::Models::CreateCpeDetails] create_cpe_details Details for creating a CPE.
# @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_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).
#
# @return [Response] A Response object with data of type {OCI::Core::Models::Cpe Cpe}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/core/create_cpe.rb.html) 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 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
[Configuring Your On-Premises Router for an IPSec VPN].

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.
Creates a new virtual customer - premises equipment ( CPE ) object in the specified compartment . 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 [ Configuring Your On - Premises Router for an IPSec VPN ] . 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 .
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
      query_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-retry-token'] ||= OCI::Retry.generate_opc_retry_token
      post_body = @api_client.object_to_http_body(create_cpe_details)
      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
    end
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 query_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-retry-token ' ] ||= OCI :: Retry . generate_opc_retry_token post_body = @api_client . object_to_http_body ( create_cpe_details ) 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 end
Creates a new virtual customer-premises equipment (CPE) object in the specified compartment.
Creates a new virtual customer - premises equipment ( CPE ) object in the specified compartment .
# 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 {OCI::Core::Models::Cpe Cpe}
A Response object with data of type { OCI :: Core :: Models :: Cpe Cpe }
Response
create_cpe_details
<not_specific>
opts
: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).
: 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 ) .
<not_specific>
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use create_cpe API.
Click [ here ] to see an example of how to use create_cpe API .