Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. DcVirtualInterfaceV3
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.DcVirtualInterfaceV3

Explore with Pulumi AI

opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

Manages a virtual interface v3 resource within OpenTelekomCloud.

NOTE: Direct Connect v3 API that are used in this resource officially supported only on SwissCloud now.

Example Usage

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

const config = new pulumi.Config();
const directConnectId = config.requireObject("directConnectId");
const gatewayId = config.requireObject("gatewayId");
const interfaceName = config.requireObject("interfaceName");
const vi = new opentelekomcloud.DcVirtualInterfaceV3("vi", {
    directConnectId: directConnectId,
    vgwId: gatewayId,
    type: "private",
    routeMode: "static",
    vlan: 522,
    bandwidth: 5,
    remoteEpGroups: ["1.1.1.0/30"],
    addressFamily: "ipv4",
    localGatewayV4Ip: "1.1.1.1/30",
    remoteGatewayV4Ip: "1.1.1.2/30",
});
Copy
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

config = pulumi.Config()
direct_connect_id = config.require_object("directConnectId")
gateway_id = config.require_object("gatewayId")
interface_name = config.require_object("interfaceName")
vi = opentelekomcloud.DcVirtualInterfaceV3("vi",
    direct_connect_id=direct_connect_id,
    vgw_id=gateway_id,
    type="private",
    route_mode="static",
    vlan=522,
    bandwidth=5,
    remote_ep_groups=["1.1.1.0/30"],
    address_family="ipv4",
    local_gateway_v4_ip="1.1.1.1/30",
    remote_gateway_v4_ip="1.1.1.2/30")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		directConnectId := cfg.RequireObject("directConnectId")
		gatewayId := cfg.RequireObject("gatewayId")
		interfaceName := cfg.RequireObject("interfaceName")
		_, err := opentelekomcloud.NewDcVirtualInterfaceV3(ctx, "vi", &opentelekomcloud.DcVirtualInterfaceV3Args{
			DirectConnectId: pulumi.Any(directConnectId),
			VgwId:           pulumi.Any(gatewayId),
			Type:            pulumi.String("private"),
			RouteMode:       pulumi.String("static"),
			Vlan:            pulumi.Float64(522),
			Bandwidth:       pulumi.Float64(5),
			RemoteEpGroups: pulumi.StringArray{
				pulumi.String("1.1.1.0/30"),
			},
			AddressFamily:     pulumi.String("ipv4"),
			LocalGatewayV4Ip:  pulumi.String("1.1.1.1/30"),
			RemoteGatewayV4Ip: pulumi.String("1.1.1.2/30"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var directConnectId = config.RequireObject<dynamic>("directConnectId");
    var gatewayId = config.RequireObject<dynamic>("gatewayId");
    var interfaceName = config.RequireObject<dynamic>("interfaceName");
    var vi = new Opentelekomcloud.DcVirtualInterfaceV3("vi", new()
    {
        DirectConnectId = directConnectId,
        VgwId = gatewayId,
        Type = "private",
        RouteMode = "static",
        Vlan = 522,
        Bandwidth = 5,
        RemoteEpGroups = new[]
        {
            "1.1.1.0/30",
        },
        AddressFamily = "ipv4",
        LocalGatewayV4Ip = "1.1.1.1/30",
        RemoteGatewayV4Ip = "1.1.1.2/30",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.DcVirtualInterfaceV3;
import com.pulumi.opentelekomcloud.DcVirtualInterfaceV3Args;
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 config = ctx.config();
        final var directConnectId = config.get("directConnectId");
        final var gatewayId = config.get("gatewayId");
        final var interfaceName = config.get("interfaceName");
        var vi = new DcVirtualInterfaceV3("vi", DcVirtualInterfaceV3Args.builder()
            .directConnectId(directConnectId)
            .vgwId(gatewayId)
            .type("private")
            .routeMode("static")
            .vlan(522)
            .bandwidth(5)
            .remoteEpGroups("1.1.1.0/30")
            .addressFamily("ipv4")
            .localGatewayV4Ip("1.1.1.1/30")
            .remoteGatewayV4Ip("1.1.1.2/30")
            .build());

    }
}
Copy
configuration:
  directConnectId:
    type: dynamic
  gatewayId:
    type: dynamic
  interfaceName:
    type: dynamic
resources:
  vi:
    type: opentelekomcloud:DcVirtualInterfaceV3
    properties:
      directConnectId: ${directConnectId}
      vgwId: ${gatewayId}
      type: private
      routeMode: static
      vlan: 522
      bandwidth: 5
      remoteEpGroups:
        - 1.1.1.0/30
      addressFamily: ipv4
      localGatewayV4Ip: 1.1.1.1/30
      remoteGatewayV4Ip: 1.1.1.2/30
Copy

Create DcVirtualInterfaceV3 Resource

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

Constructor syntax

new DcVirtualInterfaceV3(name: string, args: DcVirtualInterfaceV3Args, opts?: CustomResourceOptions);
@overload
def DcVirtualInterfaceV3(resource_name: str,
                         args: DcVirtualInterfaceV3Args,
                         opts: Optional[ResourceOptions] = None)

@overload
def DcVirtualInterfaceV3(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         remote_ep_groups: Optional[Sequence[str]] = None,
                         vlan: Optional[float] = None,
                         bandwidth: Optional[float] = None,
                         vgw_id: Optional[str] = None,
                         type: Optional[str] = None,
                         route_mode: Optional[str] = None,
                         direct_connect_id: Optional[str] = None,
                         local_gateway_v4_ip: Optional[str] = None,
                         remote_gateway_v4_ip: Optional[str] = None,
                         lag_id: Optional[str] = None,
                         address_family: Optional[str] = None,
                         local_gateway_v6_ip: Optional[str] = None,
                         name: Optional[str] = None,
                         enable_bfd: Optional[bool] = None,
                         enable_nqa: Optional[bool] = None,
                         remote_gateway_v6_ip: Optional[str] = None,
                         resource_tenant_id: Optional[str] = None,
                         description: Optional[str] = None,
                         service_ep_groups: Optional[Sequence[str]] = None,
                         dc_virtual_interface_v3_id: Optional[str] = None,
                         bgp_md5: Optional[str] = None,
                         asn: Optional[float] = None)
func NewDcVirtualInterfaceV3(ctx *Context, name string, args DcVirtualInterfaceV3Args, opts ...ResourceOption) (*DcVirtualInterfaceV3, error)
public DcVirtualInterfaceV3(string name, DcVirtualInterfaceV3Args args, CustomResourceOptions? opts = null)
public DcVirtualInterfaceV3(String name, DcVirtualInterfaceV3Args args)
public DcVirtualInterfaceV3(String name, DcVirtualInterfaceV3Args args, CustomResourceOptions options)

type: opentelekomcloud:DcVirtualInterfaceV3
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DcVirtualInterfaceV3Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DcVirtualInterfaceV3Args
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DcVirtualInterfaceV3Args
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DcVirtualInterfaceV3Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DcVirtualInterfaceV3Args
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 dcVirtualInterfaceV3Resource = new Opentelekomcloud.DcVirtualInterfaceV3("dcVirtualInterfaceV3Resource", new()
{
    RemoteEpGroups = new[]
    {
        "string",
    },
    Vlan = 0,
    Bandwidth = 0,
    VgwId = "string",
    Type = "string",
    RouteMode = "string",
    DirectConnectId = "string",
    LocalGatewayV4Ip = "string",
    RemoteGatewayV4Ip = "string",
    LagId = "string",
    AddressFamily = "string",
    LocalGatewayV6Ip = "string",
    Name = "string",
    EnableBfd = false,
    EnableNqa = false,
    RemoteGatewayV6Ip = "string",
    ResourceTenantId = "string",
    Description = "string",
    ServiceEpGroups = new[]
    {
        "string",
    },
    DcVirtualInterfaceV3Id = "string",
    BgpMd5 = "string",
    Asn = 0,
});
Copy
example, err := opentelekomcloud.NewDcVirtualInterfaceV3(ctx, "dcVirtualInterfaceV3Resource", &opentelekomcloud.DcVirtualInterfaceV3Args{
	RemoteEpGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	Vlan:              pulumi.Float64(0),
	Bandwidth:         pulumi.Float64(0),
	VgwId:             pulumi.String("string"),
	Type:              pulumi.String("string"),
	RouteMode:         pulumi.String("string"),
	DirectConnectId:   pulumi.String("string"),
	LocalGatewayV4Ip:  pulumi.String("string"),
	RemoteGatewayV4Ip: pulumi.String("string"),
	LagId:             pulumi.String("string"),
	AddressFamily:     pulumi.String("string"),
	LocalGatewayV6Ip:  pulumi.String("string"),
	Name:              pulumi.String("string"),
	EnableBfd:         pulumi.Bool(false),
	EnableNqa:         pulumi.Bool(false),
	RemoteGatewayV6Ip: pulumi.String("string"),
	ResourceTenantId:  pulumi.String("string"),
	Description:       pulumi.String("string"),
	ServiceEpGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	DcVirtualInterfaceV3Id: pulumi.String("string"),
	BgpMd5:                 pulumi.String("string"),
	Asn:                    pulumi.Float64(0),
})
Copy
var dcVirtualInterfaceV3Resource = new DcVirtualInterfaceV3("dcVirtualInterfaceV3Resource", DcVirtualInterfaceV3Args.builder()
    .remoteEpGroups("string")
    .vlan(0)
    .bandwidth(0)
    .vgwId("string")
    .type("string")
    .routeMode("string")
    .directConnectId("string")
    .localGatewayV4Ip("string")
    .remoteGatewayV4Ip("string")
    .lagId("string")
    .addressFamily("string")
    .localGatewayV6Ip("string")
    .name("string")
    .enableBfd(false)
    .enableNqa(false)
    .remoteGatewayV6Ip("string")
    .resourceTenantId("string")
    .description("string")
    .serviceEpGroups("string")
    .dcVirtualInterfaceV3Id("string")
    .bgpMd5("string")
    .asn(0)
    .build());
Copy
dc_virtual_interface_v3_resource = opentelekomcloud.DcVirtualInterfaceV3("dcVirtualInterfaceV3Resource",
    remote_ep_groups=["string"],
    vlan=0,
    bandwidth=0,
    vgw_id="string",
    type="string",
    route_mode="string",
    direct_connect_id="string",
    local_gateway_v4_ip="string",
    remote_gateway_v4_ip="string",
    lag_id="string",
    address_family="string",
    local_gateway_v6_ip="string",
    name="string",
    enable_bfd=False,
    enable_nqa=False,
    remote_gateway_v6_ip="string",
    resource_tenant_id="string",
    description="string",
    service_ep_groups=["string"],
    dc_virtual_interface_v3_id="string",
    bgp_md5="string",
    asn=0)
Copy
const dcVirtualInterfaceV3Resource = new opentelekomcloud.DcVirtualInterfaceV3("dcVirtualInterfaceV3Resource", {
    remoteEpGroups: ["string"],
    vlan: 0,
    bandwidth: 0,
    vgwId: "string",
    type: "string",
    routeMode: "string",
    directConnectId: "string",
    localGatewayV4Ip: "string",
    remoteGatewayV4Ip: "string",
    lagId: "string",
    addressFamily: "string",
    localGatewayV6Ip: "string",
    name: "string",
    enableBfd: false,
    enableNqa: false,
    remoteGatewayV6Ip: "string",
    resourceTenantId: "string",
    description: "string",
    serviceEpGroups: ["string"],
    dcVirtualInterfaceV3Id: "string",
    bgpMd5: "string",
    asn: 0,
});
Copy
type: opentelekomcloud:DcVirtualInterfaceV3
properties:
    addressFamily: string
    asn: 0
    bandwidth: 0
    bgpMd5: string
    dcVirtualInterfaceV3Id: string
    description: string
    directConnectId: string
    enableBfd: false
    enableNqa: false
    lagId: string
    localGatewayV4Ip: string
    localGatewayV6Ip: string
    name: string
    remoteEpGroups:
        - string
    remoteGatewayV4Ip: string
    remoteGatewayV6Ip: string
    resourceTenantId: string
    routeMode: string
    serviceEpGroups:
        - string
    type: string
    vgwId: string
    vlan: 0
Copy

DcVirtualInterfaceV3 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 DcVirtualInterfaceV3 resource accepts the following input properties:

Bandwidth This property is required. double
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
DirectConnectId This property is required. string
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
RemoteEpGroups This property is required. List<string>
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
RouteMode This property is required. string
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
Type This property is required. string
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
VgwId This property is required. string
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
Vlan This property is required. double
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.
AddressFamily string
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
Asn double
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
BgpMd5 string
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
DcVirtualInterfaceV3Id string
The VIF peer resource ID.
Description string
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
EnableBfd bool
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
EnableNqa bool

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

LagId string
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
LocalGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
LocalGatewayV6Ip string
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
Name string
Specifies the name of the virtual interface.
RemoteGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
RemoteGatewayV6Ip string

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

ResourceTenantId string
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
ServiceEpGroups List<string>
Specifies the subnets that access Internet services through a connection.
Bandwidth This property is required. float64
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
DirectConnectId This property is required. string
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
RemoteEpGroups This property is required. []string
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
RouteMode This property is required. string
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
Type This property is required. string
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
VgwId This property is required. string
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
Vlan This property is required. float64
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.
AddressFamily string
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
Asn float64
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
BgpMd5 string
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
DcVirtualInterfaceV3Id string
The VIF peer resource ID.
Description string
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
EnableBfd bool
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
EnableNqa bool

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

LagId string
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
LocalGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
LocalGatewayV6Ip string
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
Name string
Specifies the name of the virtual interface.
RemoteGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
RemoteGatewayV6Ip string

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

ResourceTenantId string
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
ServiceEpGroups []string
Specifies the subnets that access Internet services through a connection.
bandwidth This property is required. Double
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
directConnectId This property is required. String
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
remoteEpGroups This property is required. List<String>
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
routeMode This property is required. String
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
type This property is required. String
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
vgwId This property is required. String
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
vlan This property is required. Double
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.
addressFamily String
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
asn Double
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
bgpMd5 String
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
dcVirtualInterfaceV3Id String
The VIF peer resource ID.
description String
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
enableBfd Boolean
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enableNqa Boolean

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

lagId String
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
localGatewayV4Ip String
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
localGatewayV6Ip String
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
name String
Specifies the name of the virtual interface.
remoteGatewayV4Ip String
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
remoteGatewayV6Ip String

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

resourceTenantId String
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
serviceEpGroups List<String>
Specifies the subnets that access Internet services through a connection.
bandwidth This property is required. number
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
directConnectId This property is required. string
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
remoteEpGroups This property is required. string[]
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
routeMode This property is required. string
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
type This property is required. string
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
vgwId This property is required. string
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
vlan This property is required. number
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.
addressFamily string
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
asn number
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
bgpMd5 string
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
dcVirtualInterfaceV3Id string
The VIF peer resource ID.
description string
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
enableBfd boolean
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enableNqa boolean

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

lagId string
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
localGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
localGatewayV6Ip string
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
name string
Specifies the name of the virtual interface.
remoteGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
remoteGatewayV6Ip string

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

resourceTenantId string
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
serviceEpGroups string[]
Specifies the subnets that access Internet services through a connection.
bandwidth This property is required. float
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
direct_connect_id This property is required. str
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
remote_ep_groups This property is required. Sequence[str]
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
route_mode This property is required. str
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
type This property is required. str
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
vgw_id This property is required. str
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
vlan This property is required. float
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.
address_family str
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
asn float
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
bgp_md5 str
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
dc_virtual_interface_v3_id str
The VIF peer resource ID.
description str
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
enable_bfd bool
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enable_nqa bool

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

lag_id str
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
local_gateway_v4_ip str
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
local_gateway_v6_ip str
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
name str
Specifies the name of the virtual interface.
remote_gateway_v4_ip str
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
remote_gateway_v6_ip str

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

resource_tenant_id str
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
service_ep_groups Sequence[str]
Specifies the subnets that access Internet services through a connection.
bandwidth This property is required. Number
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
directConnectId This property is required. String
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
remoteEpGroups This property is required. List<String>
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
routeMode This property is required. String
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
type This property is required. String
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
vgwId This property is required. String
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
vlan This property is required. Number
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.
addressFamily String
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
asn Number
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
bgpMd5 String
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
dcVirtualInterfaceV3Id String
The VIF peer resource ID.
description String
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
enableBfd Boolean
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enableNqa Boolean

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

lagId String
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
localGatewayV4Ip String
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
localGatewayV6Ip String
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
name String
Specifies the name of the virtual interface.
remoteGatewayV4Ip String
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
remoteGatewayV6Ip String

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

resourceTenantId String
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
serviceEpGroups List<String>
Specifies the subnets that access Internet services through a connection.

Outputs

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

CreatedAt string
The creation time of the virtual interface
DeviceId string
The ID of the device that the virtual interface peer belongs to.
Id string
The provider-assigned unique ID for this managed resource.
Region string
The region where the virtual interface is located.
Status string
The status of the virtual interface peer.
UpdatedAt string
VifPeers List<DcVirtualInterfaceV3VifPeer>
The peer information of the virtual interface. The vif_peers structure is documented below.
CreatedAt string
The creation time of the virtual interface
DeviceId string
The ID of the device that the virtual interface peer belongs to.
Id string
The provider-assigned unique ID for this managed resource.
Region string
The region where the virtual interface is located.
Status string
The status of the virtual interface peer.
UpdatedAt string
VifPeers []DcVirtualInterfaceV3VifPeer
The peer information of the virtual interface. The vif_peers structure is documented below.
createdAt String
The creation time of the virtual interface
deviceId String
The ID of the device that the virtual interface peer belongs to.
id String
The provider-assigned unique ID for this managed resource.
region String
The region where the virtual interface is located.
status String
The status of the virtual interface peer.
updatedAt String
vifPeers List<DcVirtualInterfaceV3VifPeer>
The peer information of the virtual interface. The vif_peers structure is documented below.
createdAt string
The creation time of the virtual interface
deviceId string
The ID of the device that the virtual interface peer belongs to.
id string
The provider-assigned unique ID for this managed resource.
region string
The region where the virtual interface is located.
status string
The status of the virtual interface peer.
updatedAt string
vifPeers DcVirtualInterfaceV3VifPeer[]
The peer information of the virtual interface. The vif_peers structure is documented below.
created_at str
The creation time of the virtual interface
device_id str
The ID of the device that the virtual interface peer belongs to.
id str
The provider-assigned unique ID for this managed resource.
region str
The region where the virtual interface is located.
status str
The status of the virtual interface peer.
updated_at str
vif_peers Sequence[DcVirtualInterfaceV3VifPeer]
The peer information of the virtual interface. The vif_peers structure is documented below.
createdAt String
The creation time of the virtual interface
deviceId String
The ID of the device that the virtual interface peer belongs to.
id String
The provider-assigned unique ID for this managed resource.
region String
The region where the virtual interface is located.
status String
The status of the virtual interface peer.
updatedAt String
vifPeers List<Property Map>
The peer information of the virtual interface. The vif_peers structure is documented below.

Look up Existing DcVirtualInterfaceV3 Resource

Get an existing DcVirtualInterfaceV3 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?: DcVirtualInterfaceV3State, opts?: CustomResourceOptions): DcVirtualInterfaceV3
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_family: Optional[str] = None,
        asn: Optional[float] = None,
        bandwidth: Optional[float] = None,
        bgp_md5: Optional[str] = None,
        created_at: Optional[str] = None,
        dc_virtual_interface_v3_id: Optional[str] = None,
        description: Optional[str] = None,
        device_id: Optional[str] = None,
        direct_connect_id: Optional[str] = None,
        enable_bfd: Optional[bool] = None,
        enable_nqa: Optional[bool] = None,
        lag_id: Optional[str] = None,
        local_gateway_v4_ip: Optional[str] = None,
        local_gateway_v6_ip: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        remote_ep_groups: Optional[Sequence[str]] = None,
        remote_gateway_v4_ip: Optional[str] = None,
        remote_gateway_v6_ip: Optional[str] = None,
        resource_tenant_id: Optional[str] = None,
        route_mode: Optional[str] = None,
        service_ep_groups: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        vgw_id: Optional[str] = None,
        vif_peers: Optional[Sequence[DcVirtualInterfaceV3VifPeerArgs]] = None,
        vlan: Optional[float] = None) -> DcVirtualInterfaceV3
func GetDcVirtualInterfaceV3(ctx *Context, name string, id IDInput, state *DcVirtualInterfaceV3State, opts ...ResourceOption) (*DcVirtualInterfaceV3, error)
public static DcVirtualInterfaceV3 Get(string name, Input<string> id, DcVirtualInterfaceV3State? state, CustomResourceOptions? opts = null)
public static DcVirtualInterfaceV3 get(String name, Output<String> id, DcVirtualInterfaceV3State state, CustomResourceOptions options)
resources:  _:    type: opentelekomcloud:DcVirtualInterfaceV3    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AddressFamily string
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
Asn double
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
Bandwidth double
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
BgpMd5 string
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
CreatedAt string
The creation time of the virtual interface
DcVirtualInterfaceV3Id string
The VIF peer resource ID.
Description string
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
DeviceId string
The ID of the device that the virtual interface peer belongs to.
DirectConnectId string
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
EnableBfd bool
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
EnableNqa bool

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

LagId string
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
LocalGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
LocalGatewayV6Ip string
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
Name string
Specifies the name of the virtual interface.
Region string
The region where the virtual interface is located.
RemoteEpGroups List<string>
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
RemoteGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
RemoteGatewayV6Ip string

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

ResourceTenantId string
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
RouteMode string
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
ServiceEpGroups List<string>
Specifies the subnets that access Internet services through a connection.
Status string
The status of the virtual interface peer.
Type string
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
UpdatedAt string
VgwId string
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
VifPeers List<DcVirtualInterfaceV3VifPeer>
The peer information of the virtual interface. The vif_peers structure is documented below.
Vlan double
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.
AddressFamily string
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
Asn float64
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
Bandwidth float64
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
BgpMd5 string
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
CreatedAt string
The creation time of the virtual interface
DcVirtualInterfaceV3Id string
The VIF peer resource ID.
Description string
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
DeviceId string
The ID of the device that the virtual interface peer belongs to.
DirectConnectId string
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
EnableBfd bool
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
EnableNqa bool

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

LagId string
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
LocalGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
LocalGatewayV6Ip string
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
Name string
Specifies the name of the virtual interface.
Region string
The region where the virtual interface is located.
RemoteEpGroups []string
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
RemoteGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
RemoteGatewayV6Ip string

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

ResourceTenantId string
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
RouteMode string
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
ServiceEpGroups []string
Specifies the subnets that access Internet services through a connection.
Status string
The status of the virtual interface peer.
Type string
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
UpdatedAt string
VgwId string
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
VifPeers []DcVirtualInterfaceV3VifPeerArgs
The peer information of the virtual interface. The vif_peers structure is documented below.
Vlan float64
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.
addressFamily String
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
asn Double
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
bandwidth Double
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
bgpMd5 String
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
createdAt String
The creation time of the virtual interface
dcVirtualInterfaceV3Id String
The VIF peer resource ID.
description String
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
deviceId String
The ID of the device that the virtual interface peer belongs to.
directConnectId String
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
enableBfd Boolean
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enableNqa Boolean

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

lagId String
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
localGatewayV4Ip String
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
localGatewayV6Ip String
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
name String
Specifies the name of the virtual interface.
region String
The region where the virtual interface is located.
remoteEpGroups List<String>
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
remoteGatewayV4Ip String
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
remoteGatewayV6Ip String

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

resourceTenantId String
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
routeMode String
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
serviceEpGroups List<String>
Specifies the subnets that access Internet services through a connection.
status String
The status of the virtual interface peer.
type String
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
updatedAt String
vgwId String
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
vifPeers List<DcVirtualInterfaceV3VifPeer>
The peer information of the virtual interface. The vif_peers structure is documented below.
vlan Double
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.
addressFamily string
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
asn number
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
bandwidth number
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
bgpMd5 string
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
createdAt string
The creation time of the virtual interface
dcVirtualInterfaceV3Id string
The VIF peer resource ID.
description string
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
deviceId string
The ID of the device that the virtual interface peer belongs to.
directConnectId string
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
enableBfd boolean
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enableNqa boolean

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

lagId string
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
localGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
localGatewayV6Ip string
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
name string
Specifies the name of the virtual interface.
region string
The region where the virtual interface is located.
remoteEpGroups string[]
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
remoteGatewayV4Ip string
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
remoteGatewayV6Ip string

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

resourceTenantId string
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
routeMode string
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
serviceEpGroups string[]
Specifies the subnets that access Internet services through a connection.
status string
The status of the virtual interface peer.
type string
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
updatedAt string
vgwId string
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
vifPeers DcVirtualInterfaceV3VifPeer[]
The peer information of the virtual interface. The vif_peers structure is documented below.
vlan number
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.
address_family str
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
asn float
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
bandwidth float
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
bgp_md5 str
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
created_at str
The creation time of the virtual interface
dc_virtual_interface_v3_id str
The VIF peer resource ID.
description str
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
device_id str
The ID of the device that the virtual interface peer belongs to.
direct_connect_id str
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
enable_bfd bool
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enable_nqa bool

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

lag_id str
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
local_gateway_v4_ip str
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
local_gateway_v6_ip str
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
name str
Specifies the name of the virtual interface.
region str
The region where the virtual interface is located.
remote_ep_groups Sequence[str]
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
remote_gateway_v4_ip str
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
remote_gateway_v6_ip str

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

resource_tenant_id str
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
route_mode str
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
service_ep_groups Sequence[str]
Specifies the subnets that access Internet services through a connection.
status str
The status of the virtual interface peer.
type str
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
updated_at str
vgw_id str
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
vif_peers Sequence[DcVirtualInterfaceV3VifPeerArgs]
The peer information of the virtual interface. The vif_peers structure is documented below.
vlan float
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.
addressFamily String
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
asn Number
Specifies the local BGP ASN of the virtual interface. The valid value is range from 1 to 4,294,967,295, except 64,512. Changing this will create a new resource.
bandwidth Number
Specifies the bandwidth of the virtual interface. The unit is Mbit/s. The size range depends on the direct connection.
bgpMd5 String
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
createdAt String
The creation time of the virtual interface
dcVirtualInterfaceV3Id String
The VIF peer resource ID.
description String
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
deviceId String
The ID of the device that the virtual interface peer belongs to.
directConnectId String
Specifies the ID of the direct connection associated with the virtual interface. Changing this will create a new resource.
enableBfd Boolean
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enableNqa Boolean

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

lagId String
Specifies the ID of the link aggregation group (LAG) associated with the virtual interface. Changing this will create a new resource.
localGatewayV4Ip String
Specifies the IPv4 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
localGatewayV6Ip String
Specifies the IPv6 address of the virtual interface in cloud side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.
name String
Specifies the name of the virtual interface.
region String
The region where the virtual interface is located.
remoteEpGroups List<String>
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
remoteGatewayV4Ip String
Specifies the IPv4 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv4. Changing this will create a new resource.
remoteGatewayV6Ip String

Specifies the IPv6 address of the virtual interface in client side. This parameter is mandatory if address_family is set to ipv6. Changing this will create a new resource.

The CIDRs of local_gateway_v4_ip and remote_gateway_v4_ip (or local_gateway_v6_ip and remote_gateway_v6_ip) must be in the same subnet.

resourceTenantId String
Specifies the project ID of another tenant in the same region which is used to create virtual interface across tenant. After the across tenant virtual interface is successfully created, the target tenant needs to accept the virtual interface request for the virtual interface to take effect. Changing this will create a new resource.

  1. When resource_tenant_id is specified, vgw_id must be the target tenant virtual gateway id. 2. When resource_tenant_id is specified, the tags can only be configured after the target tenant accepts the virtual interface request and the virtual interface takes effect.
routeMode String
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
serviceEpGroups List<String>
Specifies the subnets that access Internet services through a connection.
status String
The status of the virtual interface peer.
type String
Specifies the type of the virtual interface. The valid value is private. Changing this will create a new resource.
updatedAt String
vgwId String
Specifies the ID of the virtual gateway to which the virtual interface is connected. Changing this will create a new resource.
vifPeers List<Property Map>
The peer information of the virtual interface. The vif_peers structure is documented below.
vlan Number
Specifies the customer VLAN to be connected. The valid value is range from 0 to 3,999. Changing this will create a new resource.

Supporting Types

DcVirtualInterfaceV3VifPeer
, DcVirtualInterfaceV3VifPeerArgs

AddressFamily This property is required. string
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
BgpAsn This property is required. double
The ASN of the BGP peer.
BgpMd5 This property is required. string
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
BgpRouteLimit This property is required. double
The BGP route configuration.
BgpStatus This property is required. string
The BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.
Description This property is required. string
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
DeviceId This property is required. string
The ID of the device that the virtual interface peer belongs to.
EnableBfd This property is required. bool
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
EnableNqa This property is required. bool

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

Id This property is required. string
The VIF peer resource ID.
LocalGatewayIp This property is required. string
The address of the virtual interface peer used on the cloud.
Name This property is required. string
Specifies the name of the virtual interface.
ReceiveRouteNum This property is required. double
The number of received BGP routes if bgp routing is used. If static routing is used, this parameter is meaningless and the value is -1.
RemoteEpGroups This property is required. List<string>
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
RemoteGatewayIp This property is required. string
The address of the virtual interface peer used in the on-premises data center.
RouteMode This property is required. string
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
ServiceEpGroups This property is required. List<string>
Specifies the subnets that access Internet services through a connection.
Status This property is required. string
The status of the virtual interface peer.
TenantId This property is required. string
VifId This property is required. string
The ID of the virtual interface corresponding to the virtual interface peer.
AddressFamily This property is required. string
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
BgpAsn This property is required. float64
The ASN of the BGP peer.
BgpMd5 This property is required. string
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
BgpRouteLimit This property is required. float64
The BGP route configuration.
BgpStatus This property is required. string
The BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.
Description This property is required. string
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
DeviceId This property is required. string
The ID of the device that the virtual interface peer belongs to.
EnableBfd This property is required. bool
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
EnableNqa This property is required. bool

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

Id This property is required. string
The VIF peer resource ID.
LocalGatewayIp This property is required. string
The address of the virtual interface peer used on the cloud.
Name This property is required. string
Specifies the name of the virtual interface.
ReceiveRouteNum This property is required. float64
The number of received BGP routes if bgp routing is used. If static routing is used, this parameter is meaningless and the value is -1.
RemoteEpGroups This property is required. []string
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
RemoteGatewayIp This property is required. string
The address of the virtual interface peer used in the on-premises data center.
RouteMode This property is required. string
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
ServiceEpGroups This property is required. []string
Specifies the subnets that access Internet services through a connection.
Status This property is required. string
The status of the virtual interface peer.
TenantId This property is required. string
VifId This property is required. string
The ID of the virtual interface corresponding to the virtual interface peer.
addressFamily This property is required. String
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
bgpAsn This property is required. Double
The ASN of the BGP peer.
bgpMd5 This property is required. String
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
bgpRouteLimit This property is required. Double
The BGP route configuration.
bgpStatus This property is required. String
The BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.
description This property is required. String
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
deviceId This property is required. String
The ID of the device that the virtual interface peer belongs to.
enableBfd This property is required. Boolean
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enableNqa This property is required. Boolean

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

id This property is required. String
The VIF peer resource ID.
localGatewayIp This property is required. String
The address of the virtual interface peer used on the cloud.
name This property is required. String
Specifies the name of the virtual interface.
receiveRouteNum This property is required. Double
The number of received BGP routes if bgp routing is used. If static routing is used, this parameter is meaningless and the value is -1.
remoteEpGroups This property is required. List<String>
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
remoteGatewayIp This property is required. String
The address of the virtual interface peer used in the on-premises data center.
routeMode This property is required. String
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
serviceEpGroups This property is required. List<String>
Specifies the subnets that access Internet services through a connection.
status This property is required. String
The status of the virtual interface peer.
tenantId This property is required. String
vifId This property is required. String
The ID of the virtual interface corresponding to the virtual interface peer.
addressFamily This property is required. string
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
bgpAsn This property is required. number
The ASN of the BGP peer.
bgpMd5 This property is required. string
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
bgpRouteLimit This property is required. number
The BGP route configuration.
bgpStatus This property is required. string
The BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.
description This property is required. string
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
deviceId This property is required. string
The ID of the device that the virtual interface peer belongs to.
enableBfd This property is required. boolean
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enableNqa This property is required. boolean

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

id This property is required. string
The VIF peer resource ID.
localGatewayIp This property is required. string
The address of the virtual interface peer used on the cloud.
name This property is required. string
Specifies the name of the virtual interface.
receiveRouteNum This property is required. number
The number of received BGP routes if bgp routing is used. If static routing is used, this parameter is meaningless and the value is -1.
remoteEpGroups This property is required. string[]
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
remoteGatewayIp This property is required. string
The address of the virtual interface peer used in the on-premises data center.
routeMode This property is required. string
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
serviceEpGroups This property is required. string[]
Specifies the subnets that access Internet services through a connection.
status This property is required. string
The status of the virtual interface peer.
tenantId This property is required. string
vifId This property is required. string
The ID of the virtual interface corresponding to the virtual interface peer.
address_family This property is required. str
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
bgp_asn This property is required. float
The ASN of the BGP peer.
bgp_md5 This property is required. str
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
bgp_route_limit This property is required. float
The BGP route configuration.
bgp_status This property is required. str
The BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.
description This property is required. str
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
device_id This property is required. str
The ID of the device that the virtual interface peer belongs to.
enable_bfd This property is required. bool
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enable_nqa This property is required. bool

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

id This property is required. str
The VIF peer resource ID.
local_gateway_ip This property is required. str
The address of the virtual interface peer used on the cloud.
name This property is required. str
Specifies the name of the virtual interface.
receive_route_num This property is required. float
The number of received BGP routes if bgp routing is used. If static routing is used, this parameter is meaningless and the value is -1.
remote_ep_groups This property is required. Sequence[str]
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
remote_gateway_ip This property is required. str
The address of the virtual interface peer used in the on-premises data center.
route_mode This property is required. str
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
service_ep_groups This property is required. Sequence[str]
Specifies the subnets that access Internet services through a connection.
status This property is required. str
The status of the virtual interface peer.
tenant_id This property is required. str
vif_id This property is required. str
The ID of the virtual interface corresponding to the virtual interface peer.
addressFamily This property is required. String
Specifies the service type of the virtual interface. The valid values are ipv4 and ipv6. Defaults to ipv4. Changing this will create a new resource.
bgpAsn This property is required. Number
The ASN of the BGP peer.
bgpMd5 This property is required. String
Specifies the (MD5) password for the local BGP. Changing this will create a new resource.
bgpRouteLimit This property is required. Number
The BGP route configuration.
bgpStatus This property is required. String
The BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null.
description This property is required. String
Specifies the description of the virtual interface. The description contain a maximum of 128 characters and the angle brackets (< and >) are not allowed. Chinese characters must be in UTF-8 or Unicode format.
deviceId This property is required. String
The ID of the device that the virtual interface peer belongs to.
enableBfd This property is required. Boolean
Specifies whether to enable the Bidirectional Forwarding Detection (BFD) function. Defaults to false. (This is a reserved parameter and is not supported currently.)
enableNqa This property is required. Boolean

Specifies whether to enable the Network Quality Analysis (NQA) function. Defaults to false. (This is a reserved parameter and is not supported currently.)

The values of parameter enable_bfd and enable_nqa cannot be true at the same time.

id This property is required. String
The VIF peer resource ID.
localGatewayIp This property is required. String
The address of the virtual interface peer used on the cloud.
name This property is required. String
Specifies the name of the virtual interface.
receiveRouteNum This property is required. Number
The number of received BGP routes if bgp routing is used. If static routing is used, this parameter is meaningless and the value is -1.
remoteEpGroups This property is required. List<String>
Specifies the CIDR list of remote subnets. A CIDR that contains CIDRs of local subnet (corresponding to the parameter local_gateway_v4_ip or local_gateway_v6_ip) and remote subnet (corresponding to the parameter remote_gateway_v4_ip or remote_gateway_v6_ip) must exist in the list.
remoteGatewayIp This property is required. String
The address of the virtual interface peer used in the on-premises data center.
routeMode This property is required. String
Specifies the route mode of the virtual interface. The valid values are static and bgp. Changing this will create a new resource.
serviceEpGroups This property is required. List<String>
Specifies the subnets that access Internet services through a connection.
status This property is required. String
The status of the virtual interface peer.
tenantId This property is required. String
vifId This property is required. String
The ID of the virtual interface corresponding to the virtual interface peer.

Import

Virtual interfaces can be imported using their id, e.g.

$ pulumi import opentelekomcloud:index/dcVirtualInterfaceV3:DcVirtualInterfaceV3 vi e41748a0-aed9-463e-9817-5c6162265d10
Copy

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

Package Details

Repository
opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
License
Notes
This Pulumi package is based on the opentelekomcloud Terraform Provider.
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud