Oracle Cloud Infrastructure v2.29.0, Apr 9 25

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.Core.getVirtualCircuit

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testVirtualCircuit = oci.Core.getVirtualCircuit({
    virtualCircuitId: testVirtualCircuitOciCoreVirtualCircuit.id,
});

import pulumi
import pulumi_oci as oci

test_virtual_circuit = oci.Core.get_virtual_circuit(virtual_circuit_id=test_virtual_circuit_oci_core_virtual_circuit["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.GetVirtualCircuit(ctx, &core.GetVirtualCircuitArgs{
			VirtualCircuitId: testVirtualCircuitOciCoreVirtualCircuit.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testVirtualCircuit = Oci.Core.GetVirtualCircuit.Invoke(new()
    {
        VirtualCircuitId = testVirtualCircuitOciCoreVirtualCircuit.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetVirtualCircuitArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testVirtualCircuit = CoreFunctions.getVirtualCircuit(GetVirtualCircuitArgs.builder()
            .virtualCircuitId(testVirtualCircuitOciCoreVirtualCircuit.id())
            .build());

    }
}

variables:
  testVirtualCircuit:
    fn::invoke:
      function: oci:Core:getVirtualCircuit
      arguments:
        virtualCircuitId: ${testVirtualCircuitOciCoreVirtualCircuit.id}

Using getVirtualCircuit

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getVirtualCircuit(args: GetVirtualCircuitArgs, opts?: InvokeOptions): Promise<GetVirtualCircuitResult>
function getVirtualCircuitOutput(args: GetVirtualCircuitOutputArgs, opts?: InvokeOptions): Output<GetVirtualCircuitResult>

def get_virtual_circuit(virtual_circuit_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVirtualCircuitResult
def get_virtual_circuit_output(virtual_circuit_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVirtualCircuitResult]

func GetVirtualCircuit(ctx *Context, args *GetVirtualCircuitArgs, opts ...InvokeOption) (*GetVirtualCircuitResult, error)
func GetVirtualCircuitOutput(ctx *Context, args *GetVirtualCircuitOutputArgs, opts ...InvokeOption) GetVirtualCircuitResultOutput

> Note: This function is named GetVirtualCircuit in the Go SDK.

public static class GetVirtualCircuit 
{
    public static Task<GetVirtualCircuitResult> InvokeAsync(GetVirtualCircuitArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualCircuitResult> Invoke(GetVirtualCircuitInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualCircuitResult> getVirtualCircuit(GetVirtualCircuitArgs args, InvokeOptions options)
public static Output<GetVirtualCircuitResult> getVirtualCircuit(GetVirtualCircuitArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Core/getVirtualCircuit:getVirtualCircuit
  arguments:
    # arguments dictionary

The following arguments are supported:

VirtualCircuitId string: The OCID of the virtual circuit.

VirtualCircuitId string: The OCID of the virtual circuit.

virtualCircuitId String: The OCID of the virtual circuit.

virtualCircuitId string: The OCID of the virtual circuit.

virtual_circuit_id str: The OCID of the virtual circuit.

virtualCircuitId String: The OCID of the virtual circuit.

getVirtualCircuit Result

The following output properties are available:

BandwidthShapeName string: The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see ListFastConnectProviderServiceVirtualCircuitBandwidthShapes. Example: 10 Gbps
BgpAdminState string: Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.
BgpIpv6sessionState string: The state of the Ipv6 BGP session associated with the virtual circuit.
BgpManagement string: Deprecated. Instead use the information in FastConnectProviderService.
Deprecated: The 'bgp_management' field has been deprecated. Please use the 'oci_core_fast_connect_provider_service' data source instead.
BgpSessionState string: The state of the Ipv4 BGP session associated with the virtual circuit.
CompartmentId string: The OCID of the compartment containing the virtual circuit.
CrossConnectMappings List<GetVirtualCircuitCrossConnectMapping>: An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
CustomerAsn string: 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 int: Deprecated. Instead use customerAsn. If you specify values for both, the request will be rejected.
Deprecated: The 'customer_bgp_asn' field has been deprecated. Please use 'customer_asn' instead.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags Dictionary<string, 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. Example: {"Department": "Finance"}
GatewayId string: The OCID of the customer's dynamic routing gateway (DRG) that this virtual circuit uses. Applicable only to private virtual circuits.
Id string: The virtual circuit's Oracle ID (OCID).
IpMtu string: The layer 3 IP MTU to use on this virtual circuit.
IsBfdEnabled 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 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.
OracleBgpAsn int: The Oracle BGP ASN.
ProviderServiceId string: The OCID of the service offered by the provider (if the customer is connecting via a provider).
ProviderServiceKeyName string: The service key name offered by the provider (if the customer is connecting via a provider).
ProviderState 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.
PublicPrefixes List<GetVirtualCircuitPublicPrefix>: For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed.
ReferenceComment string: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
Region string: The Oracle Cloud Infrastructure region where this virtual circuit is located.
RoutingPolicies List<string>: 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 string: Provider service type.
State string: The virtual circuit's current state. For information about the different states, see FastConnect Overview.
TimeCreated string: The date and time the virtual circuit was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
Type string: Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.
VirtualCircuitId string
VirtualCircuitRedundancyMetadatas List<GetVirtualCircuitVirtualCircuitRedundancyMetadata>: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

BandwidthShapeName string: The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see ListFastConnectProviderServiceVirtualCircuitBandwidthShapes. Example: 10 Gbps
BgpAdminState string: Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.
BgpIpv6sessionState string: The state of the Ipv6 BGP session associated with the virtual circuit.
BgpManagement string: Deprecated. Instead use the information in FastConnectProviderService.
Deprecated: The 'bgp_management' field has been deprecated. Please use the 'oci_core_fast_connect_provider_service' data source instead.
BgpSessionState string: The state of the Ipv4 BGP session associated with the virtual circuit.
CompartmentId string: The OCID of the compartment containing the virtual circuit.
CrossConnectMappings []GetVirtualCircuitCrossConnectMapping: An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
CustomerAsn string: 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 int: Deprecated. Instead use customerAsn. If you specify values for both, the request will be rejected.
Deprecated: The 'customer_bgp_asn' field has been deprecated. Please use 'customer_asn' instead.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
FreeformTags map[string]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. Example: {"Department": "Finance"}
GatewayId string: The OCID of the customer's dynamic routing gateway (DRG) that this virtual circuit uses. Applicable only to private virtual circuits.
Id string: The virtual circuit's Oracle ID (OCID).
IpMtu string: The layer 3 IP MTU to use on this virtual circuit.
IsBfdEnabled 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 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.
OracleBgpAsn int: The Oracle BGP ASN.
ProviderServiceId string: The OCID of the service offered by the provider (if the customer is connecting via a provider).
ProviderServiceKeyName string: The service key name offered by the provider (if the customer is connecting via a provider).
ProviderState 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.
PublicPrefixes []GetVirtualCircuitPublicPrefix: For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed.
ReferenceComment string: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
Region string: The Oracle Cloud Infrastructure region where this virtual circuit is located.
RoutingPolicies []string: 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 string: Provider service type.
State string: The virtual circuit's current state. For information about the different states, see FastConnect Overview.
TimeCreated string: The date and time the virtual circuit was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
Type string: Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.
VirtualCircuitId string
VirtualCircuitRedundancyMetadatas []GetVirtualCircuitVirtualCircuitRedundancyMetadata: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

bandwidthShapeName String: The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see ListFastConnectProviderServiceVirtualCircuitBandwidthShapes. Example: 10 Gbps
bgpAdminState String: Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.
bgpIpv6sessionState String: The state of the Ipv6 BGP session associated with the virtual circuit.
bgpManagement String: Deprecated. Instead use the information in FastConnectProviderService.
Deprecated: The 'bgp_management' field has been deprecated. Please use the 'oci_core_fast_connect_provider_service' data source instead.
bgpSessionState String: The state of the Ipv4 BGP session associated with the virtual circuit.
compartmentId String: The OCID of the compartment containing the virtual circuit.
crossConnectMappings List<GetVirtualCircuitCrossConnectMapping>: An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
customerAsn String: 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 Integer: Deprecated. Instead use customerAsn. If you specify values for both, the request will be rejected.
Deprecated: The 'customer_bgp_asn' field has been deprecated. Please use 'customer_asn' instead.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags Map<String,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. Example: {"Department": "Finance"}
gatewayId String: The OCID of the customer's dynamic routing gateway (DRG) that this virtual circuit uses. Applicable only to private virtual circuits.
id String: The virtual circuit's Oracle ID (OCID).
ipMtu String: The layer 3 IP MTU to use on this virtual circuit.
isBfdEnabled Boolean: 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 Boolean: 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.
oracleBgpAsn Integer: The Oracle BGP ASN.
providerServiceId String: The OCID of the service offered by the provider (if the customer is connecting via a provider).
providerServiceKeyName String: The service key name offered by the provider (if the customer is connecting via a provider).
providerState 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.
publicPrefixes List<GetVirtualCircuitPublicPrefix>: For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed.
referenceComment String: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
region String: The Oracle Cloud Infrastructure region where this virtual circuit is located.
routingPolicies List<String>: 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 String: Provider service type.
state String: The virtual circuit's current state. For information about the different states, see FastConnect Overview.
timeCreated String: The date and time the virtual circuit was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
type String: Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.
virtualCircuitId String
virtualCircuitRedundancyMetadatas List<GetVirtualCircuitVirtualCircuitRedundancyMetadata>: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

bandwidthShapeName string: The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see ListFastConnectProviderServiceVirtualCircuitBandwidthShapes. Example: 10 Gbps
bgpAdminState string: Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.
bgpIpv6sessionState string: The state of the Ipv6 BGP session associated with the virtual circuit.
bgpManagement string: Deprecated. Instead use the information in FastConnectProviderService.
Deprecated: The 'bgp_management' field has been deprecated. Please use the 'oci_core_fast_connect_provider_service' data source instead.
bgpSessionState string: The state of the Ipv4 BGP session associated with the virtual circuit.
compartmentId string: The OCID of the compartment containing the virtual circuit.
crossConnectMappings GetVirtualCircuitCrossConnectMapping[]: An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
customerAsn string: 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 number: Deprecated. Instead use customerAsn. If you specify values for both, the request will be rejected.
Deprecated: The 'customer_bgp_asn' field has been deprecated. Please use 'customer_asn' instead.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags {[key: string]: 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. Example: {"Department": "Finance"}
gatewayId string: The OCID of the customer's dynamic routing gateway (DRG) that this virtual circuit uses. Applicable only to private virtual circuits.
id string: The virtual circuit's Oracle ID (OCID).
ipMtu string: The layer 3 IP MTU to use on this virtual circuit.
isBfdEnabled boolean: 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 boolean: 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.
oracleBgpAsn number: The Oracle BGP ASN.
providerServiceId string: The OCID of the service offered by the provider (if the customer is connecting via a provider).
providerServiceKeyName string: The service key name offered by the provider (if the customer is connecting via a provider).
providerState 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.
publicPrefixes GetVirtualCircuitPublicPrefix[]: For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed.
referenceComment string: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
region string: The Oracle Cloud Infrastructure region where this virtual circuit is located.
routingPolicies string[]: 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 string: Provider service type.
state string: The virtual circuit's current state. For information about the different states, see FastConnect Overview.
timeCreated string: The date and time the virtual circuit was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
type string: Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.
virtualCircuitId string
virtualCircuitRedundancyMetadatas GetVirtualCircuitVirtualCircuitRedundancyMetadata[]: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

bandwidth_shape_name str: The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see ListFastConnectProviderServiceVirtualCircuitBandwidthShapes. Example: 10 Gbps
bgp_admin_state str: Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.
bgp_ipv6session_state str: The state of the Ipv6 BGP session associated with the virtual circuit.
bgp_management str: Deprecated. Instead use the information in FastConnectProviderService.
Deprecated: The 'bgp_management' field has been deprecated. Please use the 'oci_core_fast_connect_provider_service' data source instead.
bgp_session_state str: The state of the Ipv4 BGP session associated with the virtual circuit.
compartment_id str: The OCID of the compartment containing the virtual circuit.
cross_connect_mappings Sequence[core.GetVirtualCircuitCrossConnectMapping]: An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
customer_asn str: 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.
customer_bgp_asn int: Deprecated. Instead use customerAsn. If you specify values for both, the request will be rejected.
Deprecated: The 'customer_bgp_asn' field has been deprecated. Please use 'customer_asn' instead.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeform_tags Mapping[str, str]: 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"}
gateway_id str: The OCID of the customer's dynamic routing gateway (DRG) that this virtual circuit uses. Applicable only to private virtual circuits.
id str: The virtual circuit's Oracle ID (OCID).
ip_mtu str: The layer 3 IP MTU to use on this virtual circuit.
is_bfd_enabled 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.
is_transport_mode 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.
oracle_bgp_asn int: The Oracle BGP ASN.
provider_service_id str: The OCID of the service offered by the provider (if the customer is connecting via a provider).
provider_service_key_name str: The service key name offered by the provider (if the customer is connecting via a provider).
provider_state str: 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.
public_prefixes Sequence[core.GetVirtualCircuitPublicPrefix]: For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed.
reference_comment str: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
region str: The Oracle Cloud Infrastructure region where this virtual circuit is located.
routing_policies Sequence[str]: 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.
service_type str: Provider service type.
state str: The virtual circuit's current state. For information about the different states, see FastConnect Overview.
time_created str: The date and time the virtual circuit was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
type str: Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.
virtual_circuit_id str
virtual_circuit_redundancy_metadatas Sequence[core.GetVirtualCircuitVirtualCircuitRedundancyMetadata]: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

bandwidthShapeName String: The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see ListFastConnectProviderServiceVirtualCircuitBandwidthShapes. Example: 10 Gbps
bgpAdminState String: Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.
bgpIpv6sessionState String: The state of the Ipv6 BGP session associated with the virtual circuit.
bgpManagement String: Deprecated. Instead use the information in FastConnectProviderService.
Deprecated: The 'bgp_management' field has been deprecated. Please use the 'oci_core_fast_connect_provider_service' data source instead.
bgpSessionState String: The state of the Ipv4 BGP session associated with the virtual circuit.
compartmentId String: The OCID of the compartment containing the virtual circuit.
crossConnectMappings List<Property Map>: An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
customerAsn String: 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 Number: Deprecated. Instead use customerAsn. If you specify values for both, the request will be rejected.
Deprecated: The 'customer_bgp_asn' field has been deprecated. Please use 'customer_asn' instead.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTags Map<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. Example: {"Department": "Finance"}
gatewayId String: The OCID of the customer's dynamic routing gateway (DRG) that this virtual circuit uses. Applicable only to private virtual circuits.
id String: The virtual circuit's Oracle ID (OCID).
ipMtu String: The layer 3 IP MTU to use on this virtual circuit.
isBfdEnabled Boolean: 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 Boolean: 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.
oracleBgpAsn Number: The Oracle BGP ASN.
providerServiceId String: The OCID of the service offered by the provider (if the customer is connecting via a provider).
providerServiceKeyName String: The service key name offered by the provider (if the customer is connecting via a provider).
providerState 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.
publicPrefixes List<Property Map>: For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed.
referenceComment String: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
region String: The Oracle Cloud Infrastructure region where this virtual circuit is located.
routingPolicies List<String>: 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 String: Provider service type.
state String: The virtual circuit's current state. For information about the different states, see FastConnect Overview.
timeCreated String: The date and time the virtual circuit was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
type String: Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.
virtualCircuitId String
virtualCircuitRedundancyMetadatas List<Property Map>: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

Supporting Types

GetVirtualCircuitCrossConnectMapping

BgpMd5authKey string: The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don't use BGP MD5 authentication.
CrossConnectOrCrossConnectGroupId string: The OCID of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).
CustomerBgpPeeringIp string: The BGP IPv4 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider's edge router. Must use a subnet mask from /28 to /31.
CustomerBgpPeeringIpv6 string: The BGP IPv6 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider's edge router. Only subnet masks from /64 up to /127 are allowed.
OracleBgpPeeringIp string: The IPv4 address for Oracle's end of the BGP session. Must use a /30 or /31 subnet mask. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
OracleBgpPeeringIpv6 string: The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
Vlan int: The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). Example: 200

BgpMd5authKey string: The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don't use BGP MD5 authentication.
CrossConnectOrCrossConnectGroupId string: The OCID of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).
CustomerBgpPeeringIp string: The BGP IPv4 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider's edge router. Must use a subnet mask from /28 to /31.
CustomerBgpPeeringIpv6 string: The BGP IPv6 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider's edge router. Only subnet masks from /64 up to /127 are allowed.
OracleBgpPeeringIp string: The IPv4 address for Oracle's end of the BGP session. Must use a /30 or /31 subnet mask. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
OracleBgpPeeringIpv6 string: The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
Vlan int: The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). Example: 200

bgpMd5authKey String: The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don't use BGP MD5 authentication.
crossConnectOrCrossConnectGroupId String: The OCID of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).
customerBgpPeeringIp String: The BGP IPv4 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider's edge router. Must use a subnet mask from /28 to /31.
customerBgpPeeringIpv6 String: The BGP IPv6 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider's edge router. Only subnet masks from /64 up to /127 are allowed.
oracleBgpPeeringIp String: The IPv4 address for Oracle's end of the BGP session. Must use a /30 or /31 subnet mask. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
oracleBgpPeeringIpv6 String: The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
vlan Integer: The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). Example: 200

bgpMd5authKey string: The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don't use BGP MD5 authentication.
crossConnectOrCrossConnectGroupId string: The OCID of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).
customerBgpPeeringIp string: The BGP IPv4 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider's edge router. Must use a subnet mask from /28 to /31.
customerBgpPeeringIpv6 string: The BGP IPv6 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider's edge router. Only subnet masks from /64 up to /127 are allowed.
oracleBgpPeeringIp string: The IPv4 address for Oracle's end of the BGP session. Must use a /30 or /31 subnet mask. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
oracleBgpPeeringIpv6 string: The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
vlan number: The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). Example: 200

