Class VirtualCircuit

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.

Inheritance

object

VirtualCircuit

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.VnmonitoringService.Models

Assembly: OCI.DotNetSDK.Vnmonitoring.dll

Syntax

public class VirtualCircuit

Properties

BandwidthShapeName

Declaration

[JsonProperty(PropertyName = "bandwidthShapeName")]
public string BandwidthShapeName { get; set; }

Property Value

Type	Description
string	The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see {@link #listFastConnectProviderVirtualCircuitBandwidthShapes(ListFastConnectProviderVirtualCircuitBandwidthShapesRequest) listFastConnectProviderVirtualCircuitBandwidthShapes}. Example: 10 Gbps

BgpAdminState

Declaration

[JsonProperty(PropertyName = "bgpAdminState")]
[JsonConverter(typeof(StringEnumConverter))]
public VirtualCircuit.BgpAdminStateEnum? BgpAdminState { get; set; }

Property Value

Type	Description
VirtualCircuit.BgpAdminStateEnum?	Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.

BgpIpv6SessionState

Declaration

[JsonProperty(PropertyName = "bgpIpv6SessionState")]
[JsonConverter(typeof(StringEnumConverter))]
public VirtualCircuit.BgpIpv6SessionStateEnum? BgpIpv6SessionState { get; set; }

Property Value

Type	Description
VirtualCircuit.BgpIpv6SessionStateEnum?	The state of the Ipv6 BGP session associated with the virtual circuit.

BgpManagement

Declaration

[JsonProperty(PropertyName = "bgpManagement")]
[JsonConverter(typeof(StringEnumConverter))]
public VirtualCircuit.BgpManagementEnum? BgpManagement { get; set; }

Property Value

Type	Description
VirtualCircuit.BgpManagementEnum?	Deprecated. Instead use the information in {@link FastConnectProviderService}.

BgpSessionState

Declaration

[JsonProperty(PropertyName = "bgpSessionState")]
[JsonConverter(typeof(StringEnumConverter))]
public VirtualCircuit.BgpSessionStateEnum? BgpSessionState { get; set; }

Property Value

Type	Description
VirtualCircuit.BgpSessionStateEnum?	The state of the Ipv4 BGP session associated with the virtual circuit.

CompartmentId

Declaration

[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment containing the virtual circuit.

CrossConnectMappings

Declaration

[JsonProperty(PropertyName = "crossConnectMappings")]
public List<CrossConnectMapping> CrossConnectMappings { get; set; }

Property Value

Type	Description
List<CrossConnectMapping>	An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.

CustomerAsn

Declaration

[JsonProperty(PropertyName = "customerAsn")]
public long? CustomerAsn { get; set; }

Property Value

Type	Description
long?	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. Can be a 2-byte or 4-byte ASN. Uses "asplain" format.

CustomerBgpAsn

Declaration

[JsonProperty(PropertyName = "customerBgpAsn")]
public int? CustomerBgpAsn { get; set; }

Property Value

Type	Description
int?	Deprecated. Instead use customerAsn. If you specify values for both, the request will be rejected.

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

GatewayId

Declaration

[JsonProperty(PropertyName = "gatewayId")]
public string GatewayId { get; set; }

Property Value

Type	Description
string	The OCID of the customer's {@link Drg} that this virtual circuit uses. Applicable only to private virtual circuits.

Id

Declaration

[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The virtual circuit's Oracle ID (OCID).

IpMtu

Declaration

[JsonProperty(PropertyName = "ipMtu")]
[JsonConverter(typeof(StringEnumConverter))]
public VirtualCircuitIpMtu? IpMtu { get; set; }

Property Value

Type	Description
VirtualCircuitIpMtu?	The layer 3 IP MTU to use on this virtual circuit.

IsBfdEnabled

Declaration

[JsonProperty(PropertyName = "isBfdEnabled")]
public bool? IsBfdEnabled { get; set; }

Property Value

Type	Description
bool?	Set to true to enable BFD for IPv4 BGP peering, or set to false to disable BFD. If this is not set, the default is false.

IsTransportMode

Declaration

[JsonProperty(PropertyName = "isTransportMode")]
public bool? IsTransportMode { get; set; }

Property Value

Type	Description
bool?	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.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public VirtualCircuit.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
VirtualCircuit.LifecycleStateEnum?	The virtual circuit's current state. For information about the different states, see FastConnect Overview.

OracleBgpAsn

Declaration

[JsonProperty(PropertyName = "oracleBgpAsn")]
public int? OracleBgpAsn { get; set; }

Property Value

Type	Description
int?	The Oracle BGP ASN.

ProviderName

Declaration

[JsonProperty(PropertyName = "providerName")]
public string ProviderName { get; set; }

Property Value

Type	Description
string	Deprecated. Instead use providerServiceId.

ProviderServiceId

Declaration

[JsonProperty(PropertyName = "providerServiceId")]
public string ProviderServiceId { get; set; }

Property Value

Type	Description
string	The OCID of the service offered by the provider (if the customer is connecting via a provider).

ProviderServiceKeyName

Declaration

[JsonProperty(PropertyName = "providerServiceKeyName")]
public string ProviderServiceKeyName { get; set; }

Property Value

Type	Description
string	The service key name offered by the provider (if the customer is connecting via a provider).

ProviderServiceName

Declaration

[JsonProperty(PropertyName = "providerServiceName")]
public string ProviderServiceName { get; set; }

Property Value

Type	Description
string	Deprecated. Instead use providerServiceId.

ProviderState

Declaration

[JsonProperty(PropertyName = "providerState")]
[JsonConverter(typeof(StringEnumConverter))]
public VirtualCircuit.ProviderStateEnum? ProviderState { get; set; }

Property Value

Type	Description
VirtualCircuit.ProviderStateEnum?	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.

PublicPrefixes

Declaration

[JsonProperty(PropertyName = "publicPrefixes")]
public List<string> PublicPrefixes { get; set; }

Property Value

Type	Description
List<string>	For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed.

ReferenceComment

Declaration

[JsonProperty(PropertyName = "referenceComment")]
public string ReferenceComment { get; set; }

Property Value

Type	Description
string	Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).

Region

Declaration

[JsonProperty(PropertyName = "region")]
public string Region { get; set; }

Property Value

Type	Description
string	The Oracle Cloud Infrastructure region where this virtual circuit is located.

RoutingPolicy

Declaration

[JsonProperty(PropertyName = "routingPolicy", ItemConverterType = typeof(StringEnumConverter))]
public List<VirtualCircuit.RoutingPolicyEnum> RoutingPolicy { get; set; }

Property Value

Type	Description
List<VirtualCircuit.RoutingPolicyEnum>	The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. Policies available are: ORACLE_SERVICE_NETWORK, REGIONAL, MARKET_LEVEL, and GLOBAL. See Route Filtering for details. By default, routing information is shared for all routes in the same market.

ServiceType

Declaration

[JsonProperty(PropertyName = "serviceType")]
[JsonConverter(typeof(StringEnumConverter))]
public VirtualCircuit.ServiceTypeEnum? ServiceType { get; set; }

Property Value

Type	Description
VirtualCircuit.ServiceTypeEnum?	Provider service type.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the virtual circuit was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Type

Declaration

[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(StringEnumConverter))]
public VirtualCircuit.TypeEnum? Type { get; set; }

Property Value

Type	Description
VirtualCircuit.TypeEnum?	Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.