Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. NetworkRouted
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.NetworkRouted

Explore with Pulumi AI

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

Create NetworkRouted Resource

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

Constructor syntax

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

@overload
def NetworkRouted(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  edge_gateway: Optional[str] = None,
                  metadata: Optional[Mapping[str, str]] = None,
                  name: Optional[str] = None,
                  dns2: Optional[str] = None,
                  dns_suffix: Optional[str] = None,
                  dhcp_pools: Optional[Sequence[NetworkRoutedDhcpPoolArgs]] = None,
                  gateway: Optional[str] = None,
                  dns1: Optional[str] = None,
                  interface_type: Optional[str] = None,
                  metadata_entries: Optional[Sequence[NetworkRoutedMetadataEntryArgs]] = None,
                  description: Optional[str] = None,
                  netmask: Optional[str] = None,
                  network_routed_id: Optional[str] = None,
                  org: Optional[str] = None,
                  shared: Optional[bool] = None,
                  static_ip_pools: Optional[Sequence[NetworkRoutedStaticIpPoolArgs]] = None,
                  vdc: Optional[str] = None)
func NewNetworkRouted(ctx *Context, name string, args NetworkRoutedArgs, opts ...ResourceOption) (*NetworkRouted, error)
public NetworkRouted(string name, NetworkRoutedArgs args, CustomResourceOptions? opts = null)
public NetworkRouted(String name, NetworkRoutedArgs args)
public NetworkRouted(String name, NetworkRoutedArgs args, CustomResourceOptions options)