bgp_md5auth_key str: The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don't use BGP MD5 authentication.
cross_connect_or_cross_connect_group_id str: The OCID of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).
customer_bgp_peering_ip str: The BGP IPv4 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider's edge router. Must use a subnet mask from /28 to /31.
customer_bgp_peering_ipv6 str: The BGP IPv6 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider's edge router. Only subnet masks from /64 up to /127 are allowed.
oracle_bgp_peering_ip str: The IPv4 address for Oracle's end of the BGP session. Must use a /30 or /31 subnet mask. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
oracle_bgp_peering_ipv6 str: The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
vlan int: The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). Example: 200

bgpMd5authKey String: The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don't use BGP MD5 authentication.
crossConnectOrCrossConnectGroupId String: The OCID of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).
customerBgpPeeringIp String: The BGP IPv4 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider's edge router. Must use a subnet mask from /28 to /31.
customerBgpPeeringIpv6 String: The BGP IPv6 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider's edge router. Only subnet masks from /64 up to /127 are allowed.
oracleBgpPeeringIp String: The IPv4 address for Oracle's end of the BGP session. Must use a /30 or /31 subnet mask. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
oracleBgpPeeringIpv6 String: The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.
vlan Number: The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). Example: 200

GetVirtualCircuitPublicPrefix

