vcd 3.14.1, Apr 14 25

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.NetworkRoutedV2

Explore with Pulumi AI

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

Create NetworkRoutedV2 Resource

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

new NetworkRoutedV2(name: string, args: NetworkRoutedV2Args, opts?: CustomResourceOptions);

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

@overload
def NetworkRoutedV2(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    edge_gateway_id: Optional[str] = None,
                    prefix_length: Optional[float] = None,
                    gateway: Optional[str] = None,
                    metadata_entries: Optional[Sequence[NetworkRoutedV2MetadataEntryArgs]] = None,
                    network_routed_v2_id: Optional[str] = None,
                    dns_suffix: Optional[str] = None,
                    dns2: Optional[str] = None,
                    guest_vlan_allowed: Optional[bool] = None,
                    interface_type: Optional[str] = None,
                    metadata: Optional[Mapping[str, str]] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    dual_stack_enabled: Optional[bool] = None,
                    org: Optional[str] = None,
                    dns1: Optional[str] = None,
                    route_advertisement_enabled: Optional[bool] = None,
                    secondary_gateway: Optional[str] = None,
                    secondary_prefix_length: Optional[str] = None,
                    secondary_static_ip_pools: Optional[Sequence[NetworkRoutedV2SecondaryStaticIpPoolArgs]] = None,
                    static_ip_pools: Optional[Sequence[NetworkRoutedV2StaticIpPoolArgs]] = None,
                    vdc: Optional[str] = None)

func NewNetworkRoutedV2(ctx *Context, name string, args NetworkRoutedV2Args, opts ...ResourceOption) (*NetworkRoutedV2, error)

public NetworkRoutedV2(string name, NetworkRoutedV2Args args, CustomResourceOptions? opts = null)

public NetworkRoutedV2(String name, NetworkRoutedV2Args args)
public NetworkRoutedV2(String name, NetworkRoutedV2Args args, CustomResourceOptions options)

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

Parameters

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

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

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

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

name String: The unique name of the resource.
args NetworkRoutedV2Args: 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.

TypeScript
Python
Go
C#
Java
YAML

var networkRoutedV2Resource = new Vcd.NetworkRoutedV2("networkRoutedV2Resource", new()
{
    EdgeGatewayId = "string",
    PrefixLength = 0,
    Gateway = "string",
    MetadataEntries = new[]
    {
        new Vcd.Inputs.NetworkRoutedV2MetadataEntryArgs
        {
            IsSystem = false,
            Key = "string",
            Type = "string",
            UserAccess = "string",
            Value = "string",
        },
    },
    NetworkRoutedV2Id = "string",
    DnsSuffix = "string",
    Dns2 = "string",
    GuestVlanAllowed = false,
    InterfaceType = "string",
    Description = "string",
    Name = "string",
    DualStackEnabled = false,
    Org = "string",
    Dns1 = "string",
    RouteAdvertisementEnabled = false,
    SecondaryGateway = "string",
    SecondaryPrefixLength = "string",
    SecondaryStaticIpPools = new[]
    {
        new Vcd.Inputs.NetworkRoutedV2SecondaryStaticIpPoolArgs
        {
            EndAddress = "string",
            StartAddress = "string",
        },
    },
    StaticIpPools = new[]
    {
        new Vcd.Inputs.NetworkRoutedV2StaticIpPoolArgs
        {
            EndAddress = "string",
            StartAddress = "string",
        },
    },
});

