Oracle Cloud Infrastructure v3.9.0, Sep 24 25

Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi

oci.Core.VirtualCircuit

Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi

For the purposes of access control, you must provide the OCID of the compartment where you want the virtual circuit to reside. If you’re not sure which compartment to use, put the virtual circuit in the same compartment with the DRG it’s using. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the virtual circuit. It does not have to be unique, and you can change it. Avoid entering confidential information.

Important: When creating a virtual circuit, you specify a DRG for the traffic to flow through. Make sure you attach the DRG to your VCN and confirm the VCN’s routing sends traffic to the DRG. Otherwise traffic will not flow. For more information, see Route Tables.

Example Usage

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

const testVirtualCircuit = new oci.core.VirtualCircuit("test_virtual_circuit", {
    compartmentId: compartmentId,
    type: virtualCircuitType,
    bandwidthShapeName: virtualCircuitBandwidthShapeName,
    bgpAdminState: virtualCircuitBgpAdminState,
    crossConnectMappings: [{
        bgpMd5authKey: virtualCircuitCrossConnectMappingsBgpMd5authKey,
        crossConnectOrCrossConnectGroupId: testCrossConnectOrCrossConnectGroup.id,
        customerBgpPeeringIp: virtualCircuitCrossConnectMappingsCustomerBgpPeeringIp,
        customerBgpPeeringIpv6: virtualCircuitCrossConnectMappingsCustomerBgpPeeringIpv6,
        oracleBgpPeeringIp: virtualCircuitCrossConnectMappingsOracleBgpPeeringIp,
        oracleBgpPeeringIpv6: virtualCircuitCrossConnectMappingsOracleBgpPeeringIpv6,
        vlan: virtualCircuitCrossConnectMappingsVlan,
    }],
    customerAsn: virtualCircuitCustomerAsn,
    customerBgpAsn: virtualCircuitCustomerBgpAsn,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: virtualCircuitDisplayName,
    freeformTags: {
        Department: "Finance",
    },
    ipMtu: virtualCircuitIpMtu,
    isBfdEnabled: virtualCircuitIsBfdEnabled,
    isTransportMode: virtualCircuitIsTransportMode,
    gatewayId: testGateway.id,
    providerServiceId: testFastConnectProviderServices.fastConnectProviderServices[0].id,
    providerServiceKeyName: virtualCircuitProviderServiceKeyName,
    publicPrefixes: [{
        cidrBlock: virtualCircuitPublicPrefixesCidrBlock,
    }],
    region: virtualCircuitRegion,
    routingPolicies: virtualCircuitRoutingPolicy,
});

import pulumi
import pulumi_oci as oci

