``create`` ========== .. contents:: :local: :depth: 1 Description ------------ 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. Usage ----- .. code-block:: none oci network cpe create [OPTIONS] Required Parameters -------------------- .. option:: --compartment-id, -c [text] The `OCID `__ of the compartment to contain the CPE. .. option:: --ip-address [text] The public IP address of the on-premises router. Example: .. code-block:: python 203.0.113.2 Optional Parameters -------------------- .. option:: --cpe-device-shape-id [text] The `OCID `__ of the CPE device type. You can provide a value if you want to later generate CPE device configuration content for IPSec connections that use this CPE. You can also call `UpdateCpe `__ later to provide a value. For a list of possible values, see `ListCpeDeviceShapes `__. For more information about generating CPE device configuration content, see: * `GetCpeDeviceConfigContent `__ * `GetIpsecCpeDeviceConfigContent `__ * `GetTunnelCpeDeviceConfigContent `__ * `GetTunnelCpeDeviceConfig `__ .. option:: --defined-tags [complex type] Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags `__. Example: .. code-block:: python {"Operations": {"CostCenter": "42"}} This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The :option:`--generate-param-json-input` option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax. .. option:: --display-name [text] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. .. option:: --freeform-tags [complex type] Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags `__. Example: .. code-block:: python {"Department": "Finance"} This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax. The :option:`--generate-param-json-input` option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax. .. option:: --from-json [text] Provide input to this command as a JSON document from a file using the file://path-to/file syntax. The :option:`--generate-full-command-json-input` option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id --> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array. Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used. For examples on usage of this option, please see our "using CLI with advanced JSON options" link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions .. option:: --is-private [boolean] Indicates whether this CPE is of type `private` or not. Global Parameters ------------------ Use ``oci --help`` for help on global parameters. :option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-v` Example using required parameter ------------------ Copy the following CLI commands into a file named example.sh. Run the command by typing "bash example.sh" and replacing the example parameters with your own. Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up `the OCI configuration `__ and `appropriate security policies `__ before trying the examples. .. code-block:: none :class: copy-code-block export compartment_id= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/cpe/create.html#cmdoption-compartment-id export ip_address= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/cpe/create.html#cmdoption-ip-address oci network cpe create --compartment-id $compartment_id --ip-address $ip_address