example, err := vcd.NewNetworkRoutedV2(ctx, "networkRoutedV2Resource", &vcd.NetworkRoutedV2Args{
EdgeGatewayId: pulumi.String("string"),
PrefixLength: pulumi.Float64(0),
Gateway: pulumi.String("string"),
MetadataEntries: .NetworkRoutedV2MetadataEntryArray{
&.NetworkRoutedV2MetadataEntryArgs{
IsSystem: pulumi.Bool(false),
Key: pulumi.String("string"),
Type: pulumi.String("string"),
UserAccess: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
NetworkRoutedV2Id: pulumi.String("string"),
DnsSuffix: pulumi.String("string"),
Dns2: pulumi.String("string"),
GuestVlanAllowed: pulumi.Bool(false),
InterfaceType: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
DualStackEnabled: pulumi.Bool(false),
Org: pulumi.String("string"),
Dns1: pulumi.String("string"),
RouteAdvertisementEnabled: pulumi.Bool(false),
SecondaryGateway: pulumi.String("string"),
SecondaryPrefixLength: pulumi.String("string"),
SecondaryStaticIpPools: .NetworkRoutedV2SecondaryStaticIpPoolArray{
&.NetworkRoutedV2SecondaryStaticIpPoolArgs{
EndAddress: pulumi.String("string"),
StartAddress: pulumi.String("string"),
},
},
StaticIpPools: .NetworkRoutedV2StaticIpPoolArray{
&.NetworkRoutedV2StaticIpPoolArgs{
EndAddress: pulumi.String("string"),
StartAddress: pulumi.String("string"),
},
},
})

var networkRoutedV2Resource = new NetworkRoutedV2("networkRoutedV2Resource", NetworkRoutedV2Args.builder()
    .edgeGatewayId("string")
    .prefixLength(0)
    .gateway("string")
    .metadataEntries(NetworkRoutedV2MetadataEntryArgs.builder()
        .isSystem(false)
        .key("string")
        .type("string")
        .userAccess("string")
        .value("string")
        .build())
    .networkRoutedV2Id("string")
    .dnsSuffix("string")
    .dns2("string")
    .guestVlanAllowed(false)
    .interfaceType("string")
    .description("string")
    .name("string")
    .dualStackEnabled(false)
    .org("string")
    .dns1("string")
    .routeAdvertisementEnabled(false)
    .secondaryGateway("string")
    .secondaryPrefixLength("string")
    .secondaryStaticIpPools(NetworkRoutedV2SecondaryStaticIpPoolArgs.builder()
        .endAddress("string")
        .startAddress("string")
        .build())
    .staticIpPools(NetworkRoutedV2StaticIpPoolArgs.builder()
        .endAddress("string")
        .startAddress("string")
        .build())
    .build());

network_routed_v2_resource = vcd.NetworkRoutedV2("networkRoutedV2Resource",
    edge_gateway_id="string",
    prefix_length=0,
    gateway="string",
    metadata_entries=[{
        "is_system": False,
        "key": "string",
        "type": "string",
        "user_access": "string",
        "value": "string",
    }],
    network_routed_v2_id="string",
    dns_suffix="string",
    dns2="string",
    guest_vlan_allowed=False,
    interface_type="string",
    description="string",
    name="string",
    dual_stack_enabled=False,
    org="string",
    dns1="string",
    route_advertisement_enabled=False,
    secondary_gateway="string",
    secondary_prefix_length="string",
    secondary_static_ip_pools=[{
        "end_address": "string",
        "start_address": "string",
    }],
    static_ip_pools=[{
        "end_address": "string",
        "start_address": "string",
    }])

const networkRoutedV2Resource = new vcd.NetworkRoutedV2("networkRoutedV2Resource", {
    edgeGatewayId: "string",
    prefixLength: 0,
    gateway: "string",
    metadataEntries: [{
        isSystem: false,
        key: "string",
        type: "string",
        userAccess: "string",
        value: "string",
    }],
    networkRoutedV2Id: "string",
    dnsSuffix: "string",
    dns2: "string",
    guestVlanAllowed: false,
    interfaceType: "string",
    description: "string",
    name: "string",
    dualStackEnabled: false,
    org: "string",
    dns1: "string",
    routeAdvertisementEnabled: false,
    secondaryGateway: "string",
    secondaryPrefixLength: "string",
    secondaryStaticIpPools: [{
        endAddress: "string",
        startAddress: "string",
    }],
    staticIpPools: [{
        endAddress: "string",
        startAddress: "string",
    }],
});

type: vcd:NetworkRoutedV2
properties:
    description: string
    dns1: string
    dns2: string
    dnsSuffix: string
    dualStackEnabled: false
    edgeGatewayId: string
    gateway: string
    guestVlanAllowed: false
    interfaceType: string
    metadataEntries:
        - isSystem: false
          key: string
          type: string
          userAccess: string
          value: string
    name: string
    networkRoutedV2Id: string
    org: string
    prefixLength: 0
    routeAdvertisementEnabled: false
    secondaryGateway: string
    secondaryPrefixLength: string
    secondaryStaticIpPools:
        - endAddress: string
          startAddress: string
    staticIpPools:
        - endAddress: string
          startAddress: string

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

EdgeGatewayId string

The ID of the Edge Gateway (NSX-V or NSX-T)

Gateway string

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

PrefixLength double

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

Description string

An optional description of the network

Dns1 string

First DNS server to use.

Dns2 string

Second DNS server to use.

DnsSuffix string

A FQDN for the virtual machines on this network

DualStackEnabled bool

Enables Dual-Stack mode so that one can configure one IPv4 and one IPv6 networks. Note In such case IPv4 addresses must be used in gateway, prefix_length and static_ip_pool while IPv6 addresses in secondary_gateway, secondary_prefix_length and secondary_static_ip_pool fields.

GuestVlanAllowed bool

Set to true if network should allow guest VLAN tagging. Default false.

InterfaceType string

An interface for the network. One of internal (default), subinterface, distributed, non_distributed (requires the Edge Gateway to support distributed networks). NSX-T supports only internal and non_distributed (v3.14+, requires Edge Gateway to have non-distributed routing enabled).

Metadata Dictionary<string, string>

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

MetadataEntries List<NetworkRoutedV2MetadataEntry>

A set of metadata entries to assign. See Metadata section for details.

Name string

A unique name for the network

NetworkRoutedV2Id string

Org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

RouteAdvertisementEnabled bool

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

SecondaryGateway string

IPv6 gateway when Dual-Stack mode is enabled

SecondaryPrefixLength string

IPv6 prefix length when Dual-Stack mode is enabled

SecondaryStaticIpPools List<NetworkRoutedV2SecondaryStaticIpPool>

One or more IPv6 static pools when Dual-Stack mode is enabled

StaticIpPools List<NetworkRoutedV2StaticIpPool>

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

Vdc string

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

EdgeGatewayId string

The ID of the Edge Gateway (NSX-V or NSX-T)

Gateway string

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

PrefixLength float64

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

Description string

An optional description of the network

Dns1 string

First DNS server to use.

Dns2 string

Second DNS server to use.

DnsSuffix string

A FQDN for the virtual machines on this network

DualStackEnabled bool

GuestVlanAllowed bool

Set to true if network should allow guest VLAN tagging. Default false.

InterfaceType string

Metadata map[string]string

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

MetadataEntries []NetworkRoutedV2MetadataEntryArgs

A set of metadata entries to assign. See Metadata section for details.

Name string

A unique name for the network

NetworkRoutedV2Id string

Org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

RouteAdvertisementEnabled bool

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

SecondaryGateway string

IPv6 gateway when Dual-Stack mode is enabled

SecondaryPrefixLength string

IPv6 prefix length when Dual-Stack mode is enabled

SecondaryStaticIpPools []NetworkRoutedV2SecondaryStaticIpPoolArgs

One or more IPv6 static pools when Dual-Stack mode is enabled

StaticIpPools []NetworkRoutedV2StaticIpPoolArgs

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

Vdc string

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

edgeGatewayId String

The ID of the Edge Gateway (NSX-V or NSX-T)

gateway String

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

prefixLength Double

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

description String

An optional description of the network

dns1 String

First DNS server to use.

dns2 String

Second DNS server to use.

dnsSuffix String

A FQDN for the virtual machines on this network

dualStackEnabled Boolean

guestVlanAllowed Boolean

Set to true if network should allow guest VLAN tagging. Default false.

interfaceType String

metadata Map<String,String>

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

metadataEntries List<NetworkRoutedV2MetadataEntry>

A set of metadata entries to assign. See Metadata section for details.

name String

A unique name for the network

networkRoutedV2Id String

org String

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

routeAdvertisementEnabled Boolean

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

secondaryGateway String

IPv6 gateway when Dual-Stack mode is enabled

secondaryPrefixLength String

IPv6 prefix length when Dual-Stack mode is enabled

secondaryStaticIpPools List<NetworkRoutedV2SecondaryStaticIpPool>

One or more IPv6 static pools when Dual-Stack mode is enabled

staticIpPools List<NetworkRoutedV2StaticIpPool>

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

vdc String

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

edgeGatewayId string

The ID of the Edge Gateway (NSX-V or NSX-T)

gateway string

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

prefixLength number

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

description string

An optional description of the network

dns1 string

First DNS server to use.

dns2 string

Second DNS server to use.

dnsSuffix string

A FQDN for the virtual machines on this network

dualStackEnabled boolean

guestVlanAllowed boolean

Set to true if network should allow guest VLAN tagging. Default false.

interfaceType string

metadata {[key: string]: string}

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

metadataEntries NetworkRoutedV2MetadataEntry[]

A set of metadata entries to assign. See Metadata section for details.

name string

A unique name for the network

networkRoutedV2Id string

org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

routeAdvertisementEnabled boolean

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

secondaryGateway string

IPv6 gateway when Dual-Stack mode is enabled

secondaryPrefixLength string

IPv6 prefix length when Dual-Stack mode is enabled

secondaryStaticIpPools NetworkRoutedV2SecondaryStaticIpPool[]

One or more IPv6 static pools when Dual-Stack mode is enabled

staticIpPools NetworkRoutedV2StaticIpPool[]

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

vdc string

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

edge_gateway_id str

The ID of the Edge Gateway (NSX-V or NSX-T)

gateway str

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

prefix_length float

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

description str

An optional description of the network

dns1 str

First DNS server to use.

dns2 str

Second DNS server to use.

dns_suffix str

A FQDN for the virtual machines on this network

dual_stack_enabled bool

guest_vlan_allowed bool

Set to true if network should allow guest VLAN tagging. Default false.

interface_type str

metadata Mapping[str, str]

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

metadata_entries Sequence[NetworkRoutedV2MetadataEntryArgs]

A set of metadata entries to assign. See Metadata section for details.

name str

A unique name for the network

network_routed_v2_id str

org str

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

route_advertisement_enabled bool

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

secondary_gateway str

IPv6 gateway when Dual-Stack mode is enabled

secondary_prefix_length str

IPv6 prefix length when Dual-Stack mode is enabled

secondary_static_ip_pools Sequence[NetworkRoutedV2SecondaryStaticIpPoolArgs]

One or more IPv6 static pools when Dual-Stack mode is enabled

static_ip_pools Sequence[NetworkRoutedV2StaticIpPoolArgs]

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

vdc str

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

edgeGatewayId String

The ID of the Edge Gateway (NSX-V or NSX-T)

gateway String

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

prefixLength Number

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

description String

An optional description of the network

dns1 String

First DNS server to use.

dns2 String

Second DNS server to use.

dnsSuffix String

A FQDN for the virtual machines on this network

dualStackEnabled Boolean

guestVlanAllowed Boolean

Set to true if network should allow guest VLAN tagging. Default false.

interfaceType String

metadata Map<String>

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

metadataEntries List<Property Map>

A set of metadata entries to assign. See Metadata section for details.

name String

A unique name for the network

networkRoutedV2Id String

org String

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

routeAdvertisementEnabled Boolean

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

secondaryGateway String

IPv6 gateway when Dual-Stack mode is enabled

secondaryPrefixLength String

IPv6 prefix length when Dual-Stack mode is enabled

secondaryStaticIpPools List<Property Map>

One or more IPv6 static pools when Dual-Stack mode is enabled

staticIpPools List<Property Map>

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

vdc String

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
OwnerId string: ID of VDC or VDC Group

Id string: The provider-assigned unique ID for this managed resource.
OwnerId string: ID of VDC or VDC Group

id String: The provider-assigned unique ID for this managed resource.
ownerId String: ID of VDC or VDC Group

id string: The provider-assigned unique ID for this managed resource.
ownerId string: ID of VDC or VDC Group

id str: The provider-assigned unique ID for this managed resource.
owner_id str: ID of VDC or VDC Group

id String: The provider-assigned unique ID for this managed resource.
ownerId String: ID of VDC or VDC Group

Look up Existing NetworkRoutedV2 Resource

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

TypeScript
Python
Go
C#
Java
YAML

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        dns1: Optional[str] = None,
        dns2: Optional[str] = None,
        dns_suffix: Optional[str] = None,
        dual_stack_enabled: Optional[bool] = None,
        edge_gateway_id: Optional[str] = None,
        gateway: Optional[str] = None,
        guest_vlan_allowed: Optional[bool] = None,
        interface_type: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        metadata_entries: Optional[Sequence[NetworkRoutedV2MetadataEntryArgs]] = None,
        name: Optional[str] = None,
        network_routed_v2_id: Optional[str] = None,
        org: Optional[str] = None,
        owner_id: Optional[str] = None,
        prefix_length: Optional[float] = None,
        route_advertisement_enabled: Optional[bool] = None,
        secondary_gateway: Optional[str] = None,
        secondary_prefix_length: Optional[str] = None,
        secondary_static_ip_pools: Optional[Sequence[NetworkRoutedV2SecondaryStaticIpPoolArgs]] = None,
        static_ip_pools: Optional[Sequence[NetworkRoutedV2StaticIpPoolArgs]] = None,
        vdc: Optional[str] = None) -> NetworkRoutedV2

func GetNetworkRoutedV2(ctx *Context, name string, id IDInput, state *NetworkRoutedV2State, opts ...ResourceOption) (*NetworkRoutedV2, error)

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

public static NetworkRoutedV2 get(String name, Output<String> id, NetworkRoutedV2State state, CustomResourceOptions options)

resources:  _:    type: vcd:NetworkRoutedV2    get:      id: ${id}

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

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

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

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

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

The following state arguments are supported:

Description string

An optional description of the network

Dns1 string

First DNS server to use.

Dns2 string

Second DNS server to use.

DnsSuffix string

A FQDN for the virtual machines on this network

DualStackEnabled bool

EdgeGatewayId string

The ID of the Edge Gateway (NSX-V or NSX-T)

Gateway string

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

GuestVlanAllowed bool

Set to true if network should allow guest VLAN tagging. Default false.

InterfaceType string

Metadata Dictionary<string, string>

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

MetadataEntries List<NetworkRoutedV2MetadataEntry>

A set of metadata entries to assign. See Metadata section for details.

Name string

A unique name for the network

NetworkRoutedV2Id string

Org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

OwnerId string

ID of VDC or VDC Group

PrefixLength double

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

RouteAdvertisementEnabled bool

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

SecondaryGateway string

IPv6 gateway when Dual-Stack mode is enabled

SecondaryPrefixLength string

IPv6 prefix length when Dual-Stack mode is enabled

SecondaryStaticIpPools List<NetworkRoutedV2SecondaryStaticIpPool>

One or more IPv6 static pools when Dual-Stack mode is enabled

StaticIpPools List<NetworkRoutedV2StaticIpPool>

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

Vdc string

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

Description string

An optional description of the network

Dns1 string

First DNS server to use.

Dns2 string

Second DNS server to use.

DnsSuffix string

A FQDN for the virtual machines on this network

DualStackEnabled bool

EdgeGatewayId string

The ID of the Edge Gateway (NSX-V or NSX-T)

Gateway string

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

GuestVlanAllowed bool

Set to true if network should allow guest VLAN tagging. Default false.

InterfaceType string

Metadata map[string]string

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

MetadataEntries []NetworkRoutedV2MetadataEntryArgs

A set of metadata entries to assign. See Metadata section for details.

Name string

A unique name for the network

NetworkRoutedV2Id string

Org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

OwnerId string

ID of VDC or VDC Group

PrefixLength float64

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

RouteAdvertisementEnabled bool

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

SecondaryGateway string

IPv6 gateway when Dual-Stack mode is enabled

SecondaryPrefixLength string

IPv6 prefix length when Dual-Stack mode is enabled

SecondaryStaticIpPools []NetworkRoutedV2SecondaryStaticIpPoolArgs

One or more IPv6 static pools when Dual-Stack mode is enabled

StaticIpPools []NetworkRoutedV2StaticIpPoolArgs

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

Vdc string

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

description String

An optional description of the network

dns1 String

First DNS server to use.

dns2 String

Second DNS server to use.

dnsSuffix String

A FQDN for the virtual machines on this network

dualStackEnabled Boolean

edgeGatewayId String

The ID of the Edge Gateway (NSX-V or NSX-T)

gateway String

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

guestVlanAllowed Boolean

Set to true if network should allow guest VLAN tagging. Default false.

interfaceType String

metadata Map<String,String>

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

metadataEntries List<NetworkRoutedV2MetadataEntry>

A set of metadata entries to assign. See Metadata section for details.

name String

A unique name for the network

networkRoutedV2Id String

org String

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

ownerId String

ID of VDC or VDC Group

prefixLength Double

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

routeAdvertisementEnabled Boolean

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

secondaryGateway String

IPv6 gateway when Dual-Stack mode is enabled

secondaryPrefixLength String

IPv6 prefix length when Dual-Stack mode is enabled

secondaryStaticIpPools List<NetworkRoutedV2SecondaryStaticIpPool>

One or more IPv6 static pools when Dual-Stack mode is enabled

staticIpPools List<NetworkRoutedV2StaticIpPool>

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

vdc String

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

description string

An optional description of the network

dns1 string

First DNS server to use.

dns2 string

Second DNS server to use.

dnsSuffix string

A FQDN for the virtual machines on this network

dualStackEnabled boolean

edgeGatewayId string

The ID of the Edge Gateway (NSX-V or NSX-T)

gateway string

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

guestVlanAllowed boolean

Set to true if network should allow guest VLAN tagging. Default false.

interfaceType string

metadata {[key: string]: string}

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

metadataEntries NetworkRoutedV2MetadataEntry[]

A set of metadata entries to assign. See Metadata section for details.

name string

A unique name for the network

networkRoutedV2Id string

org string

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

ownerId string

ID of VDC or VDC Group

prefixLength number

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

routeAdvertisementEnabled boolean

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

secondaryGateway string

IPv6 gateway when Dual-Stack mode is enabled

secondaryPrefixLength string

IPv6 prefix length when Dual-Stack mode is enabled

secondaryStaticIpPools NetworkRoutedV2SecondaryStaticIpPool[]

One or more IPv6 static pools when Dual-Stack mode is enabled

staticIpPools NetworkRoutedV2StaticIpPool[]

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

vdc string

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

description str

An optional description of the network

dns1 str

First DNS server to use.

dns2 str

Second DNS server to use.

dns_suffix str

A FQDN for the virtual machines on this network

dual_stack_enabled bool

edge_gateway_id str

The ID of the Edge Gateway (NSX-V or NSX-T)

gateway str

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

guest_vlan_allowed bool

Set to true if network should allow guest VLAN tagging. Default false.

interface_type str

metadata Mapping[str, str]

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

metadata_entries Sequence[NetworkRoutedV2MetadataEntryArgs]

A set of metadata entries to assign. See Metadata section for details.

name str

A unique name for the network

network_routed_v2_id str

org str

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

owner_id str

ID of VDC or VDC Group

prefix_length float

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

route_advertisement_enabled bool

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

secondary_gateway str

IPv6 gateway when Dual-Stack mode is enabled

secondary_prefix_length str

IPv6 prefix length when Dual-Stack mode is enabled

secondary_static_ip_pools Sequence[NetworkRoutedV2SecondaryStaticIpPoolArgs]

One or more IPv6 static pools when Dual-Stack mode is enabled

static_ip_pools Sequence[NetworkRoutedV2StaticIpPoolArgs]

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

vdc str

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

description String

An optional description of the network

dns1 String

First DNS server to use.

dns2 String

Second DNS server to use.

dnsSuffix String

A FQDN for the virtual machines on this network

dualStackEnabled Boolean

edgeGatewayId String

The ID of the Edge Gateway (NSX-V or NSX-T)

gateway String

The gateway for this network (e.g. 192.168.1.1, 2002:0:0:1234:abcd:ffff:c0a7:121)

guestVlanAllowed Boolean

Set to true if network should allow guest VLAN tagging. Default false.

interfaceType String

metadata Map<String>

Use metadata_entry instead. Key value map of metadata to assign to this network. Not supported if the owner edge gateway belongs to a VDC Group.

Deprecated: Deprecated

metadataEntries List<Property Map>

A set of metadata entries to assign. See Metadata section for details.

name String

A unique name for the network

networkRoutedV2Id String

org String

The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations

ownerId String

ID of VDC or VDC Group

prefixLength Number

The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).

