/** * Core Services API * Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm), [Compute](https://docs.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](https://docs.oracle.com/iaas/Content/Identity/Reference/corepolicyreference.htm) article. * OpenAPI spec version: 20160918 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * 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.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.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). * */ export interface VirtualCircuit { /** * 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}
*
*/
"bandwidthShapeName"?: string;
/**
* Deprecated. Instead use the information in
* {@link FastConnectProviderService}.
*
*/
"bgpManagement"?: VirtualCircuit.BgpManagement;
/**
* The state of the Ipv4 BGP session associated with the virtual circuit.
*/
"bgpSessionState"?: VirtualCircuit.BgpSessionState;
/**
* The state of the Ipv6 BGP session associated with the virtual circuit.
*/
"bgpIpv6SessionState"?: VirtualCircuit.BgpIpv6SessionState;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the virtual circuit.
*/
"compartmentId"?: string;
/**
* An array of mappings, each containing properties for a
* cross-connect or cross-connect group that is associated with this
* virtual circuit.
*
*/
"crossConnectMappings"?: Array
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
*
*/
"definedTags"?: {
[key: string]: {
[key: string]: any;
};
};
/**
* A user-friendly name. Does not have to be unique, and it's changeable.
* Avoid entering confidential information.
*
*/
"displayName"?: string;
/**
* 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](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
*
Example: {@code {\"Department\": \"Finance\"}}
*
*/
"freeformTags"?: {
[key: string]: string;
};
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the customer's {@link Drg}
* that this virtual circuit uses. Applicable only to private virtual circuits.
*
*/
"gatewayId"?: string;
/**
* The virtual circuit's Oracle ID ([OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
*/
"id"?: string;
/**
* The virtual circuit's current state. For information about
* the different states, see
* [FastConnect Overview](https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).
*
*/
"lifecycleState"?: VirtualCircuit.LifecycleState;
/**
* The Oracle BGP ASN. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
*/
"oracleBgpAsn"?: number;
/**
* Deprecated. Instead use {@code providerServiceId}.
*
*/
"providerName"?: string;
/**
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider (if the customer is connecting via a provider).
*
*/
"providerServiceId"?: string;
/**
* The service key name offered by the provider (if the customer is connecting via a provider).
*
*/
"providerServiceKeyName"?: string;
/**
* Deprecated. Instead use {@code providerServiceId}.
*
*/
"providerServiceName"?: string;
/**
* 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.
*
*/
"providerState"?: VirtualCircuit.ProviderState;
/**
* For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to
* advertise across the connection. All prefix sizes are allowed.
*
*/
"publicPrefixes"?: Array
Example: {@code 2016-08-25T21:10:29.600Z}
*
*/
"timeCreated"?: Date;
/**
* Whether the virtual circuit supports private or public peering. For more information,
* see [FastConnect Overview](https://docs.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).
*
*/
"type"?: VirtualCircuit.Type;
/**
* The layer 3 IP MTU to use on this virtual circuit.
*/
"ipMtu"?: model.VirtualCircuitIpMtu;
/**
* The OCI's FastConnect MultiCloud Provider/Partner remote region name associated with the OCI region.
* To get the list of associated provider remote region use the ListProviderRemoteRegions operation
*
*/
"providerRemoteRegion"?: string;
/**
* The Shared unique identifier for the connection between the multicloud interconnect providers
*/
"sharedConnectionUuid"?: string;
/**
* Customer's account on Provider/Partner cloud (AWS, GCP or any other)
*/
"remoteAccountId"?: string;
/**
* The current traffic mode for the Virtual Circuit. This indicates whether the traffic is drained for the
* associated Virtual Circuit or not.
*
*/
"trafficMode"?: VirtualCircuit.TrafficMode;
"virtualCircuitRedundancyMetadata"?: model.VirtualCircuitRedundancyMetadata;
}
export declare namespace VirtualCircuit {
enum BgpManagement {
CustomerManaged = "CUSTOMER_MANAGED",
ProviderManaged = "PROVIDER_MANAGED",
OracleManaged = "ORACLE_MANAGED",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum BgpSessionState {
Up = "UP",
Down = "DOWN",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum BgpIpv6SessionState {
Up = "UP",
Down = "DOWN",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum RoutingPolicy {
OracleServiceNetwork = "ORACLE_SERVICE_NETWORK",
Regional = "REGIONAL",
MarketLevel = "MARKET_LEVEL",
Global = "GLOBAL",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum BgpAdminState {
Enabled = "ENABLED",
Disabled = "DISABLED",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum LifecycleState {
PendingProvider = "PENDING_PROVIDER",
Verifying = "VERIFYING",
Provisioning = "PROVISIONING",
Provisioned = "PROVISIONED",
Failed = "FAILED",
Inactive = "INACTIVE",
Terminating = "TERMINATING",
Terminated = "TERMINATED",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum ProviderState {
Active = "ACTIVE",
Inactive = "INACTIVE",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum ServiceType {
Colocated = "COLOCATED",
Layer2 = "LAYER2",
Layer3 = "LAYER3",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum Type {
Public = "PUBLIC",
Private = "PRIVATE",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
enum TrafficMode {
Normal = "NORMAL",
Drain = "DRAIN",
/**
* This value is used if a service returns a value for this enum that is not recognized by this
* version of the SDK.
*/
UnknownValue = "UNKNOWN_VALUE"
}
function getJsonObj(obj: VirtualCircuit): object;
function getDeserializedJsonObj(obj: VirtualCircuit): object;
}