type: vcd:NetworkRouted
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. NetworkRoutedArgs
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. NetworkRoutedArgs
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. NetworkRoutedArgs
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. NetworkRoutedArgs
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. NetworkRoutedArgs
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 networkRoutedResource = new Vcd.NetworkRouted("networkRoutedResource", new()
{
    EdgeGateway = "string",
    Name = "string",
    Dns2 = "string",
    DnsSuffix = "string",
    DhcpPools = new[]
    {
        new Vcd.Inputs.NetworkRoutedDhcpPoolArgs
        {
            EndAddress = "string",
            StartAddress = "string",
            DefaultLeaseTime = 0,
            MaxLeaseTime = 0,
        },
    },
    Gateway = "string",
    Dns1 = "string",
    InterfaceType = "string",
    MetadataEntries = new[]
    {
        new Vcd.Inputs.NetworkRoutedMetadataEntryArgs
        {
            IsSystem = false,
            Key = "string",
            Type = "string",
            UserAccess = "string",
            Value = "string",
        },
    },
    Description = "string",
    Netmask = "string",
    NetworkRoutedId = "string",
    Org = "string",
    Shared = false,
    StaticIpPools = new[]
    {
        new Vcd.Inputs.NetworkRoutedStaticIpPoolArgs
        {
            EndAddress = "string",
            StartAddress = "string",
        },
    },
    Vdc = "string",
});
Copy
example, err := vcd.NewNetworkRouted(ctx, "networkRoutedResource", &vcd.NetworkRoutedArgs{
EdgeGateway: pulumi.String("string"),
Name: pulumi.String("string"),
Dns2: pulumi.String("string"),
DnsSuffix: pulumi.String("string"),
DhcpPools: .NetworkRoutedDhcpPoolArray{
&.NetworkRoutedDhcpPoolArgs{
EndAddress: pulumi.String("string"),
StartAddress: pulumi.String("string"),
DefaultLeaseTime: pulumi.Float64(0),
MaxLeaseTime: pulumi.Float64(0),
},
},
Gateway: pulumi.String("string"),
Dns1: pulumi.String("string"),
InterfaceType: pulumi.String("string"),
MetadataEntries: .NetworkRoutedMetadataEntryArray{
&.NetworkRoutedMetadataEntryArgs{
IsSystem: pulumi.Bool(false),
Key: pulumi.String("string"),
Type: pulumi.String("string"),
UserAccess: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
Netmask: pulumi.String("string"),
NetworkRoutedId: pulumi.String("string"),
Org: pulumi.String("string"),
Shared: pulumi.Bool(false),
StaticIpPools: .NetworkRoutedStaticIpPoolArray{
&.NetworkRoutedStaticIpPoolArgs{
EndAddress: pulumi.String("string"),
StartAddress: pulumi.String("string"),
},
},
Vdc: pulumi.String("string"),
})
Copy
var networkRoutedResource = new NetworkRouted("networkRoutedResource", NetworkRoutedArgs.builder()
    .edgeGateway("string")
    .name("string")
    .dns2("string")
    .dnsSuffix("string")
    .dhcpPools(NetworkRoutedDhcpPoolArgs.builder()
        .endAddress("string")
        .startAddress("string")
        .defaultLeaseTime(0)
        .maxLeaseTime(0)
        .build())
    .gateway("string")
    .dns1("string")
    .interfaceType("string")
    .metadataEntries(NetworkRoutedMetadataEntryArgs.builder()
        .isSystem(false)
        .key("string")
        .type("string")
        .userAccess("string")
        .value("string")
        .build())
    .description("string")
    .netmask("string")
    .networkRoutedId("string")
    .org("string")
    .shared(false)
    .staticIpPools(NetworkRoutedStaticIpPoolArgs.builder()
        .endAddress("string")
        .startAddress("string")
        .build())
    .vdc("string")
    .build());
Copy
network_routed_resource = vcd.NetworkRouted("networkRoutedResource",
    edge_gateway="string",
    name="string",
    dns2="string",
    dns_suffix="string",
    dhcp_pools=[{
        "end_address": "string",
        "start_address": "string",
        "default_lease_time": 0,
        "max_lease_time": 0,
    }],
    gateway="string",
    dns1="string",
    interface_type="string",
    metadata_entries=[{
        "is_system": False,
        "key": "string",
        "type": "string",
        "user_access": "string",
        "value": "string",
    }],
    description="string",
    netmask="string",
    network_routed_id="string",
    org="string",
    shared=False,
    static_ip_pools=[{
        "end_address": "string",
        "start_address": "string",
    }],
    vdc="string")
Copy
const networkRoutedResource = new vcd.NetworkRouted("networkRoutedResource", {
    edgeGateway: "string",
    name: "string",
    dns2: "string",
    dnsSuffix: "string",
    dhcpPools: [{
        endAddress: "string",
        startAddress: "string",
        defaultLeaseTime: 0,
        maxLeaseTime: 0,
    }],
    gateway: "string",
    dns1: "string",
    interfaceType: "string",
    metadataEntries: [{
        isSystem: false,
        key: "string",
        type: "string",
        userAccess: "string",
        value: "string",
    }],
    description: "string",
    netmask: "string",
    networkRoutedId: "string",
    org: "string",
    shared: false,
    staticIpPools: [{
        endAddress: "string",
        startAddress: "string",
    }],
    vdc: "string",
});
Copy
type: vcd:NetworkRouted
properties:
    description: string
    dhcpPools:
        - defaultLeaseTime: 0
          endAddress: string
          maxLeaseTime: 0
          startAddress: string
    dns1: string
    dns2: string
    dnsSuffix: string
    edgeGateway: string
    gateway: string
    interfaceType: string
    metadataEntries:
        - isSystem: false
          key: string
          type: string
          userAccess: string
          value: string
    name: string
    netmask: string
    networkRoutedId: string
    org: string
    shared: false
    staticIpPools:
        - endAddress: string
          startAddress: string
    vdc: string
Copy

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

EdgeGateway This property is required. string
The name of the edge gateway
Description string
An optional description of the network
DhcpPools List<NetworkRoutedDhcpPool>
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
Gateway string
The gateway for this network
InterfaceType string
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
Metadata Dictionary<string, string>
Use metadata_entry instead. Key value map of metadata to assign to this network.

Deprecated: Deprecated

MetadataEntries List<NetworkRoutedMetadataEntry>

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

Name string
A unique name for the network
Netmask string
The netmask for the new network. Defaults to 255.255.255.0
NetworkRoutedId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
Shared bool
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
StaticIpPools List<NetworkRoutedStaticIpPool>
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, optional if defined at provider level
EdgeGateway This property is required. string
The name of the edge gateway
Description string
An optional description of the network
DhcpPools []NetworkRoutedDhcpPoolArgs
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
Gateway string
The gateway for this network
InterfaceType string
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
Metadata map[string]string
Use metadata_entry instead. Key value map of metadata to assign to this network.

Deprecated: Deprecated

MetadataEntries []NetworkRoutedMetadataEntryArgs

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

Name string
A unique name for the network
Netmask string
The netmask for the new network. Defaults to 255.255.255.0
NetworkRoutedId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
Shared bool
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
StaticIpPools []NetworkRoutedStaticIpPoolArgs
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, optional if defined at provider level
edgeGateway This property is required. String
The name of the edge gateway
description String
An optional description of the network
dhcpPools List<NetworkRoutedDhcpPool>
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
gateway String
The gateway for this network
interfaceType String
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
metadata Map<String,String>
Use metadata_entry instead. Key value map of metadata to assign to this network.

Deprecated: Deprecated

metadataEntries List<NetworkRoutedMetadataEntry>

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

name String
A unique name for the network
netmask String
The netmask for the new network. Defaults to 255.255.255.0
networkRoutedId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
shared Boolean
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
staticIpPools List<NetworkRoutedStaticIpPool>
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, optional if defined at provider level
edgeGateway This property is required. string
The name of the edge gateway
description string
An optional description of the network
dhcpPools NetworkRoutedDhcpPool[]
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
gateway string
The gateway for this network
interfaceType string
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
metadata {[key: string]: string}
Use metadata_entry instead. Key value map of metadata to assign to this network.

Deprecated: Deprecated

metadataEntries NetworkRoutedMetadataEntry[]

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

name string
A unique name for the network
netmask string
The netmask for the new network. Defaults to 255.255.255.0
networkRoutedId string
org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
shared boolean
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
staticIpPools NetworkRoutedStaticIpPool[]
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, optional if defined at provider level
edge_gateway This property is required. str
The name of the edge gateway
description str
An optional description of the network
dhcp_pools Sequence[NetworkRoutedDhcpPoolArgs]
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
gateway str
The gateway for this network
interface_type str
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
metadata Mapping[str, str]
Use metadata_entry instead. Key value map of metadata to assign to this network.

Deprecated: Deprecated

metadata_entries Sequence[NetworkRoutedMetadataEntryArgs]

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

name str
A unique name for the network
netmask str
The netmask for the new network. Defaults to 255.255.255.0
network_routed_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
shared bool
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
static_ip_pools Sequence[NetworkRoutedStaticIpPoolArgs]
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, optional if defined at provider level
edgeGateway This property is required. String
The name of the edge gateway
description String
An optional description of the network
dhcpPools List<Property Map>
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
gateway String
The gateway for this network
interfaceType String
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
metadata Map<String>
Use metadata_entry instead. Key value map of metadata to assign to this network.

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
netmask String
The netmask for the new network. Defaults to 255.255.255.0
networkRoutedId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
shared Boolean
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
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, optional if defined at provider level

Outputs

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

Href string
Network Hypertext Reference
Id string
The provider-assigned unique ID for this managed resource.
Href string
Network Hypertext Reference
Id string
The provider-assigned unique ID for this managed resource.
href String
Network Hypertext Reference
id String
The provider-assigned unique ID for this managed resource.
href string
Network Hypertext Reference
id string
The provider-assigned unique ID for this managed resource.
href str
Network Hypertext Reference
id str
The provider-assigned unique ID for this managed resource.
href String
Network Hypertext Reference
id String
The provider-assigned unique ID for this managed resource.

Look up Existing NetworkRouted Resource

Get an existing NetworkRouted 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?: NetworkRoutedState, opts?: CustomResourceOptions): NetworkRouted
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        dhcp_pools: Optional[Sequence[NetworkRoutedDhcpPoolArgs]] = None,
        dns1: Optional[str] = None,
        dns2: Optional[str] = None,
        dns_suffix: Optional[str] = None,
        edge_gateway: Optional[str] = None,
        gateway: Optional[str] = None,
        href: Optional[str] = None,
        interface_type: Optional[str] = None,
        metadata: Optional[Mapping[str, str]] = None,
        metadata_entries: Optional[Sequence[NetworkRoutedMetadataEntryArgs]] = None,
        name: Optional[str] = None,
        netmask: Optional[str] = None,
        network_routed_id: Optional[str] = None,
        org: Optional[str] = None,
        shared: Optional[bool] = None,
        static_ip_pools: Optional[Sequence[NetworkRoutedStaticIpPoolArgs]] = None,
        vdc: Optional[str] = None) -> NetworkRouted
