update
******


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

Updates the specified virtual circuit. This can be called by either
the customer who owns the virtual circuit, or the provider (when
provisioning or de-provisioning the virtual circuit from their end).
The documentation for UpdateVirtualCircuitDetails indicates who can
update each property of the virtual circuit.

**Important:** If the virtual circuit is working and in the
PROVISIONED state, updating any of the network-related properties
(such as the DRG being used, the BGP ASN, and so on) will cause the
virtual circuit's state to switch to PROVISIONING and the related BGP
session to go down. After Oracle re-provisions the virtual circuit,
its state will return to PROVISIONED. Make sure you confirm that the
associated BGP session is back up. For more information about the
various states and how to test connectivity, see FastConnect Overview.

To change the list of public IP prefixes for a public virtual circuit,
use BulkAddVirtualCircuitPublicPrefixes and
BulkDeleteVirtualCircuitPublicPrefixes. Updating the list of prefixes
does NOT cause the BGP session to go down. However, Oracle must verify
the customer's ownership of each added prefix before traffic for that
prefix will flow across the virtual circuit.


Usage
=====

   oci network virtual-circuit update [OPTIONS]


Options
=======


--virtual-circuit-id [text]
---------------------------

The OCID of the virtual circuit. [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
ListFastConnectProviderVirtualCircuitBandwidthShapes. To be updated
only by the customer who owns the virtual circuit.


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

An array of mappings, each containing properties for a cross-connect
or cross-connect group associated with this virtual circuit.

The customer and provider can update different properties in the
mapping depending on the situation. See the description of the
CrossConnectMapping.

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]
----------------------------

The BGP ASN of the network at the other end of the BGP session from
Oracle.

If the BGP session is from the customer's edge router to Oracle, the
required value is the customer's ASN, and it can be updated only by
the customer.

If the BGP session is from the provider's edge router to Oracle, the
required value is the provider's ASN, and it can be updated only by
the provider.


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

A user-friendly name. Does not have to be unique. Avoid entering
confidential information.

To be updated only by the customer who owns the virtual circuit.


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

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

To be updated only by the customer who owns the virtual circuit.


--provider-state [ACTIVE|INACTIVE]
----------------------------------

The provider's state in relation to this virtual circuit. Relevant
only if the customer is using FastConnect via a provider.  ACTIVE
means the provider has provisioned the virtual circuit from their end.
INACTIVE means the provider has not yet provisioned the virtual
circuit, or has de-provisioned it.

To be updated only by the provider.


--reference-comment [text]
--------------------------

Provider-supplied reference information about this virtual circuit.
Relevant only if the customer is using FastConnect via a provider.

To be updated only by the provider.


--if-match [text]
-----------------

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.


--force
-------

Perform update without prompting for confirmation.


--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.
