Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
oci.Core.getVirtualCircuits
Explore with Pulumi AI
This data source provides the list of Virtual Circuits in Oracle Cloud Infrastructure Core service.
Lists the virtual circuits in the specified compartment.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testVirtualCircuits = oci.Core.getVirtualCircuits({
compartmentId: compartmentId,
displayName: virtualCircuitDisplayName,
state: virtualCircuitState,
});
import pulumi
import pulumi_oci as oci
test_virtual_circuits = oci.Core.get_virtual_circuits(compartment_id=compartment_id,
display_name=virtual_circuit_display_name,
state=virtual_circuit_state)
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.GetVirtualCircuits(ctx, &core.GetVirtualCircuitsArgs{
CompartmentId: compartmentId,
DisplayName: pulumi.StringRef(virtualCircuitDisplayName),
State: pulumi.StringRef(virtualCircuitState),
}, 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 testVirtualCircuits = Oci.Core.GetVirtualCircuits.Invoke(new()
{
CompartmentId = compartmentId,
DisplayName = virtualCircuitDisplayName,
State = virtualCircuitState,
});
});
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.GetVirtualCircuitsArgs;
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 testVirtualCircuits = CoreFunctions.getVirtualCircuits(GetVirtualCircuitsArgs.builder()
.compartmentId(compartmentId)
.displayName(virtualCircuitDisplayName)
.state(virtualCircuitState)
.build());
}
}
variables:
testVirtualCircuits:
fn::invoke:
Function: oci:Core:getVirtualCircuits
Arguments:
compartmentId: ${compartmentId}
displayName: ${virtualCircuitDisplayName}
state: ${virtualCircuitState}
Using getVirtualCircuits
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.
function getVirtualCircuits(args: GetVirtualCircuitsArgs, opts?: InvokeOptions): Promise<GetVirtualCircuitsResult>
function getVirtualCircuitsOutput(args: GetVirtualCircuitsOutputArgs, opts?: InvokeOptions): Output<GetVirtualCircuitsResult>
def get_virtual_circuits(compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
filters: Optional[Sequence[_core.GetVirtualCircuitsFilter]] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetVirtualCircuitsResult
def get_virtual_circuits_output(compartment_id: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetVirtualCircuitsFilterArgs]]]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetVirtualCircuitsResult]
func GetVirtualCircuits(ctx *Context, args *GetVirtualCircuitsArgs, opts ...InvokeOption) (*GetVirtualCircuitsResult, error)
func GetVirtualCircuitsOutput(ctx *Context, args *GetVirtualCircuitsOutputArgs, opts ...InvokeOption) GetVirtualCircuitsResultOutput
> Note: This function is named GetVirtualCircuits
in the Go SDK.
public static class GetVirtualCircuits
{
public static Task<GetVirtualCircuitsResult> InvokeAsync(GetVirtualCircuitsArgs args, InvokeOptions? opts = null)
public static Output<GetVirtualCircuitsResult> Invoke(GetVirtualCircuitsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetVirtualCircuitsResult> getVirtualCircuits(GetVirtualCircuitsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Core/getVirtualCircuits:getVirtualCircuits
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
List<Get
Virtual Circuits Filter> - State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- Compartment
Id string - The OCID of the compartment.
- Display
Name string - A filter to return only resources that match the given display name exactly.
- Filters
[]Get
Virtual Circuits Filter - State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters
List<Get
Virtual Circuits Filter> - state String
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id string - The OCID of the compartment.
- display
Name string - A filter to return only resources that match the given display name exactly.
- filters
Get
Virtual Circuits Filter[] - state string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment_
id str - The OCID of the compartment.
- display_
name str - A filter to return only resources that match the given display name exactly.
- filters
Sequence[core.
Get Virtual Circuits Filter] - state str
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- compartment
Id String - The OCID of the compartment.
- display
Name String - A filter to return only resources that match the given display name exactly.
- filters List<Property Map>
- state String
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
getVirtualCircuits Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment containing the virtual circuit.
- Id string
- The provider-assigned unique ID for this managed resource.
- Virtual
Circuits List<GetVirtual Circuits Virtual Circuit> - The list of virtual_circuits.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
List<Get
Virtual Circuits Filter> - State string
- The virtual circuit's current state. For information about the different states, see FastConnect Overview.
- Compartment
Id string - The OCID of the compartment containing the virtual circuit.
- Id string
- The provider-assigned unique ID for this managed resource.
- Virtual
Circuits []GetVirtual Circuits Virtual Circuit - The list of virtual_circuits.
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Filters
[]Get
Virtual Circuits Filter - State string
- The virtual circuit's current state. For information about the different states, see FastConnect Overview.
- compartment
Id String - The OCID of the compartment containing the virtual circuit.
- id String
- The provider-assigned unique ID for this managed resource.
- virtual
Circuits List<GetVirtual Circuits Virtual Circuit> - The list of virtual_circuits.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
List<Get
Virtual Circuits Filter> - state String
- The virtual circuit's current state. For information about the different states, see FastConnect Overview.
- compartment
Id string - The OCID of the compartment containing the virtual circuit.
- id string
- The provider-assigned unique ID for this managed resource.
- virtual
Circuits GetVirtual Circuits Virtual Circuit[] - The list of virtual_circuits.
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Get
Virtual Circuits Filter[] - state string
- The virtual circuit's current state. For information about the different states, see FastConnect Overview.
- compartment_
id str - The OCID of the compartment containing the virtual circuit.
- id str
- The provider-assigned unique ID for this managed resource.
- virtual_
circuits Sequence[core.Get Virtual Circuits Virtual Circuit] - The list of virtual_circuits.
- display_
name str - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters
Sequence[core.
Get Virtual Circuits Filter] - state str
- The virtual circuit's current state. For information about the different states, see FastConnect Overview.
- compartment
Id String - The OCID of the compartment containing the virtual circuit.
- id String
- The provider-assigned unique ID for this managed resource.
- virtual
Circuits List<Property Map> - The list of virtual_circuits.
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- filters List<Property Map>
- state String
- The virtual circuit's current state. For information about the different states, see FastConnect Overview.
Supporting Types
GetVirtualCircuitsFilter
GetVirtualCircuitsVirtualCircuit
- Bandwidth
Shape stringName - 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 stringState - Set to
ENABLED
(the default) to activate the BGP session of the virtual circuit, set toDISABLED
to deactivate the virtual circuit. - Bgp
Ipv6session stringState - The state of the Ipv6 BGP session associated with the virtual circuit.
- Bgp
Management string - Deprecated. Instead use the information in FastConnectProviderService.
- Bgp
Session stringState - The state of the Ipv4 BGP session associated with the virtual circuit.
- Compartment
Id string - The OCID of the compartment.
- Cross
Connect List<GetMappings Virtual Circuits Virtual Circuit Cross Connect Mapping> - An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
- Customer
Asn 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.
- Customer
Bgp intAsn - Deprecated. Instead use
customerAsn
. If you specify values for both, the request will be rejected. - 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"}
- Display
Name string - A filter to return only resources that match the given display name exactly.
- 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"}
- Gateway
Id 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).
- Ip
Mtu string - The layer 3 IP MTU to use on this virtual circuit.
- Is
Bfd boolEnabled - Set to
true
to enable BFD for IPv4 BGP peering, or set tofalse
to disable BFD. If this is not set, the default isfalse
. - Is
Transport boolMode - Set to
true
for the virtual circuit to carry only encrypted traffic, or set tofalse
for the virtual circuit to carry unencrypted traffic. If this is not set, the default isfalse
. - Oracle
Bgp intAsn - The Oracle BGP ASN.
- Provider
Service stringId - The OCID of the service offered by the provider (if the customer is connecting via a provider).
- Provider
Service stringKey Name - The service key name offered by the provider (if the customer is connecting via a provider).
- Provider
State 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.
- Public
Prefixes List<GetVirtual Circuits Virtual Circuit Public Prefix> - 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 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.
- Routing
Policies 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
, andGLOBAL
. See Route Filtering for details. By default, routing information is shared for all routes in the same market. - Service
Type string - Provider service type.
- State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- Time
Created 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.
- Virtual
Circuit stringId
- Bandwidth
Shape stringName - 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 stringState - Set to
ENABLED
(the default) to activate the BGP session of the virtual circuit, set toDISABLED
to deactivate the virtual circuit. - Bgp
Ipv6session stringState - The state of the Ipv6 BGP session associated with the virtual circuit.
- Bgp
Management string - Deprecated. Instead use the information in FastConnectProviderService.
- Bgp
Session stringState - The state of the Ipv4 BGP session associated with the virtual circuit.
- Compartment
Id string - The OCID of the compartment.
- Cross
Connect []GetMappings Virtual Circuits Virtual Circuit Cross Connect Mapping - An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
- Customer
Asn 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.
- Customer
Bgp intAsn - Deprecated. Instead use
customerAsn
. If you specify values for both, the request will be rejected. - 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"}
- Display
Name string - A filter to return only resources that match the given display name exactly.
- 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"}
- Gateway
Id 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).
- Ip
Mtu string - The layer 3 IP MTU to use on this virtual circuit.
- Is
Bfd boolEnabled - Set to
true
to enable BFD for IPv4 BGP peering, or set tofalse
to disable BFD. If this is not set, the default isfalse
. - Is
Transport boolMode - Set to
true
for the virtual circuit to carry only encrypted traffic, or set tofalse
for the virtual circuit to carry unencrypted traffic. If this is not set, the default isfalse
. - Oracle
Bgp intAsn - The Oracle BGP ASN.
- Provider
Service stringId - The OCID of the service offered by the provider (if the customer is connecting via a provider).
- Provider
Service stringKey Name - The service key name offered by the provider (if the customer is connecting via a provider).
- Provider
State 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.
- Public
Prefixes []GetVirtual Circuits Virtual Circuit Public Prefix - 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 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.
- Routing
Policies []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
, andGLOBAL
. See Route Filtering for details. By default, routing information is shared for all routes in the same market. - Service
Type string - Provider service type.
- State string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- Time
Created 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.
- Virtual
Circuit stringId
- bandwidth
Shape StringName - 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 StringState - Set to
ENABLED
(the default) to activate the BGP session of the virtual circuit, set toDISABLED
to deactivate the virtual circuit. - bgp
Ipv6session StringState - The state of the Ipv6 BGP session associated with the virtual circuit.
- bgp
Management String - Deprecated. Instead use the information in FastConnectProviderService.
- bgp
Session StringState - The state of the Ipv4 BGP session associated with the virtual circuit.
- compartment
Id String - The OCID of the compartment.
- cross
Connect List<GetMappings Virtual Circuits Virtual Circuit Cross Connect Mapping> - An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
- customer
Asn 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.
- customer
Bgp IntegerAsn - Deprecated. Instead use
customerAsn
. If you specify values for both, the request will be rejected. - 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"}
- display
Name String - A filter to return only resources that match the given display name exactly.
- 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"}
- gateway
Id 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).
- ip
Mtu String - The layer 3 IP MTU to use on this virtual circuit.
- is
Bfd BooleanEnabled - Set to
true
to enable BFD for IPv4 BGP peering, or set tofalse
to disable BFD. If this is not set, the default isfalse
. - is
Transport BooleanMode - Set to
true
for the virtual circuit to carry only encrypted traffic, or set tofalse
for the virtual circuit to carry unencrypted traffic. If this is not set, the default isfalse
. - oracle
Bgp IntegerAsn - The Oracle BGP ASN.
- provider
Service StringId - The OCID of the service offered by the provider (if the customer is connecting via a provider).
- provider
Service StringKey Name - The service key name offered by the provider (if the customer is connecting via a provider).
- provider
State 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.
- public
Prefixes List<GetVirtual Circuits Virtual Circuit Public Prefix> - 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 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.
- routing
Policies 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
, andGLOBAL
. See Route Filtering for details. By default, routing information is shared for all routes in the same market. - service
Type String - Provider service type.
- state String
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- time
Created 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.
- virtual
Circuit StringId
- bandwidth
Shape stringName - 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 stringState - Set to
ENABLED
(the default) to activate the BGP session of the virtual circuit, set toDISABLED
to deactivate the virtual circuit. - bgp
Ipv6session stringState - The state of the Ipv6 BGP session associated with the virtual circuit.
- bgp
Management string - Deprecated. Instead use the information in FastConnectProviderService.
- bgp
Session stringState - The state of the Ipv4 BGP session associated with the virtual circuit.
- compartment
Id string - The OCID of the compartment.
- cross
Connect GetMappings Virtual Circuits Virtual Circuit Cross Connect Mapping[] - An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
- customer
Asn 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.
- customer
Bgp numberAsn - Deprecated. Instead use
customerAsn
. If you specify values for both, the request will be rejected. - {[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"}
- display
Name string - A filter to return only resources that match the given display name exactly.
- {[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"}
- gateway
Id 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).
- ip
Mtu string - The layer 3 IP MTU to use on this virtual circuit.
- is
Bfd booleanEnabled - Set to
true
to enable BFD for IPv4 BGP peering, or set tofalse
to disable BFD. If this is not set, the default isfalse
. - is
Transport booleanMode - Set to
true
for the virtual circuit to carry only encrypted traffic, or set tofalse
for the virtual circuit to carry unencrypted traffic. If this is not set, the default isfalse
. - oracle
Bgp numberAsn - The Oracle BGP ASN.
- provider
Service stringId - The OCID of the service offered by the provider (if the customer is connecting via a provider).
- provider
Service stringKey Name - The service key name offered by the provider (if the customer is connecting via a provider).
- provider
State 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.
- public
Prefixes GetVirtual Circuits Virtual Circuit Public Prefix[] - 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 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.
- routing
Policies 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
, andGLOBAL
. See Route Filtering for details. By default, routing information is shared for all routes in the same market. - service
Type string - Provider service type.
- state string
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- time
Created 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.
- virtual
Circuit stringId
- bandwidth_
shape_ strname - 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_ strstate - Set to
ENABLED
(the default) to activate the BGP session of the virtual circuit, set toDISABLED
to deactivate the virtual circuit. - bgp_
ipv6session_ strstate - The state of the Ipv6 BGP session associated with the virtual circuit.
- bgp_
management str - Deprecated. Instead use the information in FastConnectProviderService.
- bgp_
session_ strstate - The state of the Ipv4 BGP session associated with the virtual circuit.
- compartment_
id str - The OCID of the compartment.
- cross_
connect_ Sequence[core.mappings Get Virtual Circuits Virtual Circuit Cross Connect Mapping] - 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_ intasn - Deprecated. Instead use
customerAsn
. If you specify values for both, the request will be rejected. - 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 filter to return only resources that match the given display name exactly.
- 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_ boolenabled - Set to
true
to enable BFD for IPv4 BGP peering, or set tofalse
to disable BFD. If this is not set, the default isfalse
. - is_
transport_ boolmode - Set to
true
for the virtual circuit to carry only encrypted traffic, or set tofalse
for the virtual circuit to carry unencrypted traffic. If this is not set, the default isfalse
. - oracle_
bgp_ intasn - The Oracle BGP ASN.
- provider_
service_ strid - The OCID of the service offered by the provider (if the customer is connecting via a provider).
- provider_
service_ strkey_ name - 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.Get Virtual Circuits Virtual Circuit Public Prefix] - 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
, andGLOBAL
. 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
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- 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_ strid
- bandwidth
Shape StringName - 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 StringState - Set to
ENABLED
(the default) to activate the BGP session of the virtual circuit, set toDISABLED
to deactivate the virtual circuit. - bgp
Ipv6session StringState - The state of the Ipv6 BGP session associated with the virtual circuit.
- bgp
Management String - Deprecated. Instead use the information in FastConnectProviderService.
- bgp
Session StringState - The state of the Ipv4 BGP session associated with the virtual circuit.
- compartment
Id String - The OCID of the compartment.
- cross
Connect List<Property Map>Mappings - An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
- customer
Asn 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.
- customer
Bgp NumberAsn - Deprecated. Instead use
customerAsn
. If you specify values for both, the request will be rejected. - 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"}
- display
Name String - A filter to return only resources that match the given display name exactly.
- 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"}
- gateway
Id 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).
- ip
Mtu String - The layer 3 IP MTU to use on this virtual circuit.
- is
Bfd BooleanEnabled - Set to
true
to enable BFD for IPv4 BGP peering, or set tofalse
to disable BFD. If this is not set, the default isfalse
. - is
Transport BooleanMode - Set to
true
for the virtual circuit to carry only encrypted traffic, or set tofalse
for the virtual circuit to carry unencrypted traffic. If this is not set, the default isfalse
. - oracle
Bgp NumberAsn - The Oracle BGP ASN.
- provider
Service StringId - The OCID of the service offered by the provider (if the customer is connecting via a provider).
- provider
Service StringKey Name - The service key name offered by the provider (if the customer is connecting via a provider).
- provider
State 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.
- public
Prefixes 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.
- reference
Comment 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.
- routing
Policies 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
, andGLOBAL
. See Route Filtering for details. By default, routing information is shared for all routes in the same market. - service
Type String - Provider service type.
- state String
- A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
- time
Created 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.
- virtual
Circuit StringId
GetVirtualCircuitsVirtualCircuitCrossConnectMapping
- Bgp
Md5auth stringKey - 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 stringOr Cross Connect Group Id - 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 stringPeering Ip - 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 stringPeering Ipv6 - 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 stringPeering Ip - 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.
- Oracle
Bgp stringPeering Ipv6 - 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
- Bgp
Md5auth stringKey - 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 stringOr Cross Connect Group Id - 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 stringPeering Ip - 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 stringPeering Ipv6 - 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 stringPeering Ip - 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.
- Oracle
Bgp stringPeering Ipv6 - 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
- bgp
Md5auth StringKey - 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 StringOr Cross Connect Group Id - 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 StringPeering Ip - 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 StringPeering Ipv6 - 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 StringPeering Ip - 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.
- oracle
Bgp StringPeering Ipv6 - 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
- bgp
Md5auth stringKey - 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 stringOr Cross Connect Group Id - 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 stringPeering Ip - 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 stringPeering Ipv6 - 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 stringPeering Ip - 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.
- oracle
Bgp stringPeering Ipv6 - 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_ strkey - 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_ stror_ cross_ connect_ group_ id - 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_ strpeering_ ip - 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_ strpeering_ ipv6 - 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_ strpeering_ ip - 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.
- oracle_
bgp_ strpeering_ ipv6 - 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
- bgp
Md5auth StringKey - 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 StringOr Cross Connect Group Id - 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 StringPeering Ip - 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 StringPeering Ipv6 - 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 StringPeering Ip - 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.
- oracle
Bgp StringPeering Ipv6 - 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
GetVirtualCircuitsVirtualCircuitPublicPrefix
- Cidr
Block string
- Cidr
Block string
- cidr
Block String
- cidr
Block string
- cidr_
block str
- cidr
Block String
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.