vcd.NetworkRoutedV2
Explore with Pulumi AI
Create NetworkRoutedV2 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
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.
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: vcd.NetworkRoutedV2MetadataEntryArray{
&vcd.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: vcd.NetworkRoutedV2SecondaryStaticIpPoolArray{
&vcd.NetworkRoutedV2SecondaryStaticIpPoolArgs{
EndAddress: pulumi.String("string"),
StartAddress: pulumi.String("string"),
},
},
StaticIpPools: vcd.NetworkRoutedV2StaticIpPoolArray{
&vcd.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:
- Edge
Gateway stringId - 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)
- Prefix
Length 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.
- Dns
Suffix string - A FQDN for the virtual machines on this network
- Dual
Stack boolEnabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - Guest
Vlan boolAllowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - Interface
Type 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 onlyinternal
andnon_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. - Metadata
Entries List<NetworkRouted V2Metadata Entry> - A set of metadata entries to assign. See Metadata section for details.
- Name string
- A unique name for the network
- Network
Routed stringV2Id - Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- Route
Advertisement boolEnabled - 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 string - IPv6 gateway when Dual-Stack mode is enabled
- Secondary
Prefix stringLength - IPv6 prefix length when Dual-Stack mode is enabled
- Secondary
Static List<NetworkIp Pools Routed V2Secondary Static Ip Pool> One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- Static
Ip List<NetworkPools Routed V2Static Ip Pool> - 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
)
- Edge
Gateway stringId - 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)
- Prefix
Length 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.
- Dns
Suffix string - A FQDN for the virtual machines on this network
- Dual
Stack boolEnabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - Guest
Vlan boolAllowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - Interface
Type 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 onlyinternal
andnon_distributed
(v3.14+, requires Edge Gateway to have non-distributed routing enabled). - 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. - Metadata
Entries []NetworkRouted V2Metadata Entry Args - A set of metadata entries to assign. See Metadata section for details.
- Name string
- A unique name for the network
- Network
Routed stringV2Id - Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- Route
Advertisement boolEnabled - 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 string - IPv6 gateway when Dual-Stack mode is enabled
- Secondary
Prefix stringLength - IPv6 prefix length when Dual-Stack mode is enabled
- Secondary
Static []NetworkIp Pools Routed V2Secondary Static Ip Pool Args One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- Static
Ip []NetworkPools Routed V2Static Ip Pool Args - 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
)
- edge
Gateway StringId - 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)
- prefix
Length 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.
- dns
Suffix String - A FQDN for the virtual machines on this network
- dual
Stack BooleanEnabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - guest
Vlan BooleanAllowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - interface
Type 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 onlyinternal
andnon_distributed
(v3.14+, requires Edge Gateway to have non-distributed routing enabled). - 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. - metadata
Entries List<NetworkRouted V2Metadata Entry> - A set of metadata entries to assign. See Metadata section for details.
- name String
- A unique name for the network
- network
Routed StringV2Id - org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- route
Advertisement BooleanEnabled - 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 String - IPv6 gateway when Dual-Stack mode is enabled
- secondary
Prefix StringLength - IPv6 prefix length when Dual-Stack mode is enabled
- secondary
Static List<NetworkIp Pools Routed V2Secondary Static Ip Pool> One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- static
Ip List<NetworkPools Routed V2Static Ip Pool> - 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
)
- edge
Gateway stringId - 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)
- prefix
Length 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.
- dns
Suffix string - A FQDN for the virtual machines on this network
- dual
Stack booleanEnabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - guest
Vlan booleanAllowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - interface
Type 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 onlyinternal
andnon_distributed
(v3.14+, requires Edge Gateway to have non-distributed routing enabled). - 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. - metadata
Entries NetworkRouted V2Metadata Entry[] - A set of metadata entries to assign. See Metadata section for details.
- name string
- A unique name for the network
- network
Routed stringV2Id - org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- route
Advertisement booleanEnabled - 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 string - IPv6 gateway when Dual-Stack mode is enabled
- secondary
Prefix stringLength - IPv6 prefix length when Dual-Stack mode is enabled
- secondary
Static NetworkIp Pools Routed V2Secondary Static Ip Pool[] One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- static
Ip NetworkPools Routed V2Static Ip Pool[] - 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
)
- edge_
gateway_ strid - 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_ boolenabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - guest_
vlan_ boolallowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - interface_
type str - An interface for the network. One of
internal
(default),subinterface
,distributed
,non_distributed
(requires the Edge Gateway to support distributed networks). NSX-T supports onlyinternal
andnon_distributed
(v3.14+, requires Edge Gateway to have non-distributed routing enabled). - 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. - metadata_
entries Sequence[NetworkRouted V2Metadata Entry Args] - A set of metadata entries to assign. See Metadata section for details.
- name str
- A unique name for the network
- network_
routed_ strv2_ id - 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_ boolenabled - 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_ strlength - IPv6 prefix length when Dual-Stack mode is enabled
- secondary_
static_ Sequence[Networkip_ pools Routed V2Secondary Static Ip Pool Args] One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- static_
ip_ Sequence[Networkpools Routed V2Static Ip Pool Args] - 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
)
- edge
Gateway StringId - 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)
- prefix
Length 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.
- dns
Suffix String - A FQDN for the virtual machines on this network
- dual
Stack BooleanEnabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - guest
Vlan BooleanAllowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - interface
Type 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 onlyinternal
andnon_distributed
(v3.14+, requires Edge Gateway to have non-distributed routing enabled). - 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. - metadata
Entries List<Property Map> - A set of metadata entries to assign. See Metadata section for details.
- name String
- A unique name for the network
- network
Routed StringV2Id - org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- route
Advertisement BooleanEnabled - 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 String - IPv6 gateway when Dual-Stack mode is enabled
- secondary
Prefix StringLength - IPv6 prefix length when Dual-Stack mode is enabled
- secondary
Static List<Property Map>Ip Pools One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- static
Ip List<Property Map>Pools - 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
)
Outputs
All input properties are implicitly available as output properties. Additionally, the NetworkRoutedV2 resource produces the following output properties:
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.
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.
- Description string
- An optional description of the network
- Dns1 string
- First DNS server to use.
- Dns2 string
- Second DNS server to use.
- Dns
Suffix string - A FQDN for the virtual machines on this network
- Dual
Stack boolEnabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - Edge
Gateway stringId - 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)
- Guest
Vlan boolAllowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - Interface
Type 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 onlyinternal
andnon_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. - Metadata
Entries List<NetworkRouted V2Metadata Entry> - A set of metadata entries to assign. See Metadata section for details.
- Name string
- A unique name for the network
- Network
Routed stringV2Id - Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- Owner
Id string - ID of VDC or VDC Group
- Prefix
Length double - The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
- Route
Advertisement boolEnabled - 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 string - IPv6 gateway when Dual-Stack mode is enabled
- Secondary
Prefix stringLength - IPv6 prefix length when Dual-Stack mode is enabled
- Secondary
Static List<NetworkIp Pools Routed V2Secondary Static Ip Pool> One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- Static
Ip List<NetworkPools Routed V2Static Ip Pool> - 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
)
- Description string
- An optional description of the network
- Dns1 string
- First DNS server to use.
- Dns2 string
- Second DNS server to use.
- Dns
Suffix string - A FQDN for the virtual machines on this network
- Dual
Stack boolEnabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - Edge
Gateway stringId - 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)
- Guest
Vlan boolAllowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - Interface
Type 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 onlyinternal
andnon_distributed
(v3.14+, requires Edge Gateway to have non-distributed routing enabled). - 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. - Metadata
Entries []NetworkRouted V2Metadata Entry Args - A set of metadata entries to assign. See Metadata section for details.
- Name string
- A unique name for the network
- Network
Routed stringV2Id - Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- Owner
Id string - ID of VDC or VDC Group
- Prefix
Length float64 - The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
- Route
Advertisement boolEnabled - 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 string - IPv6 gateway when Dual-Stack mode is enabled
- Secondary
Prefix stringLength - IPv6 prefix length when Dual-Stack mode is enabled
- Secondary
Static []NetworkIp Pools Routed V2Secondary Static Ip Pool Args One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- Static
Ip []NetworkPools Routed V2Static Ip Pool Args - 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
)
- description String
- An optional description of the network
- dns1 String
- First DNS server to use.
- dns2 String
- Second DNS server to use.
- dns
Suffix String - A FQDN for the virtual machines on this network
- dual
Stack BooleanEnabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - edge
Gateway StringId - 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)
- guest
Vlan BooleanAllowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - interface
Type 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 onlyinternal
andnon_distributed
(v3.14+, requires Edge Gateway to have non-distributed routing enabled). - 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. - metadata
Entries List<NetworkRouted V2Metadata Entry> - A set of metadata entries to assign. See Metadata section for details.
- name String
- A unique name for the network
- network
Routed StringV2Id - org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- owner
Id String - ID of VDC or VDC Group
- prefix
Length Double - The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
- route
Advertisement BooleanEnabled - 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 String - IPv6 gateway when Dual-Stack mode is enabled
- secondary
Prefix StringLength - IPv6 prefix length when Dual-Stack mode is enabled
- secondary
Static List<NetworkIp Pools Routed V2Secondary Static Ip Pool> One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- static
Ip List<NetworkPools Routed V2Static Ip Pool> - 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
)
- description string
- An optional description of the network
- dns1 string
- First DNS server to use.
- dns2 string
- Second DNS server to use.
- dns
Suffix string - A FQDN for the virtual machines on this network
- dual
Stack booleanEnabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - edge
Gateway stringId - 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)
- guest
Vlan booleanAllowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - interface
Type 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 onlyinternal
andnon_distributed
(v3.14+, requires Edge Gateway to have non-distributed routing enabled). - 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. - metadata
Entries NetworkRouted V2Metadata Entry[] - A set of metadata entries to assign. See Metadata section for details.
- name string
- A unique name for the network
- network
Routed stringV2Id - org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- owner
Id string - ID of VDC or VDC Group
- prefix
Length number - The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
- route
Advertisement booleanEnabled - 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 string - IPv6 gateway when Dual-Stack mode is enabled
- secondary
Prefix stringLength - IPv6 prefix length when Dual-Stack mode is enabled
- secondary
Static NetworkIp Pools Routed V2Secondary Static Ip Pool[] One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- static
Ip NetworkPools Routed V2Static Ip Pool[] - 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
)
- 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_ boolenabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - edge_
gateway_ strid - 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_ boolallowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - interface_
type str - An interface for the network. One of
internal
(default),subinterface
,distributed
,non_distributed
(requires the Edge Gateway to support distributed networks). NSX-T supports onlyinternal
andnon_distributed
(v3.14+, requires Edge Gateway to have non-distributed routing enabled). - 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. - metadata_
entries Sequence[NetworkRouted V2Metadata Entry Args] - A set of metadata entries to assign. See Metadata section for details.
- name str
- A unique name for the network
- network_
routed_ strv2_ id - 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_ boolenabled - 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_ strlength - IPv6 prefix length when Dual-Stack mode is enabled
- secondary_
static_ Sequence[Networkip_ pools Routed V2Secondary Static Ip Pool Args] One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- static_
ip_ Sequence[Networkpools Routed V2Static Ip Pool Args] - 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
)
- description String
- An optional description of the network
- dns1 String
- First DNS server to use.
- dns2 String
- Second DNS server to use.
- dns
Suffix String - A FQDN for the virtual machines on this network
- dual
Stack BooleanEnabled - 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
andstatic_ip_pool
while IPv6 addresses insecondary_gateway
,secondary_prefix_length
andsecondary_static_ip_pool
fields. - edge
Gateway StringId - 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)
- guest
Vlan BooleanAllowed - Set to
true
if network should allow guest VLAN tagging. Defaultfalse
. - interface
Type 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 onlyinternal
andnon_distributed
(v3.14+, requires Edge Gateway to have non-distributed routing enabled). - 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. - metadata
Entries List<Property Map> - A set of metadata entries to assign. See Metadata section for details.
- name String
- A unique name for the network
- network
Routed StringV2Id - org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
- owner
Id String - ID of VDC or VDC Group
- prefix
Length Number - The prefix length for the new network (e.g. 24 for netmask 255.255.255.0).
- route
Advertisement BooleanEnabled - 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 String - IPv6 gateway when Dual-Stack mode is enabled
- secondary
Prefix StringLength - IPv6 prefix length when Dual-Stack mode is enabled
- secondary
Static List<Property Map>Ip Pools One or more IPv6 static pools when Dual-Stack mode is enabled
When using IPv6, VCD API will expand IP Addresses if they are specified using double colon notation and it will cause inconsistent plan. (e.g.
2002::1234:abcd:ffff:c0a6:121
will be converted to2002:0:0:1234:abcd:ffff:c0a6:121
)- static
Ip List<Property Map>Pools - 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
)
Supporting Types
NetworkRoutedV2MetadataEntry, NetworkRoutedV2MetadataEntryArgs
- Is
System 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'
- User
Access 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 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'
- User
Access 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 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'
- user
Access 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 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'
- user
Access 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
- is
System 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'
- user
Access 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
- End
Address string - End address of the IP range
- Start
Address string - Start address of the IP range
- End
Address string - End address of the IP range
- Start
Address string - Start address of the IP range
- end
Address String - End address of the IP range
- start
Address String - Start address of the IP range
- end
Address string - End address of the IP range
- start
Address 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
- end
Address String - End address of the IP range
- start
Address String - Start address of the IP range
NetworkRoutedV2StaticIpPool, NetworkRoutedV2StaticIpPoolArgs
- End
Address string - End address of the IP range
- Start
Address string - Start address of the IP range
- End
Address string - End address of the IP range
- Start
Address string - Start address of the IP range
- end
Address String - End address of the IP range
- start
Address String - Start address of the IP range
- end
Address string - End address of the IP range
- start
Address 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
- end
Address String - End address of the IP range
- start
Address 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.