func GetNetworkRouted(ctx *Context, name string, id IDInput, state *NetworkRoutedState, opts ...ResourceOption) (*NetworkRouted, error)
public static NetworkRouted Get(string name, Input<string> id, NetworkRoutedState? state, CustomResourceOptions? opts = null)
public static NetworkRouted get(String name, Output<String> id, NetworkRoutedState state, CustomResourceOptions options)
resources:  _:    type: vcd:NetworkRouted    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:
Description string
An optional description of the network
DhcpPools List<NetworkRoutedDhcpPool>
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
EdgeGateway string
The name of the edge gateway
Gateway string
The gateway for this network
Href string
Network Hypertext Reference
InterfaceType string
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
Metadata Dictionary<string, string>
Use metadata_entry instead. Key value map of metadata to assign to this network.

Deprecated: Deprecated

MetadataEntries List<NetworkRoutedMetadataEntry>

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

Name string
A unique name for the network
Netmask string
The netmask for the new network. Defaults to 255.255.255.0
NetworkRoutedId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
Shared bool
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
StaticIpPools List<NetworkRoutedStaticIpPool>
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, optional if defined at provider level
Description string
An optional description of the network
DhcpPools []NetworkRoutedDhcpPoolArgs
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
EdgeGateway string
The name of the edge gateway
Gateway string
The gateway for this network
Href string
Network Hypertext Reference
InterfaceType string
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
Metadata map[string]string
Use metadata_entry instead. Key value map of metadata to assign to this network.