routeAdvertisementEnabled Boolean

Enables route advertising for this network. Note This requires Edge Gateway to use IP Spaces and IP Space must have route advertisement enabled.

secondaryGateway String

IPv6 gateway when Dual-Stack mode is enabled

secondaryPrefixLength String

IPv6 prefix length when Dual-Stack mode is enabled

secondaryStaticIpPools List<Property Map>

One or more IPv6 static pools when Dual-Stack mode is enabled

staticIpPools List<Property Map>

A range of IPs permitted to be used as static IPs for virtual machines; see IP Pools below for details.

vdc String

The name of VDC to use. v3.6+ inherits parent VDC or VDC Group from edge_gateway_id)

Deprecated: Deprecated

Supporting Types

NetworkRoutedV2MetadataEntry
, NetworkRoutedV2MetadataEntryArgs

IsSystem bool: Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
Key string: Key of this metadata entry. Required if the metadata entry is not empty
Type string: Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
UserAccess string: User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
Value string: Value of this metadata entry. Required if the metadata entry is not empty

IsSystem bool: Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
Key string: Key of this metadata entry. Required if the metadata entry is not empty
Type string: Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
UserAccess string: User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
Value string: Value of this metadata entry. Required if the metadata entry is not empty

isSystem Boolean: Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
key String: Key of this metadata entry. Required if the metadata entry is not empty
type String: Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
userAccess String: User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
value String: Value of this metadata entry. Required if the metadata entry is not empty

