VirtualCircuit

class oci.core.models.VirtualCircuit(**kwargs)

Bases: object

For use with Oracle Cloud Infrastructure FastConnect.

A virtual circuit is an isolated network path that runs over one or more physical network connections to provide a single, logical connection between the edge router on the customer's existing network and Oracle Cloud Infrastructure. Private virtual circuits support private peering, and public virtual circuits support public peering. For more information, see FastConnect Overview.

Each virtual circuit is made up of information shared between a customer, Oracle, and a provider (if the customer is using FastConnect via a provider). Who fills in a given property of a virtual circuit depends on whether the BGP session related to that virtual circuit goes from the customer's edge router to Oracle, or from the provider's edge router to Oracle. Also, in the case where the customer is using a provider, values for some of the properties may not be present immediately, but may get filled in as the provider and Oracle each do their part to provision the virtual circuit.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

BGP_MANAGEMENT_CUSTOMER_MANAGED = 'CUSTOMER_MANAGED'

A constant which can be used with the bgp_management property of a VirtualCircuit. This constant has a value of "CUSTOMER_MANAGED"

BGP_MANAGEMENT_ORACLE_MANAGED = 'ORACLE_MANAGED'

A constant which can be used with the bgp_management property of a VirtualCircuit. This constant has a value of "ORACLE_MANAGED"

BGP_MANAGEMENT_PROVIDER_MANAGED = 'PROVIDER_MANAGED'

A constant which can be used with the bgp_management property of a VirtualCircuit. This constant has a value of "PROVIDER_MANAGED"

BGP_SESSION_STATE_DOWN = 'DOWN'

A constant which can be used with the bgp_session_state property of a VirtualCircuit. This constant has a value of "DOWN"

BGP_SESSION_STATE_UP = 'UP'

A constant which can be used with the bgp_session_state property of a VirtualCircuit. This constant has a value of "UP"

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a VirtualCircuit. This constant has a value of "FAILED"

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a VirtualCircuit. This constant has a value of "INACTIVE"

LIFECYCLE_STATE_PENDING_PROVIDER = 'PENDING_PROVIDER'

A constant which can be used with the lifecycle_state property of a VirtualCircuit. This constant has a value of "PENDING_PROVIDER"

LIFECYCLE_STATE_PROVISIONED = 'PROVISIONED'

A constant which can be used with the lifecycle_state property of a VirtualCircuit. This constant has a value of "PROVISIONED"

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'

A constant which can be used with the lifecycle_state property of a VirtualCircuit. This constant has a value of "PROVISIONING"

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a VirtualCircuit. This constant has a value of "TERMINATED"

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

A constant which can be used with the lifecycle_state property of a VirtualCircuit. This constant has a value of "TERMINATING"

LIFECYCLE_STATE_VERIFYING = 'VERIFYING'

A constant which can be used with the lifecycle_state property of a VirtualCircuit. This constant has a value of "VERIFYING"

PROVIDER_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the provider_state property of a VirtualCircuit. This constant has a value of "ACTIVE"

PROVIDER_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the provider_state property of a VirtualCircuit. This constant has a value of "INACTIVE"

SERVICE_TYPE_COLOCATED = 'COLOCATED'

A constant which can be used with the service_type property of a VirtualCircuit. This constant has a value of "COLOCATED"

SERVICE_TYPE_LAYER2 = 'LAYER2'

A constant which can be used with the service_type property of a VirtualCircuit. This constant has a value of "LAYER2"

SERVICE_TYPE_LAYER3 = 'LAYER3'

A constant which can be used with the service_type property of a VirtualCircuit. This constant has a value of "LAYER3"

TYPE_PRIVATE = 'PRIVATE'

A constant which can be used with the type property of a VirtualCircuit. This constant has a value of "PRIVATE"

TYPE_PUBLIC = 'PUBLIC'

A constant which can be used with the type property of a VirtualCircuit. This constant has a value of "PUBLIC"