test_virtual_circuit = oci.core.VirtualCircuit("test_virtual_circuit",
    compartment_id=compartment_id,
    type=virtual_circuit_type,
    bandwidth_shape_name=virtual_circuit_bandwidth_shape_name,
    bgp_admin_state=virtual_circuit_bgp_admin_state,
    cross_connect_mappings=[{
        "bgp_md5auth_key": virtual_circuit_cross_connect_mappings_bgp_md5auth_key,
        "cross_connect_or_cross_connect_group_id": test_cross_connect_or_cross_connect_group["id"],
        "customer_bgp_peering_ip": virtual_circuit_cross_connect_mappings_customer_bgp_peering_ip,
        "customer_bgp_peering_ipv6": virtual_circuit_cross_connect_mappings_customer_bgp_peering_ipv6,
        "oracle_bgp_peering_ip": virtual_circuit_cross_connect_mappings_oracle_bgp_peering_ip,
        "oracle_bgp_peering_ipv6": virtual_circuit_cross_connect_mappings_oracle_bgp_peering_ipv6,
        "vlan": virtual_circuit_cross_connect_mappings_vlan,
    }],
    customer_asn=virtual_circuit_customer_asn,
    customer_bgp_asn=virtual_circuit_customer_bgp_asn,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=virtual_circuit_display_name,
    freeform_tags={
        "Department": "Finance",
    },
    ip_mtu=virtual_circuit_ip_mtu,
    is_bfd_enabled=virtual_circuit_is_bfd_enabled,
    is_transport_mode=virtual_circuit_is_transport_mode,
    gateway_id=test_gateway["id"],
    provider_service_id=test_fast_connect_provider_services["fastConnectProviderServices"][0]["id"],
    provider_service_key_name=virtual_circuit_provider_service_key_name,
    public_prefixes=[{
        "cidr_block": virtual_circuit_public_prefixes_cidr_block,
    }],
    region=virtual_circuit_region,
    routing_policies=virtual_circuit_routing_policy)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.NewVirtualCircuit(ctx, "test_virtual_circuit", &core.VirtualCircuitArgs{
			CompartmentId:      pulumi.Any(compartmentId),
			Type:               pulumi.Any(virtualCircuitType),
			BandwidthShapeName: pulumi.Any(virtualCircuitBandwidthShapeName),
			BgpAdminState:      pulumi.Any(virtualCircuitBgpAdminState),
			CrossConnectMappings: core.VirtualCircuitCrossConnectMappingArray{
				&core.VirtualCircuitCrossConnectMappingArgs{
					BgpMd5authKey:                     pulumi.Any(virtualCircuitCrossConnectMappingsBgpMd5authKey),
					CrossConnectOrCrossConnectGroupId: pulumi.Any(testCrossConnectOrCrossConnectGroup.Id),
					CustomerBgpPeeringIp:              pulumi.Any(virtualCircuitCrossConnectMappingsCustomerBgpPeeringIp),
					CustomerBgpPeeringIpv6:            pulumi.Any(virtualCircuitCrossConnectMappingsCustomerBgpPeeringIpv6),
					OracleBgpPeeringIp:                pulumi.Any(virtualCircuitCrossConnectMappingsOracleBgpPeeringIp),
					OracleBgpPeeringIpv6:              pulumi.Any(virtualCircuitCrossConnectMappingsOracleBgpPeeringIpv6),
					Vlan:                              pulumi.Any(virtualCircuitCrossConnectMappingsVlan),
				},
			},
			CustomerAsn:    pulumi.Any(virtualCircuitCustomerAsn),
			CustomerBgpAsn: pulumi.Any(virtualCircuitCustomerBgpAsn),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(virtualCircuitDisplayName),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			IpMtu:                  pulumi.Any(virtualCircuitIpMtu),
			IsBfdEnabled:           pulumi.Any(virtualCircuitIsBfdEnabled),
			IsTransportMode:        pulumi.Any(virtualCircuitIsTransportMode),
			GatewayId:              pulumi.Any(testGateway.Id),
			ProviderServiceId:      pulumi.Any(testFastConnectProviderServices.FastConnectProviderServices[0].Id),
			ProviderServiceKeyName: pulumi.Any(virtualCircuitProviderServiceKeyName),
			PublicPrefixes: core.VirtualCircuitPublicPrefixArray{
				&core.VirtualCircuitPublicPrefixArgs{
					CidrBlock: pulumi.Any(virtualCircuitPublicPrefixesCidrBlock),
				},
			},
			Region:          pulumi.Any(virtualCircuitRegion),
			RoutingPolicies: pulumi.Any(virtualCircuitRoutingPolicy),
		})
		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 = new Oci.Core.VirtualCircuit("test_virtual_circuit", new()
    {
        CompartmentId = compartmentId,
        Type = virtualCircuitType,
        BandwidthShapeName = virtualCircuitBandwidthShapeName,
        BgpAdminState = virtualCircuitBgpAdminState,
        CrossConnectMappings = new[]
        {
            new Oci.Core.Inputs.VirtualCircuitCrossConnectMappingArgs
            {
                BgpMd5authKey = virtualCircuitCrossConnectMappingsBgpMd5authKey,
                CrossConnectOrCrossConnectGroupId = testCrossConnectOrCrossConnectGroup.Id,
                CustomerBgpPeeringIp = virtualCircuitCrossConnectMappingsCustomerBgpPeeringIp,
                CustomerBgpPeeringIpv6 = virtualCircuitCrossConnectMappingsCustomerBgpPeeringIpv6,
                OracleBgpPeeringIp = virtualCircuitCrossConnectMappingsOracleBgpPeeringIp,
                OracleBgpPeeringIpv6 = virtualCircuitCrossConnectMappingsOracleBgpPeeringIpv6,
                Vlan = virtualCircuitCrossConnectMappingsVlan,
            },
        },
        CustomerAsn = virtualCircuitCustomerAsn,
        CustomerBgpAsn = virtualCircuitCustomerBgpAsn,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = virtualCircuitDisplayName,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IpMtu = virtualCircuitIpMtu,
        IsBfdEnabled = virtualCircuitIsBfdEnabled,
        IsTransportMode = virtualCircuitIsTransportMode,
        GatewayId = testGateway.Id,
        ProviderServiceId = testFastConnectProviderServices.FastConnectProviderServices[0].Id,
        ProviderServiceKeyName = virtualCircuitProviderServiceKeyName,
        PublicPrefixes = new[]
        {
            new Oci.Core.Inputs.VirtualCircuitPublicPrefixArgs
            {
                CidrBlock = virtualCircuitPublicPrefixesCidrBlock,
            },
        },
        Region = virtualCircuitRegion,
        RoutingPolicies = virtualCircuitRoutingPolicy,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.VirtualCircuit;
import com.pulumi.oci.Core.VirtualCircuitArgs;
import com.pulumi.oci.Core.inputs.VirtualCircuitCrossConnectMappingArgs;
import com.pulumi.oci.Core.inputs.VirtualCircuitPublicPrefixArgs;
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) {
        var testVirtualCircuit = new VirtualCircuit("testVirtualCircuit", VirtualCircuitArgs.builder()
            .compartmentId(compartmentId)
            .type(virtualCircuitType)
            .bandwidthShapeName(virtualCircuitBandwidthShapeName)
            .bgpAdminState(virtualCircuitBgpAdminState)
            .crossConnectMappings(VirtualCircuitCrossConnectMappingArgs.builder()
                .bgpMd5authKey(virtualCircuitCrossConnectMappingsBgpMd5authKey)
                .crossConnectOrCrossConnectGroupId(testCrossConnectOrCrossConnectGroup.id())
                .customerBgpPeeringIp(virtualCircuitCrossConnectMappingsCustomerBgpPeeringIp)
                .customerBgpPeeringIpv6(virtualCircuitCrossConnectMappingsCustomerBgpPeeringIpv6)
                .oracleBgpPeeringIp(virtualCircuitCrossConnectMappingsOracleBgpPeeringIp)
                .oracleBgpPeeringIpv6(virtualCircuitCrossConnectMappingsOracleBgpPeeringIpv6)
                .vlan(virtualCircuitCrossConnectMappingsVlan)
                .build())
            .customerAsn(virtualCircuitCustomerAsn)
            .customerBgpAsn(virtualCircuitCustomerBgpAsn)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(virtualCircuitDisplayName)
            .freeformTags(Map.of("Department", "Finance"))
            .ipMtu(virtualCircuitIpMtu)
            .isBfdEnabled(virtualCircuitIsBfdEnabled)
            .isTransportMode(virtualCircuitIsTransportMode)
            .gatewayId(testGateway.id())
            .providerServiceId(testFastConnectProviderServices.fastConnectProviderServices()[0].id())
            .providerServiceKeyName(virtualCircuitProviderServiceKeyName)
            .publicPrefixes(VirtualCircuitPublicPrefixArgs.builder()
                .cidrBlock(virtualCircuitPublicPrefixesCidrBlock)
                .build())
            .region(virtualCircuitRegion)
            .routingPolicies(virtualCircuitRoutingPolicy)
            .build());

    }
}