CidrBlock string

CidrBlock string

cidrBlock String

cidrBlock string

cidr_block str

cidrBlock String

GetVirtualCircuitVirtualCircuitRedundancyMetadata

ConfiguredRedundancyLevel string: The configured redundancy level of the virtual circuit.
Ipv4bgpSessionRedundancyStatus string: Indicates if the configured level is met for IPv4 BGP redundancy.
Ipv6bgpSessionRedundancyStatus string: Indicates if the configured level is met for IPv6 BGP redundancy.

ConfiguredRedundancyLevel string: The configured redundancy level of the virtual circuit.
Ipv4bgpSessionRedundancyStatus string: Indicates if the configured level is met for IPv4 BGP redundancy.
Ipv6bgpSessionRedundancyStatus string: Indicates if the configured level is met for IPv6 BGP redundancy.

configuredRedundancyLevel String: The configured redundancy level of the virtual circuit.
ipv4bgpSessionRedundancyStatus String: Indicates if the configured level is met for IPv4 BGP redundancy.
ipv6bgpSessionRedundancyStatus String: Indicates if the configured level is met for IPv6 BGP redundancy.

configuredRedundancyLevel string: The configured redundancy level of the virtual circuit.
ipv4bgpSessionRedundancyStatus string: Indicates if the configured level is met for IPv4 BGP redundancy.
ipv6bgpSessionRedundancyStatus string: Indicates if the configured level is met for IPv6 BGP redundancy.

configured_redundancy_level str: The configured redundancy level of the virtual circuit.
ipv4bgp_session_redundancy_status str: Indicates if the configured level is met for IPv4 BGP redundancy.
ipv6bgp_session_redundancy_status str: Indicates if the configured level is met for IPv6 BGP redundancy.

configuredRedundancyLevel String: The configured redundancy level of the virtual circuit.
ipv4bgpSessionRedundancyStatus String: Indicates if the configured level is met for IPv4 BGP redundancy.
ipv6bgpSessionRedundancyStatus String: Indicates if the configured level is met for IPv6 BGP redundancy.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-oci

oci.Core.getVirtualCircuit

On this page

On this page

Example Usage

Using getVirtualCircuit

getVirtualCircuit Result

Supporting Types

GetVirtualCircuitCrossConnectMapping

GetVirtualCircuitPublicPrefix

GetVirtualCircuitVirtualCircuitRedundancyMetadata

Package Details

On this page

On this page