__init__(**kwargs)

Initializes a new VirtualCircuit 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 VirtualCircuit.
  • bgp_management (str) -- The value to assign to the bgp_management property of this VirtualCircuit. Allowed values for this property are: "CUSTOMER_MANAGED", "PROVIDER_MANAGED", "ORACLE_MANAGED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • bgp_session_state (str) -- The value to assign to the bgp_session_state property of this VirtualCircuit. Allowed values for this property are: "UP", "DOWN", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • compartment_id (str) -- The value to assign to the compartment_id property of this VirtualCircuit.
  • cross_connect_mappings (list[CrossConnectMapping]) -- The value to assign to the cross_connect_mappings property of this VirtualCircuit.
  • customer_bgp_asn (int) -- The value to assign to the customer_bgp_asn property of this VirtualCircuit.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this VirtualCircuit.
  • display_name (str) -- The value to assign to the display_name property of this VirtualCircuit.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this VirtualCircuit.
  • gateway_id (str) -- The value to assign to the gateway_id property of this VirtualCircuit.
  • id (str) -- The value to assign to the id property of this VirtualCircuit.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this VirtualCircuit. Allowed values for this property are: "PENDING_PROVIDER", "VERIFYING", "PROVISIONING", "PROVISIONED", "FAILED", "INACTIVE", "TERMINATING", "TERMINATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • oracle_bgp_asn (int) -- The value to assign to the oracle_bgp_asn property of this VirtualCircuit.
  • provider_name (str) -- The value to assign to the provider_name property of this VirtualCircuit.
  • provider_service_id (str) -- The value to assign to the provider_service_id property of this VirtualCircuit.
  • provider_service_key_name (str) -- The value to assign to the provider_service_key_name property of this VirtualCircuit.
  • provider_service_name (str) -- The value to assign to the provider_service_name property of this VirtualCircuit.
  • provider_state (str) -- The value to assign to the provider_state property of this VirtualCircuit. Allowed values for this property are: "ACTIVE", "INACTIVE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • public_prefixes (list[str]) -- The value to assign to the public_prefixes property of this VirtualCircuit.
  • reference_comment (str) -- The value to assign to the reference_comment property of this VirtualCircuit.
  • region (str) -- The value to assign to the region property of this VirtualCircuit.
  • service_type (str) -- The value to assign to the service_type property of this VirtualCircuit. Allowed values for this property are: "COLOCATED", "LAYER2", "LAYER3", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • time_created (datetime) -- The value to assign to the time_created property of this VirtualCircuit.
  • type (str) -- The value to assign to the type property of this VirtualCircuit. Allowed values for this property are: "PUBLIC", "PRIVATE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
bandwidth_shape_name

Gets the bandwidth_shape_name of this VirtualCircuit. 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().

Example: 10 Gbps

Returns:The bandwidth_shape_name of this VirtualCircuit.
Return type:str
bgp_management

Gets the bgp_management of this VirtualCircuit. Deprecated. Instead use the information in FastConnectProviderService.

Allowed values for this property are: "CUSTOMER_MANAGED", "PROVIDER_MANAGED", "ORACLE_MANAGED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The bgp_management of this VirtualCircuit.
Return type:str
bgp_session_state

Gets the bgp_session_state of this VirtualCircuit. The state of the BGP session associated with the virtual circuit.

Allowed values for this property are: "UP", "DOWN", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The bgp_session_state of this VirtualCircuit.
Return type:str
compartment_id

Gets the compartment_id of this VirtualCircuit. The OCID of the compartment containing the virtual circuit.

Returns:The compartment_id of this VirtualCircuit.
Return type:str
cross_connect_mappings

Gets the cross_connect_mappings of this VirtualCircuit. An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.

Returns:The cross_connect_mappings of this VirtualCircuit.
Return type:list[CrossConnectMapping]
customer_bgp_asn