resources:
  testVirtualCircuit:
    type: oci:Core:VirtualCircuit
    name: test_virtual_circuit
    properties:
      compartmentId: ${compartmentId}
      type: ${virtualCircuitType}
      bandwidthShapeName: ${virtualCircuitBandwidthShapeName}
      bgpAdminState: ${virtualCircuitBgpAdminState}
      crossConnectMappings:
        - bgpMd5authKey: ${virtualCircuitCrossConnectMappingsBgpMd5authKey}
          crossConnectOrCrossConnectGroupId: ${testCrossConnectOrCrossConnectGroup.id}
          customerBgpPeeringIp: ${virtualCircuitCrossConnectMappingsCustomerBgpPeeringIp}
          customerBgpPeeringIpv6: ${virtualCircuitCrossConnectMappingsCustomerBgpPeeringIpv6}
          oracleBgpPeeringIp: ${virtualCircuitCrossConnectMappingsOracleBgpPeeringIp}
          oracleBgpPeeringIpv6: ${virtualCircuitCrossConnectMappingsOracleBgpPeeringIpv6}
          vlan: ${virtualCircuitCrossConnectMappingsVlan}
      customerAsn: ${virtualCircuitCustomerAsn}
      customerBgpAsn: ${virtualCircuitCustomerBgpAsn}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${virtualCircuitDisplayName}
      freeformTags:
        Department: Finance
      ipMtu: ${virtualCircuitIpMtu}
      isBfdEnabled: ${virtualCircuitIsBfdEnabled}
      isTransportMode: ${virtualCircuitIsTransportMode}
      gatewayId: ${testGateway.id}
      providerServiceId: ${testFastConnectProviderServices.fastConnectProviderServices[0].id}
      providerServiceKeyName: ${virtualCircuitProviderServiceKeyName}
      publicPrefixes:
        - cidrBlock: ${virtualCircuitPublicPrefixesCidrBlock}
      region: ${virtualCircuitRegion}
      routingPolicies: ${virtualCircuitRoutingPolicy}

Create VirtualCircuit Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new VirtualCircuit(name: string, args: VirtualCircuitArgs, opts?: CustomResourceOptions);

