UpdateVirtualCircuitDetails¶

class oci.vn_monitoring.models.UpdateVirtualCircuitDetails(**kwargs)¶

Bases: object

UpdateVirtualCircuitDetails model.

Attributes

`PROVIDER_STATE_ACTIVE`	A constant which can be used with the provider_state property of a UpdateVirtualCircuitDetails.
`PROVIDER_STATE_INACTIVE`	A constant which can be used with the provider_state property of a UpdateVirtualCircuitDetails.
`bandwidth_shape_name`	Gets the bandwidth_shape_name of this UpdateVirtualCircuitDetails.
`cross_connect_mappings`	Gets the cross_connect_mappings of this UpdateVirtualCircuitDetails.
`customer_bgp_asn`	Gets the customer_bgp_asn of this UpdateVirtualCircuitDetails.
`display_name`	Gets the display_name of this UpdateVirtualCircuitDetails.
`gateway_id`	Gets the gateway_id of this UpdateVirtualCircuitDetails.
`is_transport_mode`	Gets the is_transport_mode of this UpdateVirtualCircuitDetails.
`provider_state`	Gets the provider_state of this UpdateVirtualCircuitDetails.
`reference_comment`	Gets the reference_comment of this UpdateVirtualCircuitDetails.

Methods

__init__(**kwargs) Initializes a new UpdateVirtualCircuitDetails object with values from keyword arguments.

PROVIDER_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the provider_state property of a UpdateVirtualCircuitDetails. This constant has a value of “ACTIVE”

PROVIDER_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the provider_state property of a UpdateVirtualCircuitDetails. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new UpdateVirtualCircuitDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

bandwidth_shape_name (str) – The value to assign to the bandwidth_shape_name property of this UpdateVirtualCircuitDetails.
cross_connect_mappings (list[oci.vn_monitoring.models.CrossConnectMapping]) – The value to assign to the cross_connect_mappings property of this UpdateVirtualCircuitDetails.
is_transport_mode (bool) – The value to assign to the is_transport_mode property of this UpdateVirtualCircuitDetails.
customer_bgp_asn (int) – The value to assign to the customer_bgp_asn property of this UpdateVirtualCircuitDetails.
display_name (str) – The value to assign to the display_name property of this UpdateVirtualCircuitDetails.
gateway_id (str) – The value to assign to the gateway_id property of this UpdateVirtualCircuitDetails.
provider_state (str) – The value to assign to the provider_state property of this UpdateVirtualCircuitDetails. Allowed values for this property are: “ACTIVE”, “INACTIVE”
reference_comment (str) – The value to assign to the reference_comment property of this UpdateVirtualCircuitDetails.

bandwidth_shape_name¶

Gets the bandwidth_shape_name of this UpdateVirtualCircuitDetails. The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see list_fast_connect_provider_virtual_circuit_bandwidth_shapes(). To be updated only by the customer who owns the virtual circuit.

Returns:	The bandwidth_shape_name of this UpdateVirtualCircuitDetails.
Return type:	str

cross_connect_mappings¶

Gets the cross_connect_mappings of this UpdateVirtualCircuitDetails. 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.

Returns:	The cross_connect_mappings of this UpdateVirtualCircuitDetails.
Return type:	list[oci.vn_monitoring.models.CrossConnectMapping]

customer_bgp_asn¶

Gets the customer_bgp_asn of this UpdateVirtualCircuitDetails. 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.

Returns:	The customer_bgp_asn of this UpdateVirtualCircuitDetails.
Return type:	int

display_name¶

Gets the display_name of this UpdateVirtualCircuitDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this UpdateVirtualCircuitDetails.
Return type:	str

gateway_id¶

Gets the gateway_id of this UpdateVirtualCircuitDetails. The OCID of the Drg that this private virtual circuit uses.

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

Returns:	The gateway_id of this UpdateVirtualCircuitDetails.
Return type:	str

is_transport_mode¶

Gets the is_transport_mode of this UpdateVirtualCircuitDetails. Set to true for the virtual circuit to carry only encrypted traffic, or set to false for the virtual circuit to carry unencrypted traffic. If this is not set, the default is false.

Returns:	The is_transport_mode of this UpdateVirtualCircuitDetails.
Return type:	bool

provider_state¶

Gets the provider_state of this UpdateVirtualCircuitDetails. 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.

Allowed values for this property are: “ACTIVE”, “INACTIVE”

Returns:	The provider_state of this UpdateVirtualCircuitDetails.
Return type:	str

reference_comment¶

Gets the reference_comment of this UpdateVirtualCircuitDetails. 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.

Returns:	The reference_comment of this UpdateVirtualCircuitDetails.
Return type:	str