isSystem boolean: Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
key string: Key of this metadata entry. Required if the metadata entry is not empty
type string: Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
userAccess string: User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
value string: Value of this metadata entry. Required if the metadata entry is not empty

is_system bool: Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
key str: Key of this metadata entry. Required if the metadata entry is not empty
type str: Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
user_access str: User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
value str: Value of this metadata entry. Required if the metadata entry is not empty

isSystem Boolean: Domain for this metadata entry. true, if it belongs to SYSTEM. false, if it belongs to GENERAL
key String: Key of this metadata entry. Required if the metadata entry is not empty
type String: Type of this metadata entry. One of: 'MetadataStringValue', 'MetadataNumberValue', 'MetadataBooleanValue', 'MetadataDateTimeValue'
userAccess String: User access level for this metadata entry. One of: 'READWRITE', 'READONLY', 'PRIVATE'
value String: Value of this metadata entry. Required if the metadata entry is not empty

NetworkRoutedV2SecondaryStaticIpPool
, NetworkRoutedV2SecondaryStaticIpPoolArgs

EndAddress string: End address of the IP range
StartAddress string: Start address of the IP range

EndAddress string: End address of the IP range
StartAddress string: Start address of the IP range

endAddress String: End address of the IP range
startAddress String: Start address of the IP range

endAddress string: End address of the IP range
startAddress string: Start address of the IP range