Gets the customer_bgp_asn of this VirtualCircuit. The BGP ASN of the network at the other end of the BGP session from Oracle. If the session is between the customer's edge router and Oracle, the value is the customer's ASN. If the BGP session is between the provider's edge router and Oracle, the value is the provider's ASN.

Returns:The customer_bgp_asn of this VirtualCircuit.
Return type:int
defined_tags

Gets the defined_tags of this VirtualCircuit. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

Returns:The defined_tags of this VirtualCircuit.
Return type:dict(str, dict(str, object))
display_name

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

Returns:The display_name of this VirtualCircuit.
Return type:str
freeform_tags

Gets the freeform_tags of this VirtualCircuit. 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: {"Department": "Finance"}

Returns:The freeform_tags of this VirtualCircuit.
Return type:dict(str, str)
gateway_id

Gets the gateway_id of this VirtualCircuit. The OCID of the customer's Drg that this virtual circuit uses. Applicable only to private virtual circuits.

Returns:The gateway_id of this VirtualCircuit.
Return type:str
id

Gets the id of this VirtualCircuit. The virtual circuit's Oracle ID (OCID).

Returns:The id of this VirtualCircuit.
Return type:str
lifecycle_state

Gets the lifecycle_state of this VirtualCircuit. The virtual circuit's current state. For information about the different states, see FastConnect Overview.

Allowed values for this property are: "PENDING_PROVIDER", "VERIFYING", "PROVISIONING", "PROVISIONED", "FAILED", "INACTIVE", "TERMINATING", "TERMINATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this VirtualCircuit.
Return type:str
oracle_bgp_asn

Gets the oracle_bgp_asn of this VirtualCircuit. The Oracle BGP ASN.

Returns:The oracle_bgp_asn of this VirtualCircuit.
Return type:int
provider_name

Gets the provider_name of this VirtualCircuit. Deprecated. Instead use providerServiceId.

Returns:The provider_name of this VirtualCircuit.
Return type:str
provider_service_id

Gets the provider_service_id of this VirtualCircuit. The OCID of the service offered by the provider (if the customer is connecting via a provider).

Returns:The provider_service_id of this VirtualCircuit.
Return type:str
provider_service_key_name

Gets the provider_service_key_name of this VirtualCircuit. The service key name offered by the provider (if the customer is connecting via a provider).

Returns:The provider_service_key_name of this VirtualCircuit.
Return type:str
provider_service_name

Gets the provider_service_name of this VirtualCircuit. Deprecated. Instead use providerServiceId.

Returns:The provider_service_name of this VirtualCircuit.
Return type:str
provider_state

Gets the provider_state of this VirtualCircuit. The provider's state in relation to this virtual circuit (if the customer is connecting 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.

Allowed values for this property are: "ACTIVE", "INACTIVE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The provider_state of this VirtualCircuit.
Return type:str
public_prefixes

Gets the public_prefixes of this VirtualCircuit. For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. Each prefix must be /31 or less specific.

Returns:The public_prefixes of this VirtualCircuit.
Return type:list[str]
reference_comment

Gets the reference_comment of this VirtualCircuit. Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).

Returns:The reference_comment of this VirtualCircuit.
Return type:str
region

Gets the region of this VirtualCircuit. The Oracle Cloud Infrastructure region where this virtual circuit is located.

Returns:The region of this VirtualCircuit.
Return type:str
service_type

Gets the service_type of this VirtualCircuit. Provider service type.

Allowed values for this property are: "COLOCATED", "LAYER2", "LAYER3", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The service_type of this VirtualCircuit.
Return type:str
time_created

Gets the time_created of this VirtualCircuit. The date and time the virtual circuit was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:The time_created of this VirtualCircuit.
Return type:datetime
type

Gets the type of this VirtualCircuit. Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.

Allowed values for this property are: "PUBLIC", "PRIVATE", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The type of this VirtualCircuit.
Return type:str