@overload
def VirtualCircuit(resource_name: str,
                   args: VirtualCircuitArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def VirtualCircuit(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   compartment_id: Optional[str] = None,
                   type: Optional[str] = None,
                   freeform_tags: Optional[Mapping[str, str]] = None,
                   is_bfd_enabled: Optional[bool] = None,
                   customer_asn: Optional[str] = None,
                   customer_bgp_asn: Optional[int] = None,
                   defined_tags: Optional[Mapping[str, str]] = None,
                   display_name: Optional[str] = None,
                   bandwidth_shape_name: Optional[str] = None,
                   gateway_id: Optional[str] = None,
                   ip_mtu: Optional[str] = None,
                   cross_connect_mappings: Optional[Sequence[VirtualCircuitCrossConnectMappingArgs]] = None,
                   is_transport_mode: Optional[bool] = None,
                   provider_service_id: Optional[str] = None,
                   provider_service_key_name: Optional[str] = None,
                   public_prefixes: Optional[Sequence[VirtualCircuitPublicPrefixArgs]] = None,
                   region: Optional[str] = None,
                   routing_policies: Optional[Sequence[str]] = None,
                   bgp_admin_state: Optional[str] = None)

func NewVirtualCircuit(ctx *Context, name string, args VirtualCircuitArgs, opts ...ResourceOption) (*VirtualCircuit, error)

public VirtualCircuit(string name, VirtualCircuitArgs args, CustomResourceOptions? opts = null)

public VirtualCircuit(String name, VirtualCircuitArgs args)
public VirtualCircuit(String name, VirtualCircuitArgs args, CustomResourceOptions options)

type: oci:Core:VirtualCircuit
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args VirtualCircuitArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args VirtualCircuitArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VirtualCircuitArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VirtualCircuitArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args VirtualCircuitArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var virtualCircuitResource = new Oci.Core.VirtualCircuit("virtualCircuitResource", new()
{
    CompartmentId = "string",
    Type = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsBfdEnabled = false,
    CustomerAsn = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    BandwidthShapeName = "string",
    GatewayId = "string",
    IpMtu = "string",
    CrossConnectMappings = new[]
    {
        new Oci.Core.Inputs.VirtualCircuitCrossConnectMappingArgs
        {
            BgpMd5authKey = "string",
            CrossConnectOrCrossConnectGroupId = "string",
            CustomerBgpPeeringIp = "string",
            CustomerBgpPeeringIpv6 = "string",
            OracleBgpPeeringIp = "string",
            OracleBgpPeeringIpv6 = "string",
            Vlan = 0,
        },
    },
    IsTransportMode = false,
    ProviderServiceId = "string",
    ProviderServiceKeyName = "string",
    PublicPrefixes = new[]
    {
        new Oci.Core.Inputs.VirtualCircuitPublicPrefixArgs
        {
            CidrBlock = "string",
        },
    },
    Region = "string",
    RoutingPolicies = new[]
    {
        "string",
    },
    BgpAdminState = "string",
});

example, err := core.NewVirtualCircuit(ctx, "virtualCircuitResource", &core.VirtualCircuitArgs{
	CompartmentId: pulumi.String("string"),
	Type:          pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsBfdEnabled: pulumi.Bool(false),
	CustomerAsn:  pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName:        pulumi.String("string"),
	BandwidthShapeName: pulumi.String("string"),
	GatewayId:          pulumi.String("string"),
	IpMtu:              pulumi.String("string"),
	CrossConnectMappings: core.VirtualCircuitCrossConnectMappingArray{
		&core.VirtualCircuitCrossConnectMappingArgs{
			BgpMd5authKey:                     pulumi.String("string"),
			CrossConnectOrCrossConnectGroupId: pulumi.String("string"),
			CustomerBgpPeeringIp:              pulumi.String("string"),
			CustomerBgpPeeringIpv6:            pulumi.String("string"),
			OracleBgpPeeringIp:                pulumi.String("string"),
			OracleBgpPeeringIpv6:              pulumi.String("string"),
			Vlan:                              pulumi.Int(0),
		},
	},
	IsTransportMode:        pulumi.Bool(false),
	ProviderServiceId:      pulumi.String("string"),
	ProviderServiceKeyName: pulumi.String("string"),
	PublicPrefixes: core.VirtualCircuitPublicPrefixArray{
		&core.VirtualCircuitPublicPrefixArgs{
			CidrBlock: pulumi.String("string"),
		},
	},
	Region: pulumi.String("string"),
	RoutingPolicies: pulumi.StringArray{
		pulumi.String("string"),
	},
	BgpAdminState: pulumi.String("string"),
})

var virtualCircuitResource = new VirtualCircuit("virtualCircuitResource", VirtualCircuitArgs.builder()
    .compartmentId("string")
    .type("string")
    .freeformTags(Map.of("string", "string"))
    .isBfdEnabled(false)
    .customerAsn("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .bandwidthShapeName("string")
    .gatewayId("string")
    .ipMtu("string")
    .crossConnectMappings(VirtualCircuitCrossConnectMappingArgs.builder()
        .bgpMd5authKey("string")
        .crossConnectOrCrossConnectGroupId("string")
        .customerBgpPeeringIp("string")
        .customerBgpPeeringIpv6("string")
        .oracleBgpPeeringIp("string")
        .oracleBgpPeeringIpv6("string")
        .vlan(0)
        .build())
    .isTransportMode(false)
    .providerServiceId("string")
    .providerServiceKeyName("string")
    .publicPrefixes(VirtualCircuitPublicPrefixArgs.builder()
        .cidrBlock("string")
        .build())
    .region("string")
    .routingPolicies("string")
    .bgpAdminState("string")
    .build());

virtual_circuit_resource = oci.core.VirtualCircuit("virtualCircuitResource",
    compartment_id="string",
    type="string",
    freeform_tags={
        "string": "string",
    },
    is_bfd_enabled=False,
    customer_asn="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    bandwidth_shape_name="string",
    gateway_id="string",
    ip_mtu="string",
    cross_connect_mappings=[{
        "bgp_md5auth_key": "string",
        "cross_connect_or_cross_connect_group_id": "string",
        "customer_bgp_peering_ip": "string",
        "customer_bgp_peering_ipv6": "string",
        "oracle_bgp_peering_ip": "string",
        "oracle_bgp_peering_ipv6": "string",
        "vlan": 0,
    }],
    is_transport_mode=False,
    provider_service_id="string",
    provider_service_key_name="string",
    public_prefixes=[{
        "cidr_block": "string",
    }],
    region="string",
    routing_policies=["string"],
    bgp_admin_state="string")

const virtualCircuitResource = new oci.core.VirtualCircuit("virtualCircuitResource", {
    compartmentId: "string",
    type: "string",
    freeformTags: {
        string: "string",
    },
    isBfdEnabled: false,
    customerAsn: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    bandwidthShapeName: "string",
    gatewayId: "string",
    ipMtu: "string",
    crossConnectMappings: [{
        bgpMd5authKey: "string",
        crossConnectOrCrossConnectGroupId: "string",
        customerBgpPeeringIp: "string",
        customerBgpPeeringIpv6: "string",
        oracleBgpPeeringIp: "string",
        oracleBgpPeeringIpv6: "string",
        vlan: 0,
    }],
    isTransportMode: false,
    providerServiceId: "string",
    providerServiceKeyName: "string",
    publicPrefixes: [{
        cidrBlock: "string",
    }],
    region: "string",
    routingPolicies: ["string"],
    bgpAdminState: "string",
});

type: oci:Core:VirtualCircuit
properties:
    bandwidthShapeName: string
    bgpAdminState: string
    compartmentId: string
    crossConnectMappings:
        - bgpMd5authKey: string
          crossConnectOrCrossConnectGroupId: string
          customerBgpPeeringIp: string
          customerBgpPeeringIpv6: string
          oracleBgpPeeringIp: string
          oracleBgpPeeringIpv6: string
          vlan: 0
    customerAsn: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    gatewayId: string
    ipMtu: string
    isBfdEnabled: false
    isTransportMode: false
    providerServiceId: string
    providerServiceKeyName: string
    publicPrefixes:
        - cidrBlock: string
    region: string
    routingPolicies:
        - string
    type: string

VirtualCircuit Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The VirtualCircuit resource accepts the following input properties:

CompartmentId string

(Updatable) The OCID of the compartment to contain the virtual circuit.

Type string

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

BandwidthShapeName string

(Updatable) 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

(Updatable) Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.

CrossConnectMappings List<VirtualCircuitCrossConnectMapping>

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

CustomerAsn string

(Updatable) Your BGP ASN (either public or private). Provide this value only if there's a BGP session that goes from your edge router to Oracle. Otherwise, leave this empty or null. Can be a 2-byte or 4-byte ASN. Uses "asplain" format. Example: 12345 (2-byte) or 1587232876 (4-byte)

CustomerBgpAsn int

(Updatable) 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>

(Updatable) 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

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

FreeformTags Dictionary<string, string>

(Updatable) 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

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

IpMtu string

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

IsBfdEnabled bool

(Updatable) 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

(Updatable) 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.

ProviderServiceId string

The OCID of the service offered by the provider (if you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

ProviderServiceKeyName string

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

PublicPrefixes List<VirtualCircuitPublicPrefix>

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

Region string

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

RoutingPolicies List<string>

(Updatable) 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.

CompartmentId string

(Updatable) The OCID of the compartment to contain the virtual circuit.

Type string

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

BandwidthShapeName string

BgpAdminState string

(Updatable) Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.

CrossConnectMappings []VirtualCircuitCrossConnectMappingArgs

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

CustomerAsn string

CustomerBgpAsn int

(Updatable) 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

(Updatable) 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

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

FreeformTags map[string]string

GatewayId string

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

IpMtu string

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

IsBfdEnabled bool

(Updatable) 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

(Updatable) 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.

ProviderServiceId string

The OCID of the service offered by the provider (if you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

ProviderServiceKeyName string

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

PublicPrefixes []VirtualCircuitPublicPrefixArgs

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

Region string

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

RoutingPolicies []string

compartmentId String

(Updatable) The OCID of the compartment to contain the virtual circuit.

type String

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

bandwidthShapeName String

bgpAdminState String

(Updatable) Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.

crossConnectMappings List<VirtualCircuitCrossConnectMapping>

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

customerAsn String

customerBgpAsn Integer

(Updatable) 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>

(Updatable) 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

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

freeformTags Map<String,String>

gatewayId String

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

ipMtu String

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

isBfdEnabled Boolean

(Updatable) 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

(Updatable) 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.

providerServiceId String

The OCID of the service offered by the provider (if you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

providerServiceKeyName String

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

publicPrefixes List<VirtualCircuitPublicPrefix>

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

region String

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

routingPolicies List<String>

compartmentId string

(Updatable) The OCID of the compartment to contain the virtual circuit.

type string

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

bandwidthShapeName string

bgpAdminState string

(Updatable) Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.

crossConnectMappings VirtualCircuitCrossConnectMapping[]

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

customerAsn string

customerBgpAsn number

(Updatable) 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}

(Updatable) 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

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

freeformTags {[key: string]: string}

gatewayId string

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

ipMtu string

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

isBfdEnabled boolean

(Updatable) 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

(Updatable) 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.

providerServiceId string

The OCID of the service offered by the provider (if you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

providerServiceKeyName string

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

publicPrefixes VirtualCircuitPublicPrefix[]

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

region string

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

routingPolicies string[]

compartment_id str

(Updatable) The OCID of the compartment to contain the virtual circuit.

type str

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

bandwidth_shape_name str

bgp_admin_state str

(Updatable) Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.

cross_connect_mappings Sequence[VirtualCircuitCrossConnectMappingArgs]

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

customer_asn str

customer_bgp_asn int

(Updatable) 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]

(Updatable) 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

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

freeform_tags Mapping[str, str]

gateway_id str

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

ip_mtu str

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

is_bfd_enabled bool

(Updatable) 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

(Updatable) 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.

provider_service_id str

The OCID of the service offered by the provider (if you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

provider_service_key_name str

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

public_prefixes Sequence[VirtualCircuitPublicPrefixArgs]

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

region str

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

routing_policies Sequence[str]

compartmentId String

(Updatable) The OCID of the compartment to contain the virtual circuit.

type String

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

bandwidthShapeName String

bgpAdminState String

(Updatable) Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.

crossConnectMappings List<Property Map>

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

customerAsn String

customerBgpAsn Number

(Updatable) 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>

(Updatable) 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

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

freeformTags Map<String>

gatewayId String

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

ipMtu String

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

isBfdEnabled Boolean

(Updatable) 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

(Updatable) 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.

providerServiceId String

The OCID of the service offered by the provider (if you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

providerServiceKeyName String

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

publicPrefixes List<Property Map>

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

region String

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

routingPolicies List<String>

Outputs

All input properties are implicitly available as output properties. Additionally, the VirtualCircuit resource produces the following output properties:

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.
Id string: The provider-assigned unique ID for this managed resource.
OracleBgpAsn int: The Oracle BGP ASN.
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.
ReferenceComment string: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
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
VirtualCircuitRedundancyMetadatas List<VirtualCircuitVirtualCircuitRedundancyMetadata>: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

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.
Id string: The provider-assigned unique ID for this managed resource.
OracleBgpAsn int: The Oracle BGP ASN.
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.
ReferenceComment string: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
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
VirtualCircuitRedundancyMetadatas []VirtualCircuitVirtualCircuitRedundancyMetadata: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

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.
id String: The provider-assigned unique ID for this managed resource.
oracleBgpAsn Integer: The Oracle BGP ASN.
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.
referenceComment String: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
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
virtualCircuitRedundancyMetadatas List<VirtualCircuitVirtualCircuitRedundancyMetadata>: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

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.
id string: The provider-assigned unique ID for this managed resource.
oracleBgpAsn number: The Oracle BGP ASN.
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.
referenceComment string: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
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
virtualCircuitRedundancyMetadatas VirtualCircuitVirtualCircuitRedundancyMetadata[]: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

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.
id str: The provider-assigned unique ID for this managed resource.
oracle_bgp_asn int: The Oracle BGP ASN.
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.
reference_comment str: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
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
virtual_circuit_redundancy_metadatas Sequence[VirtualCircuitVirtualCircuitRedundancyMetadata]: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

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.
id String: The provider-assigned unique ID for this managed resource.
oracleBgpAsn Number: The Oracle BGP ASN.
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.
referenceComment String: Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
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
virtualCircuitRedundancyMetadatas List<Property Map>: This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

Look up Existing VirtualCircuit Resource

Get an existing VirtualCircuit resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VirtualCircuitState, opts?: CustomResourceOptions): VirtualCircuit

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bandwidth_shape_name: Optional[str] = None,
        bgp_admin_state: Optional[str] = None,
        bgp_ipv6session_state: Optional[str] = None,
        bgp_management: Optional[str] = None,
        bgp_session_state: Optional[str] = None,
        compartment_id: Optional[str] = None,
        cross_connect_mappings: Optional[Sequence[VirtualCircuitCrossConnectMappingArgs]] = None,
        customer_asn: Optional[str] = None,
        customer_bgp_asn: Optional[int] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        gateway_id: Optional[str] = None,
        ip_mtu: Optional[str] = None,
        is_bfd_enabled: Optional[bool] = None,
        is_transport_mode: Optional[bool] = None,
        oracle_bgp_asn: Optional[int] = None,
        provider_service_id: Optional[str] = None,
        provider_service_key_name: Optional[str] = None,
        provider_state: Optional[str] = None,
        public_prefixes: Optional[Sequence[VirtualCircuitPublicPrefixArgs]] = None,
        reference_comment: Optional[str] = None,
        region: Optional[str] = None,
        routing_policies: Optional[Sequence[str]] = None,
        service_type: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        type: Optional[str] = None,
        virtual_circuit_redundancy_metadatas: Optional[Sequence[VirtualCircuitVirtualCircuitRedundancyMetadataArgs]] = None) -> VirtualCircuit

func GetVirtualCircuit(ctx *Context, name string, id IDInput, state *VirtualCircuitState, opts ...ResourceOption) (*VirtualCircuit, error)

public static VirtualCircuit Get(string name, Input<string> id, VirtualCircuitState? state, CustomResourceOptions? opts = null)

public static VirtualCircuit get(String name, Output<String> id, VirtualCircuitState state, CustomResourceOptions options)

resources:  _:    type: oci:Core:VirtualCircuit    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BandwidthShapeName string

BgpAdminState string

(Updatable) 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

(Updatable) The OCID of the compartment to contain the virtual circuit.

CrossConnectMappings List<VirtualCircuitCrossConnectMapping>

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

CustomerAsn string

CustomerBgpAsn int

(Updatable) 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>

(Updatable) 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

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

FreeformTags Dictionary<string, string>

GatewayId string

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

IpMtu string

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

IsBfdEnabled bool

(Updatable) 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

(Updatable) 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 you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

ProviderServiceKeyName string

(Updatable) 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<VirtualCircuitPublicPrefix>

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

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. Example: phx

RoutingPolicies List<string>

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

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

VirtualCircuitRedundancyMetadatas List<VirtualCircuitVirtualCircuitRedundancyMetadata>

This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

BandwidthShapeName string

BgpAdminState string

(Updatable) 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

(Updatable) The OCID of the compartment to contain the virtual circuit.

CrossConnectMappings []VirtualCircuitCrossConnectMappingArgs

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

CustomerAsn string

CustomerBgpAsn int

(Updatable) 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

(Updatable) 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

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

FreeformTags map[string]string

GatewayId string

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

IpMtu string

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

IsBfdEnabled bool

(Updatable) 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

(Updatable) 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 you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

ProviderServiceKeyName string

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

ProviderState string

PublicPrefixes []VirtualCircuitPublicPrefixArgs

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

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. Example: phx

RoutingPolicies []string

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

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

VirtualCircuitRedundancyMetadatas []VirtualCircuitVirtualCircuitRedundancyMetadataArgs

This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

bandwidthShapeName String

bgpAdminState String

(Updatable) 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

(Updatable) The OCID of the compartment to contain the virtual circuit.

crossConnectMappings List<VirtualCircuitCrossConnectMapping>

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

customerAsn String

customerBgpAsn Integer

(Updatable) 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>

(Updatable) 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

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

freeformTags Map<String,String>

gatewayId String

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

ipMtu String

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

isBfdEnabled Boolean

(Updatable) 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

(Updatable) 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 you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

providerServiceKeyName String

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

providerState String

publicPrefixes List<VirtualCircuitPublicPrefix>

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

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. Example: phx

routingPolicies List<String>

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

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

virtualCircuitRedundancyMetadatas List<VirtualCircuitVirtualCircuitRedundancyMetadata>

This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

bandwidthShapeName string

bgpAdminState string

(Updatable) 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

(Updatable) The OCID of the compartment to contain the virtual circuit.

crossConnectMappings VirtualCircuitCrossConnectMapping[]

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

customerAsn string

customerBgpAsn number

(Updatable) 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}

(Updatable) 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

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

freeformTags {[key: string]: string}

gatewayId string

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

ipMtu string

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

isBfdEnabled boolean

(Updatable) 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

(Updatable) 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 you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

providerServiceKeyName string

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

providerState string

publicPrefixes VirtualCircuitPublicPrefix[]

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

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. Example: phx

routingPolicies string[]

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

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

virtualCircuitRedundancyMetadatas VirtualCircuitVirtualCircuitRedundancyMetadata[]

This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

bandwidth_shape_name str

bgp_admin_state str

(Updatable) 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

(Updatable) The OCID of the compartment to contain the virtual circuit.

cross_connect_mappings Sequence[VirtualCircuitCrossConnectMappingArgs]

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

customer_asn str

customer_bgp_asn int

(Updatable) 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]

(Updatable) 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

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

freeform_tags Mapping[str, str]

gateway_id str

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

ip_mtu str

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

is_bfd_enabled bool

(Updatable) 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

(Updatable) 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 you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

provider_service_key_name str

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

provider_state str

public_prefixes Sequence[VirtualCircuitPublicPrefixArgs]

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

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. Example: phx

routing_policies Sequence[str]

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

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

virtual_circuit_redundancy_metadatas Sequence[VirtualCircuitVirtualCircuitRedundancyMetadataArgs]

This resource provides redundancy level details for the virtual circuit. For more about redundancy, see FastConnect Redundancy Best Practices.

bandwidthShapeName String

bgpAdminState String

(Updatable) 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

(Updatable) The OCID of the compartment to contain the virtual circuit.

crossConnectMappings List<Property Map>

(Updatable) Create a CrossConnectMapping for each cross-connect or cross-connect group this virtual circuit will run on.

customerAsn String

customerBgpAsn Number

(Updatable) 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>

(Updatable) 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

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

freeformTags Map<String>

gatewayId String

(Updatable) For private virtual circuits only. The OCID of the dynamic routing gateway (DRG) that this virtual circuit uses.

ipMtu String

(Updatable) The layer 3 IP MTU to use with this virtual circuit.

isBfdEnabled Boolean

(Updatable) 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

(Updatable) 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 you're connecting via a provider). To get a list of the available service offerings, see ListFastConnectProviderServices.

providerServiceKeyName String

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

providerState String

publicPrefixes List<Property Map>

(Updatable) For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection.

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. Example: phx

routingPolicies List<String>

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

The type of IP addresses used in this virtual circuit. PRIVATE means RFC 1918 addresses (10.0.0.0/8, 172.16/12, and 192.168/16).

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

VirtualCircuitCrossConnectMapping, VirtualCircuitCrossConnectMappingArgs

BgpMd5authKey string

(Updatable) 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

(Updatable) 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

(Updatable) 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.

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.18/31

CustomerBgpPeeringIpv6 string

(Updatable) IPv6 is currently supported only in the Government Cloud. 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.

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.

Example: 2001:db8::1/64

OracleBgpPeeringIp string

(Updatable) The IPv4 address for Oracle's end of the BGP session. Must use a subnet mask from /28 to /31. 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.

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.19/31

OracleBgpPeeringIpv6 string

(Updatable) IPv6 is currently supported only in the Government Cloud. 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.

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

Note that IPv6 addressing is currently supported only in certain regions. See IPv6 Addresses.

Example: 2001:db8::2/64

Vlan int

(Updatable) 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

(Updatable) 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

CustomerBgpPeeringIp string

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.18/31

CustomerBgpPeeringIpv6 string

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.

Example: 2001:db8::1/64

OracleBgpPeeringIp string

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.19/31

OracleBgpPeeringIpv6 string

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

Note that IPv6 addressing is currently supported only in certain regions. See IPv6 Addresses.

Example: 2001:db8::2/64

Vlan int

bgpMd5authKey String

(Updatable) 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

customerBgpPeeringIp String

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.18/31

customerBgpPeeringIpv6 String

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.

Example: 2001:db8::1/64

oracleBgpPeeringIp String

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.19/31

oracleBgpPeeringIpv6 String

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

Note that IPv6 addressing is currently supported only in certain regions. See IPv6 Addresses.

Example: 2001:db8::2/64

vlan Integer

bgpMd5authKey string

(Updatable) 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

customerBgpPeeringIp string

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.18/31

customerBgpPeeringIpv6 string

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.

Example: 2001:db8::1/64

oracleBgpPeeringIp string

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.19/31

oracleBgpPeeringIpv6 string

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

Note that IPv6 addressing is currently supported only in certain regions. See IPv6 Addresses.

Example: 2001:db8::2/64

vlan number

bgp_md5auth_key str

(Updatable) 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

customer_bgp_peering_ip str

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.18/31

customer_bgp_peering_ipv6 str

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.

Example: 2001:db8::1/64

oracle_bgp_peering_ip str

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.19/31

oracle_bgp_peering_ipv6 str

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

Note that IPv6 addressing is currently supported only in certain regions. See IPv6 Addresses.

Example: 2001:db8::2/64

vlan int

bgpMd5authKey String

(Updatable) 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

customerBgpPeeringIp String

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.18/31

customerBgpPeeringIpv6 String

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.

Example: 2001:db8::1/64

oracleBgpPeeringIp String

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.

Example: 10.0.0.19/31

oracleBgpPeeringIpv6 String

There's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.

Note that IPv6 addressing is currently supported only in certain regions. See IPv6 Addresses.

Example: 2001:db8::2/64

vlan Number

VirtualCircuitPublicPrefix, VirtualCircuitPublicPrefixArgs

CidrBlock string: (Updatable) An individual public IP prefix (CIDR) to add to the public virtual circuit. All prefix sizes are allowed.

CidrBlock string: (Updatable) An individual public IP prefix (CIDR) to add to the public virtual circuit. All prefix sizes are allowed.

cidrBlock String: (Updatable) An individual public IP prefix (CIDR) to add to the public virtual circuit. All prefix sizes are allowed.

cidrBlock string: (Updatable) An individual public IP prefix (CIDR) to add to the public virtual circuit. All prefix sizes are allowed.

cidr_block str: (Updatable) An individual public IP prefix (CIDR) to add to the public virtual circuit. All prefix sizes are allowed.

cidrBlock String: (Updatable) An individual public IP prefix (CIDR) to add to the public virtual circuit. All prefix sizes are allowed.

VirtualCircuitVirtualCircuitRedundancyMetadata, VirtualCircuitVirtualCircuitRedundancyMetadataArgs

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.

Import

VirtualCircuits can be imported using the id, e.g.

$ pulumi import oci:Core/virtualCircuit:VirtualCircuit test_virtual_circuit "id"

To learn more about importing existing cloud resources, see Importing resources.

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 v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi

pulumi/pulumi-oci

oci.Core.VirtualCircuit

On this page

On this page

Example Usage

Create VirtualCircuit Resource

Constructor syntax

Parameters

Constructor example

VirtualCircuit Resource Properties

Inputs

Outputs

Look up Existing VirtualCircuit Resource

Supporting Types

VirtualCircuitCrossConnectMapping, VirtualCircuitCrossConnectMappingArgs

VirtualCircuitPublicPrefix, VirtualCircuitPublicPrefixArgs

VirtualCircuitVirtualCircuitRedundancyMetadata, VirtualCircuitVirtualCircuitRedundancyMetadataArgs

Import

Package Details

On this page

On this page