end_address str: End address of the IP range
start_address str: Start address of the IP range

endAddress String: End address of the IP range
startAddress String: Start address of the IP range

NetworkRoutedV2StaticIpPool
, NetworkRoutedV2StaticIpPoolArgs

EndAddress string: End address of the IP range
StartAddress string: Start address of the IP range

EndAddress string: End address of the IP range
StartAddress string: Start address of the IP range

endAddress String: End address of the IP range
startAddress String: Start address of the IP range

endAddress string: End address of the IP range
startAddress string: Start address of the IP range

end_address str: End address of the IP range
start_address str: Start address of the IP range

endAddress String: End address of the IP range
startAddress String: Start address of the IP range

Package Details

Repository: vcd vmware/terraform-provider-vcd
License
Notes: This Pulumi package is based on the vcd Terraform Provider.

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vmware/terraform-provider-vcd

vcd.NetworkRoutedV2

On this page

On this page

Create NetworkRoutedV2 Resource

Constructor syntax

Parameters

Constructor example

NetworkRoutedV2 Resource Properties

Inputs

Outputs

Look up Existing NetworkRoutedV2 Resource

Supporting Types

NetworkRoutedV2MetadataEntry
, NetworkRoutedV2MetadataEntryArgs

NetworkRoutedV2SecondaryStaticIpPool
, NetworkRoutedV2SecondaryStaticIpPoolArgs

NetworkRoutedV2StaticIpPool
, NetworkRoutedV2StaticIpPoolArgs

Package Details

On this page

On this page

vcd.NetworkRoutedV2

On this page

On this page

Create NetworkRoutedV2 Resource

Constructor syntax

Parameters

Constructor example

NetworkRoutedV2 Resource Properties

Inputs

Outputs

Look up Existing NetworkRoutedV2 Resource

Supporting Types

NetworkRoutedV2MetadataEntry, NetworkRoutedV2MetadataEntryArgs

NetworkRoutedV2SecondaryStaticIpPool, NetworkRoutedV2SecondaryStaticIpPoolArgs

NetworkRoutedV2StaticIpPool, NetworkRoutedV2StaticIpPoolArgs

Package Details

On this page

On this page

NetworkRoutedV2MetadataEntry
, NetworkRoutedV2MetadataEntryArgs

NetworkRoutedV2SecondaryStaticIpPool
, NetworkRoutedV2SecondaryStaticIpPoolArgs

NetworkRoutedV2StaticIpPool
, NetworkRoutedV2StaticIpPoolArgs