Deprecated: Deprecated

MetadataEntries []NetworkRoutedMetadataEntryArgs

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

Name string
A unique name for the network
Netmask string
The netmask for the new network. Defaults to 255.255.255.0
NetworkRoutedId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
Shared bool
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
StaticIpPools []NetworkRoutedStaticIpPoolArgs
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, optional if defined at provider level
description String
An optional description of the network
dhcpPools List<NetworkRoutedDhcpPool>
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
edgeGateway String
The name of the edge gateway
gateway String
The gateway for this network
href String
Network Hypertext Reference
interfaceType String
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
metadata Map<String,String>
Use metadata_entry instead. Key value map of metadata to assign to this network.

Deprecated: Deprecated

metadataEntries List<NetworkRoutedMetadataEntry>

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

name String
A unique name for the network
netmask String
The netmask for the new network. Defaults to 255.255.255.0
networkRoutedId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
shared Boolean
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
staticIpPools List<NetworkRoutedStaticIpPool>
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, optional if defined at provider level
description string
An optional description of the network
dhcpPools NetworkRoutedDhcpPool[]
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
edgeGateway string
The name of the edge gateway
gateway string
The gateway for this network
href string
Network Hypertext Reference
interfaceType string
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
metadata {[key: string]: string}
Use metadata_entry instead. Key value map of metadata to assign to this network.

Deprecated: Deprecated

metadataEntries NetworkRoutedMetadataEntry[]

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

