create
******


Description
===========

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.


Usage
=====

   oci network virtual-circuit create [OPTIONS]


Options
=======


--compartment-id, -c [text]
---------------------------

The OCID of the compartment to contain the virtual circuit. [required]


--type [PUBLIC|PRIVATE]
-----------------------

The type of IP addresses used in this virtual circuit. PRIVATE means
RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16). Only
PRIVATE is supported. [required]


--bandwidth-shape-name [text]
-----------------------------

The provisioned data rate of the connection.  To get a list of the
available bandwidth levels (that is, shapes), see
ListFastConnectProviderServiceVirtualCircuitBandwidthShapes.

Example: *10 Gbps*


--cross-connect-mappings [complex type]
---------------------------------------

Create a *CrossConnectMapping* for each cross-connect or cross-connect
group this virtual circuit will run on.

This option is a JSON list with items of type CrossConnectMapping.
For documentation on CrossConnectMapping please see our API reference:
https://docs.us-phoenix-1.oraclecloud.com/api/#. 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 --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.


--customer-bgp-asn [integer]
----------------------------

Your BGP ASN (either public or private). Provide this value only if
there's a BGP session that goes from your edge router to Oracle.
Otherwise, leave this empty or null.


--display-name [text]
---------------------

A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.


--gateway-id [text]
-------------------

For private virtual circuits only. The OCID of the Dynamic Routing
Gateway (DRG) that this virtual circuit uses.


--provider-name [text]
----------------------

Deprecated. Instead use *providerServiceId*. To get a list of the
provider names, see ListFastConnectProviderServices.


--provider-service-id [text]
----------------------------

The OCID of the service offered by the provider (if you're connecting
via a provider). To get a list of the available service offerings, see
ListFastConnectProviderServices.


--provider-service-name [text]
------------------------------

Deprecated. Instead use *providerServiceId*. To get a list of the
provider names, see ListFastConnectProviderServices.


--public-prefixes [complex type]
--------------------------------

For a public virtual circuit. The public IP prefixes (CIDRs) the
customer wants to advertise across the connection.

This option is a JSON list with items of type
CreateVirtualCircuitPublicPrefixDetails.  For documentation on
CreateVirtualCircuitPublicPrefixDetails please see our API reference:
https://docs.us-phoenix-1.oraclecloud.com/api/#. 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 --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.


--region [text]
---------------

The Oracle Cloud Infrastructure region where this virtual circuit is
located. Example: *phx*


--wait-for-state [PENDING_PROVIDER|VERIFYING|PROVISIONING|PROVISIONED|FAILED|INACTIVE|TERMINATING|TERMINATED]
-------------------------------------------------------------------------------------------------------------

This operation creates, modifies or deletes a resource that has a
defined lifecycle state. Specify this option to perform the action and
then wait until the resource reaches a given lifecycle state.


--max-wait-seconds [integer]
----------------------------

The maximum time to wait for the resource to reach the lifecycle state
defined by --wait-for-state. Defaults to 1200 seconds.


--wait-interval-seconds [integer]
---------------------------------

Check every --wait-interval-seconds to see whether the resource to see
if it has reached the lifecycle state defined by --wait-for-state.
Defaults to 30 seconds.


--from-json [text]
------------------

Provide input to this command as a JSON document from a file.

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


-?, -h, --help
--------------

Show this message and exit.
