Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace 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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).

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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

Properties

Optional bandwidthShapeName

bandwidthShapeName: undefined | 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: {@code 10 Gbps}

Optional bgpAdminState

bgpAdminState: BgpAdminState

Set to {@code ENABLED} (the default) to activate the BGP session of the virtual circuit, set to {@code DISABLED} to deactivate the virtual circuit.

Optional bgpIpv6SessionState

bgpIpv6SessionState: BgpIpv6SessionState

The state of the Ipv6 BGP session associated with the virtual circuit.

Optional bgpManagement

bgpManagement: BgpManagement

Deprecated. Instead use the information in FastConnectProviderService.

Optional bgpSessionState

bgpSessionState: BgpSessionState

The state of the Ipv4 BGP session associated with the virtual circuit.

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment containing the virtual circuit.

Optional crossConnectMappings

crossConnectMappings: Array<CrossConnectMapping>

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

Optional customerAsn

customerAsn: undefined | number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional customerBgpAsn

customerBgpAsn: undefined | number

Deprecated. Instead use {@code customerAsn}. If you specify values for both, the request will be rejected. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional definedTags

definedTags: undefined | object

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

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional displayName

displayName: undefined | string

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

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

Optional gatewayId

gatewayId: undefined | string

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

Optional id

id: undefined | string

The virtual circuit's Oracle ID (OCID).

Optional ipMtu

ipMtu: model.VirtualCircuitIpMtu

The layer 3 IP MTU to use on this virtual circuit.

Optional isBfdEnabled

isBfdEnabled: undefined | false | true

Set to {@code true} to enable BFD for IPv4 BGP peering, or set to {@code false} to disable BFD. If this is not set, the default is {@code false}.

Optional isTransportMode

isTransportMode: undefined | false | true

Set to {@code true} for the virtual circuit to carry only encrypted traffic, or set to {@code false} for the virtual circuit to carry unencrypted traffic. If this is not set, the default is {@code false}.

Optional lifecycleState

lifecycleState: LifecycleState

The virtual circuit's current state. For information about the different states, see FastConnect Overview.

Optional oracleBgpAsn

oracleBgpAsn: undefined | number

The Oracle BGP ASN. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional providerName

providerName: undefined | string

Deprecated. Instead use {@code providerServiceId}.

Optional providerServiceId

providerServiceId: undefined | string

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

Optional providerServiceKeyName

providerServiceKeyName: undefined | string

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

Optional providerServiceName

providerServiceName: undefined | string

Deprecated. Instead use {@code providerServiceId}.

Optional providerState

providerState: ProviderState

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.

Optional publicPrefixes

publicPrefixes: Array<string>

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

Optional referenceComment

referenceComment: undefined | string

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

Optional region

region: undefined | string

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

Optional routingPolicy

routingPolicy: Array<RoutingPolicy>

The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. Policies available are: {@code ORACLE_SERVICE_NETWORK}, {@code REGIONAL}, {@code MARKET_LEVEL}, and {@code GLOBAL}. See Route Filtering for details. By default, routing information is shared for all routes in the same market.

Optional serviceType

serviceType: ServiceType

Provider service type.

Optional timeCreated

timeCreated: Date

The date and time the virtual circuit was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional type

type: Type

Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.

Functions

getDeserializedJsonObj

getJsonObj