name string
A unique name for the network
netmask string
The netmask for the new network. Defaults to 255.255.255.0
networkRoutedId string
org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
shared boolean
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
staticIpPools NetworkRoutedStaticIpPool[]
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, optional if defined at provider level
description str
An optional description of the network
dhcp_pools Sequence[NetworkRoutedDhcpPoolArgs]
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
edge_gateway str
The name of the edge gateway
gateway str
The gateway for this network
href str
Network Hypertext Reference
interface_type str
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
metadata Mapping[str, str]
Use metadata_entry instead. Key value map of metadata to assign to this network.

Deprecated: Deprecated

metadata_entries Sequence[NetworkRoutedMetadataEntryArgs]

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

name str
A unique name for the network
netmask str
The netmask for the new network. Defaults to 255.255.255.0
network_routed_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
shared bool
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
static_ip_pools Sequence[NetworkRoutedStaticIpPoolArgs]
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, optional if defined at provider level
description String
An optional description of the network
dhcpPools List<Property Map>
A range of IPs to issue to virtual machines that don't have a static IP; see IP Pools below for details.
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
edgeGateway String
The name of the edge gateway
gateway String
The gateway for this network
href String
Network Hypertext Reference
interfaceType String
An interface for the network. One of internal (default), subinterface, distributed (requires the edge gateway to support distributed networks)
metadata Map<String>
Use metadata_entry instead. Key value map of metadata to assign to this network.

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
netmask String
The netmask for the new network. Defaults to 255.255.255.0
networkRoutedId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
shared Boolean
Defines if this network is shared between multiple VDCs in the Org. Defaults to false.
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, optional if defined at provider level

Supporting Types

NetworkRoutedDhcpPool
, NetworkRoutedDhcpPoolArgs

EndAddress This property is required. string
The final address in the IP Range
StartAddress This property is required. string
The first address in the IP Range
DefaultLeaseTime double
The default DHCP lease time to use
MaxLeaseTime double
The maximum DHCP lease time to use
EndAddress This property is required. string
The final address in the IP Range
StartAddress This property is required. string
The first address in the IP Range
DefaultLeaseTime float64
The default DHCP lease time to use
MaxLeaseTime float64
The maximum DHCP lease time to use
endAddress This property is required. String
The final address in the IP Range
startAddress This property is required. String
The first address in the IP Range
defaultLeaseTime Double
The default DHCP lease time to use
maxLeaseTime Double
The maximum DHCP lease time to use
endAddress This property is required. string
The final address in the IP Range
startAddress This property is required. string
The first address in the IP Range
defaultLeaseTime number
The default DHCP lease time to use
maxLeaseTime number
The maximum DHCP lease time to use
end_address This property is required. str
The final address in the IP Range
start_address This property is required. str
The first address in the IP Range
default_lease_time float
The default DHCP lease time to use
max_lease_time float
The maximum DHCP lease time to use
endAddress This property is required. String
The final address in the IP Range
startAddress This property is required. String
The first address in the IP Range
defaultLeaseTime Number
The default DHCP lease time to use
maxLeaseTime Number
The maximum DHCP lease time to use

NetworkRoutedMetadataEntry
, NetworkRoutedMetadataEntryArgs

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

NetworkRoutedStaticIpPool
, NetworkRoutedStaticIpPoolArgs

EndAddress This property is required. string
The final address in the IP Range
StartAddress This property is required. string
The first address in the IP Range
EndAddress This property is required. string
The final address in the IP Range
StartAddress This property is required. string
The first address in the IP Range
endAddress This property is required. String
The final address in the IP Range
startAddress This property is required. String
The first address in the IP Range
endAddress This property is required. string
The final address in the IP Range
startAddress This property is required. string
The first address in the IP Range
end_address This property is required. str
The final address in the IP Range
start_address This property is required. str
The first address in the IP Range
endAddress This property is required. String
The final address in the IP Range
startAddress This property is required. String
The first address in 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