Class CreateVirtualCircuitDetails

Inheritance
object
CreateVirtualCircuitDetails
Inherited Members
Namespace: Oci.CoreService.Models
Assembly: OCI.DotNetSDK.Core.dll
Syntax
public class CreateVirtualCircuitDetails

Properties

BandwidthShapeName

Declaration
[JsonProperty(PropertyName = "bandwidthShapeName")]
public string BandwidthShapeName { get; set; }
Property Value
Type Description
string

The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see {@link #listFastConnectProviderVirtualCircuitBandwidthShapes(ListFastConnectProviderVirtualCircuitBandwidthShapesRequest) listFastConnectProviderVirtualCircuitBandwidthShapes}.
Example: 10 Gbps

BgpAdminState

Declaration
[JsonProperty(PropertyName = "bgpAdminState")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateVirtualCircuitDetails.BgpAdminStateEnum? BgpAdminState { get; set; }
Property Value
Type Description
CreateVirtualCircuitDetails.BgpAdminStateEnum?

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

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment to contain the virtual circuit.
Remarks

Required

CrossConnectMappings

Declaration
[JsonProperty(PropertyName = "crossConnectMappings")]
public List<CrossConnectMapping> CrossConnectMappings { get; set; }
Property Value
Type Description
List<CrossConnectMapping>

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

CustomerAsn

Declaration
[JsonProperty(PropertyName = "customerAsn")]
public long? CustomerAsn { get; set; }
Property Value
Type Description
long?

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

Declaration
[JsonProperty(PropertyName = "customerBgpAsn")]
public int? CustomerBgpAsn { get; set; }
Property Value
Type Description
int?

Deprecated. Instead use customerAsn. If you specify values for both, the request will be rejected.

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

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

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}

GatewayId

Declaration
[JsonProperty(PropertyName = "gatewayId")]
public string GatewayId { get; set; }
Property Value
Type Description
string

For private virtual circuits only. The OCID of the {@link Drg} that this virtual circuit uses.

IpMtu

Declaration
[JsonProperty(PropertyName = "ipMtu")]
[JsonConverter(typeof(StringEnumConverter))]
public VirtualCircuitIpMtu? IpMtu { get; set; }
Property Value
Type Description
VirtualCircuitIpMtu?

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

IsBfdEnabled

Declaration
[JsonProperty(PropertyName = "isBfdEnabled")]
public bool? IsBfdEnabled { get; set; }
Property Value
Type Description
bool?

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

IsTransportMode

Declaration
[JsonProperty(PropertyName = "isTransportMode")]
public bool? IsTransportMode { get; set; }
Property Value
Type Description
bool?

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

ProviderName

Declaration
[JsonProperty(PropertyName = "providerName")]
public string ProviderName { get; set; }
Property Value
Type Description
string

Deprecated. Instead use providerServiceId. To get a list of the provider names, see {@link #listFastConnectProviderServices(ListFastConnectProviderServicesRequest) listFastConnectProviderServices}.

ProviderServiceId

Declaration
[JsonProperty(PropertyName = "providerServiceId")]
public string ProviderServiceId { get; set; }
Property Value
Type Description
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 {@link #listFastConnectProviderServices(ListFastConnectProviderServicesRequest) listFastConnectProviderServices}.

ProviderServiceKeyName

Declaration
[JsonProperty(PropertyName = "providerServiceKeyName")]
public string ProviderServiceKeyName { get; set; }
Property Value
Type Description
string

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

ProviderServiceName

Declaration
[JsonProperty(PropertyName = "providerServiceName")]
public string ProviderServiceName { get; set; }
Property Value
Type Description
string

Deprecated. Instead use providerServiceId. To get a list of the provider names, see {@link #listFastConnectProviderServices(ListFastConnectProviderServicesRequest) listFastConnectProviderServices}.

PublicPrefixes

Declaration
[JsonProperty(PropertyName = "publicPrefixes")]
public List<CreateVirtualCircuitPublicPrefixDetails> PublicPrefixes { get; set; }
Property Value
Type Description
List<CreateVirtualCircuitPublicPrefixDetails>

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

Region

Declaration
[JsonProperty(PropertyName = "region")]
public string Region { get; set; }
Property Value
Type Description
string

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

RoutingPolicy

Declaration
[JsonProperty(PropertyName = "routingPolicy", ItemConverterType = typeof(StringEnumConverter))]
public List<CreateVirtualCircuitDetails.RoutingPolicyEnum> RoutingPolicy { get; set; }
Property Value
Type Description
List<CreateVirtualCircuitDetails.RoutingPolicyEnum>

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.

Type

Declaration
[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateVirtualCircuitDetails.TypeEnum? Type { get; set; }
Property Value
Type Description
CreateVirtualCircuitDetails.TypeEnum?

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).
Remarks

Required