Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. VpcSubnet
nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.VpcSubnet

Explore with Pulumi AI

nsxt logo
nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware
vmware/terraform-provider-nsxt

    Create VpcSubnet Resource

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

    Constructor syntax

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

@overload
def VpcSubnet(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              context: Optional[VpcSubnetContextArgs] = None,
              display_name: Optional[str] = None,
              access_mode: Optional[str] = None,
              advanced_config: Optional[VpcSubnetAdvancedConfigArgs] = None,
              description: Optional[str] = None,
              dhcp_config: Optional[VpcSubnetDhcpConfigArgs] = None,
              ip_addresses: Optional[Sequence[str]] = None,
              ip_blocks: Optional[Sequence[str]] = None,
              ipv4_subnet_size: Optional[float] = None,
              nsx_id: Optional[str] = None,
              tags: Optional[Sequence[VpcSubnetTagArgs]] = None,
              vpc_subnet_id: Optional[str] = None)
    func NewVpcSubnet(ctx *Context, name string, args VpcSubnetArgs, opts ...ResourceOption) (*VpcSubnet, error)
    public VpcSubnet(string name, VpcSubnetArgs args, CustomResourceOptions? opts = null)
    public VpcSubnet(String name, VpcSubnetArgs args)
public VpcSubnet(String name, VpcSubnetArgs args, CustomResourceOptions options)

    type: nsxt:VpcSubnet
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 VpcSubnetArgs
    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 VpcSubnetArgs
    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 VpcSubnetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcSubnetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcSubnetArgs
    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 vpcSubnetResource = new Nsxt.VpcSubnet("vpcSubnetResource", new()
{
    Context = new Nsxt.Inputs.VpcSubnetContextArgs
    {
        ProjectId = "string",
        VpcId = "string",
    },
    DisplayName = "string",
    AccessMode = "string",
    AdvancedConfig = new Nsxt.Inputs.VpcSubnetAdvancedConfigArgs
    {
        ConnectivityState = "string",
        DhcpServerAddresses = new[]
        {
            "string",
        },
        ExtraConfigs = new[]
        {
            new Nsxt.Inputs.VpcSubnetAdvancedConfigExtraConfigArgs
            {
                ConfigPair = new Nsxt.Inputs.VpcSubnetAdvancedConfigExtraConfigConfigPairArgs
                {
                    Key = "string",
                    Value = "string",
                },
            },
        },
        GatewayAddresses = new[]
        {
            "string",
        },
        StaticIpAllocation = new Nsxt.Inputs.VpcSubnetAdvancedConfigStaticIpAllocationArgs
        {
            Enabled = false,
        },
    },
    Description = "string",
    DhcpConfig = new Nsxt.Inputs.VpcSubnetDhcpConfigArgs
    {
        DhcpServerAdditionalConfig = new Nsxt.Inputs.VpcSubnetDhcpConfigDhcpServerAdditionalConfigArgs
        {
            Options = new Nsxt.Inputs.VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsArgs
            {
                Option121 = new Nsxt.Inputs.VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOption121Args
                {
                    StaticRoutes = new[]
                    {
                        new Nsxt.Inputs.VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOption121StaticRouteArgs
                        {
                            Network = "string",
                            NextHop = "string",
                        },
                    },
                },
                Others = new[]
                {
                    new Nsxt.Inputs.VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOtherArgs
                    {
                        Code = 0,
                        Values = new[]
                        {
                            "string",
                        },
                    },
                },
            },
            ReservedIpRanges = new[]
            {
                "string",
            },
        },
        Mode = "string",
    },
    IpAddresses = new[]
    {
        "string",
    },
    IpBlocks = new[]
    {
        "string",
    },
    Ipv4SubnetSize = 0,
    NsxId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.VpcSubnetTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    VpcSubnetId = "string",
});

    example, err := nsxt.NewVpcSubnet(ctx, "vpcSubnetResource", &nsxt.VpcSubnetArgs{
	Context: &nsxt.VpcSubnetContextArgs{
		ProjectId: pulumi.String("string"),
		VpcId:     pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	AccessMode:  pulumi.String("string"),
	AdvancedConfig: &nsxt.VpcSubnetAdvancedConfigArgs{
		ConnectivityState: pulumi.String("string"),
		DhcpServerAddresses: pulumi.StringArray{
			pulumi.String("string"),
		},
		ExtraConfigs: nsxt.VpcSubnetAdvancedConfigExtraConfigArray{
			&nsxt.VpcSubnetAdvancedConfigExtraConfigArgs{
				ConfigPair: &nsxt.VpcSubnetAdvancedConfigExtraConfigConfigPairArgs{
					Key:   pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
		},
		GatewayAddresses: pulumi.StringArray{
			pulumi.String("string"),
		},
		StaticIpAllocation: &nsxt.VpcSubnetAdvancedConfigStaticIpAllocationArgs{
			Enabled: pulumi.Bool(false),
		},
	},
	Description: pulumi.String("string"),
	DhcpConfig: &nsxt.VpcSubnetDhcpConfigArgs{
		DhcpServerAdditionalConfig: &nsxt.VpcSubnetDhcpConfigDhcpServerAdditionalConfigArgs{
			Options: &nsxt.VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsArgs{
				Option121: &nsxt.VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOption121Args{
					StaticRoutes: nsxt.VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOption121StaticRouteArray{
						&nsxt.VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOption121StaticRouteArgs{
							Network: pulumi.String("string"),
							NextHop: pulumi.String("string"),
						},
					},
				},
				Others: nsxt.VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOtherArray{
					&nsxt.VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOtherArgs{
						Code: pulumi.Float64(0),
						Values: pulumi.StringArray{
							pulumi.String("string"),
						},
					},
				},
			},
			ReservedIpRanges: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Mode: pulumi.String("string"),
	},
	IpAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	IpBlocks: pulumi.StringArray{
		pulumi.String("string"),
	},
	Ipv4SubnetSize: pulumi.Float64(0),
	NsxId:          pulumi.String("string"),
	Tags: nsxt.VpcSubnetTagArray{
		&nsxt.VpcSubnetTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	VpcSubnetId: pulumi.String("string"),
})

    var vpcSubnetResource = new VpcSubnet("vpcSubnetResource", VpcSubnetArgs.builder()
    .context(VpcSubnetContextArgs.builder()
        .projectId("string")
        .vpcId("string")
        .build())
    .displayName("string")
    .accessMode("string")
    .advancedConfig(VpcSubnetAdvancedConfigArgs.builder()
        .connectivityState("string")
        .dhcpServerAddresses("string")
        .extraConfigs(VpcSubnetAdvancedConfigExtraConfigArgs.builder()
            .configPair(VpcSubnetAdvancedConfigExtraConfigConfigPairArgs.builder()
                .key("string")
                .value("string")
                .build())
            .build())
        .gatewayAddresses("string")
        .staticIpAllocation(VpcSubnetAdvancedConfigStaticIpAllocationArgs.builder()
            .enabled(false)
            .build())
        .build())
    .description("string")
    .dhcpConfig(VpcSubnetDhcpConfigArgs.builder()
        .dhcpServerAdditionalConfig(VpcSubnetDhcpConfigDhcpServerAdditionalConfigArgs.builder()
            .options(VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsArgs.builder()
                .option121(VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOption121Args.builder()
                    .staticRoutes(VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOption121StaticRouteArgs.builder()
                        .network("string")
                        .nextHop("string")
                        .build())
                    .build())
                .others(VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOtherArgs.builder()
                    .code(0.0)
                    .values("string")
                    .build())
                .build())
            .reservedIpRanges("string")
            .build())
        .mode("string")
        .build())
    .ipAddresses("string")
    .ipBlocks("string")
    .ipv4SubnetSize(0.0)
    .nsxId("string")
    .tags(VpcSubnetTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .vpcSubnetId("string")
    .build());

    vpc_subnet_resource = nsxt.VpcSubnet("vpcSubnetResource",
    context={
        "project_id": "string",
        "vpc_id": "string",
    },
    display_name="string",
    access_mode="string",
    advanced_config={
        "connectivity_state": "string",
        "dhcp_server_addresses": ["string"],
        "extra_configs": [{
            "config_pair": {
                "key": "string",
                "value": "string",
            },
        }],
        "gateway_addresses": ["string"],
        "static_ip_allocation": {
            "enabled": False,
        },
    },
    description="string",
    dhcp_config={
        "dhcp_server_additional_config": {
            "options": {
                "option121": {
                    "static_routes": [{
                        "network": "string",
                        "next_hop": "string",
                    }],
                },
                "others": [{
                    "code": 0,
                    "values": ["string"],
                }],
            },
            "reserved_ip_ranges": ["string"],
        },
        "mode": "string",
    },
    ip_addresses=["string"],
    ip_blocks=["string"],
    ipv4_subnet_size=0,
    nsx_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    vpc_subnet_id="string")

    const vpcSubnetResource = new nsxt.VpcSubnet("vpcSubnetResource", {
    context: {
        projectId: "string",
        vpcId: "string",
    },
    displayName: "string",
    accessMode: "string",
    advancedConfig: {
        connectivityState: "string",
        dhcpServerAddresses: ["string"],
        extraConfigs: [{
            configPair: {
                key: "string",
                value: "string",
            },
        }],
        gatewayAddresses: ["string"],
        staticIpAllocation: {
            enabled: false,
        },
    },
    description: "string",
    dhcpConfig: {
        dhcpServerAdditionalConfig: {
            options: {
                option121: {
                    staticRoutes: [{
                        network: "string",
                        nextHop: "string",
                    }],
                },
                others: [{
                    code: 0,
                    values: ["string"],
                }],
            },
            reservedIpRanges: ["string"],
        },
        mode: "string",
    },
    ipAddresses: ["string"],
    ipBlocks: ["string"],
    ipv4SubnetSize: 0,
    nsxId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
    vpcSubnetId: "string",
});

    type: nsxt:VpcSubnet
properties:
    accessMode: string
    advancedConfig:
        connectivityState: string
        dhcpServerAddresses:
            - string
        extraConfigs:
            - configPair:
                key: string
                value: string
        gatewayAddresses:
            - string
        staticIpAllocation:
            enabled: false
    context:
        projectId: string
        vpcId: string
    description: string
    dhcpConfig:
        dhcpServerAdditionalConfig:
            options:
                option121:
                    staticRoutes:
                        - network: string
                          nextHop: string
                others:
                    - code: 0
                      values:
                        - string
            reservedIpRanges:
                - string
        mode: string
    displayName: string
    ipAddresses:
        - string
    ipBlocks:
        - string
    ipv4SubnetSize: 0
    nsxId: string
    tags:
        - scope: string
          tag: string
    vpcSubnetId: string

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

    Context VpcSubnetContext
    Resource context
    DisplayName string
    Display name of the resource.
    AccessMode string
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    AdvancedConfig VpcSubnetAdvancedConfig
    Advanced Configuration for the Subnet
    Description string
    Description of the resource.
    DhcpConfig VpcSubnetDhcpConfig
    DHCP configuration block
    IpAddresses List<string>
    If not provided, Ip assignment will be done based on VPC CIDRs
    IpBlocks List<string>
    List of IP block path for subnet IP allocation
    Ipv4SubnetSize double
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Tags List<VpcSubnetTag>
    A list of scope + tag pairs to associate with this resource.
    VpcSubnetId string
    ID of the resource.
    Context VpcSubnetContextArgs
    Resource context
    DisplayName string
    Display name of the resource.
    AccessMode string
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    AdvancedConfig VpcSubnetAdvancedConfigArgs
    Advanced Configuration for the Subnet
    Description string
    Description of the resource.
    DhcpConfig VpcSubnetDhcpConfigArgs
    DHCP configuration block
    IpAddresses []string
    If not provided, Ip assignment will be done based on VPC CIDRs
    IpBlocks []string
    List of IP block path for subnet IP allocation
    Ipv4SubnetSize float64
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Tags []VpcSubnetTagArgs
    A list of scope + tag pairs to associate with this resource.
    VpcSubnetId string
    ID of the resource.
    context VpcSubnetContext
    Resource context
    displayName String
    Display name of the resource.
    accessMode String
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    advancedConfig VpcSubnetAdvancedConfig
    Advanced Configuration for the Subnet
    description String
    Description of the resource.
    dhcpConfig VpcSubnetDhcpConfig
    DHCP configuration block
    ipAddresses List<String>
    If not provided, Ip assignment will be done based on VPC CIDRs
    ipBlocks List<String>
    List of IP block path for subnet IP allocation
    ipv4SubnetSize Double
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    tags List<VpcSubnetTag>
    A list of scope + tag pairs to associate with this resource.
    vpcSubnetId String
    ID of the resource.
    context VpcSubnetContext
    Resource context
    displayName string
    Display name of the resource.
    accessMode string
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    advancedConfig VpcSubnetAdvancedConfig
    Advanced Configuration for the Subnet
    description string
    Description of the resource.
    dhcpConfig VpcSubnetDhcpConfig
    DHCP configuration block
    ipAddresses string[]
    If not provided, Ip assignment will be done based on VPC CIDRs
    ipBlocks string[]
    List of IP block path for subnet IP allocation
    ipv4SubnetSize number
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    tags VpcSubnetTag[]
    A list of scope + tag pairs to associate with this resource.
    vpcSubnetId string
    ID of the resource.
    context VpcSubnetContextArgs
    Resource context
    display_name str
    Display name of the resource.
    access_mode str
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    advanced_config VpcSubnetAdvancedConfigArgs
    Advanced Configuration for the Subnet
    description str
    Description of the resource.
    dhcp_config VpcSubnetDhcpConfigArgs
    DHCP configuration block
    ip_addresses Sequence[str]
    If not provided, Ip assignment will be done based on VPC CIDRs
    ip_blocks Sequence[str]
    List of IP block path for subnet IP allocation
    ipv4_subnet_size float
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    tags Sequence[VpcSubnetTagArgs]
    A list of scope + tag pairs to associate with this resource.
    vpc_subnet_id str
    ID of the resource.
    context Property Map
    Resource context
    displayName String
    Display name of the resource.
    accessMode String
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    advancedConfig Property Map
    Advanced Configuration for the Subnet
    description String
    Description of the resource.
    dhcpConfig Property Map
    DHCP configuration block
    ipAddresses List<String>
    If not provided, Ip assignment will be done based on VPC CIDRs
    ipBlocks List<String>
    List of IP block path for subnet IP allocation
    ipv4SubnetSize Number
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    vpcSubnetId String
    ID of the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    Look up Existing VpcSubnet Resource

    Get an existing VpcSubnet 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?: VpcSubnetState, opts?: CustomResourceOptions): VpcSubnet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_mode: Optional[str] = None,
        advanced_config: Optional[VpcSubnetAdvancedConfigArgs] = None,
        context: Optional[VpcSubnetContextArgs] = None,
        description: Optional[str] = None,
        dhcp_config: Optional[VpcSubnetDhcpConfigArgs] = None,
        display_name: Optional[str] = None,
        ip_addresses: Optional[Sequence[str]] = None,
        ip_blocks: Optional[Sequence[str]] = None,
        ipv4_subnet_size: Optional[float] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[VpcSubnetTagArgs]] = None,
        vpc_subnet_id: Optional[str] = None) -> VpcSubnet
    func GetVpcSubnet(ctx *Context, name string, id IDInput, state *VpcSubnetState, opts ...ResourceOption) (*VpcSubnet, error)
    public static VpcSubnet Get(string name, Input<string> id, VpcSubnetState? state, CustomResourceOptions? opts = null)
    public static VpcSubnet get(String name, Output<String> id, VpcSubnetState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:VpcSubnet    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:
    AccessMode string
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    AdvancedConfig VpcSubnetAdvancedConfig
    Advanced Configuration for the Subnet
    Context VpcSubnetContext
    Resource context
    Description string
    Description of the resource.
    DhcpConfig VpcSubnetDhcpConfig
    DHCP configuration block
    DisplayName string
    Display name of the resource.
    IpAddresses List<string>
    If not provided, Ip assignment will be done based on VPC CIDRs
    IpBlocks List<string>
    List of IP block path for subnet IP allocation
    Ipv4SubnetSize double
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags List<VpcSubnetTag>
    A list of scope + tag pairs to associate with this resource.
    VpcSubnetId string
    ID of the resource.
    AccessMode string
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    AdvancedConfig VpcSubnetAdvancedConfigArgs
    Advanced Configuration for the Subnet
    Context VpcSubnetContextArgs
    Resource context
    Description string
    Description of the resource.
    DhcpConfig VpcSubnetDhcpConfigArgs
    DHCP configuration block
    DisplayName string
    Display name of the resource.
    IpAddresses []string
    If not provided, Ip assignment will be done based on VPC CIDRs
    IpBlocks []string
    List of IP block path for subnet IP allocation
    Ipv4SubnetSize float64
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []VpcSubnetTagArgs
    A list of scope + tag pairs to associate with this resource.
    VpcSubnetId string
    ID of the resource.
    accessMode String
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    advancedConfig VpcSubnetAdvancedConfig
    Advanced Configuration for the Subnet
    context VpcSubnetContext
    Resource context
    description String
    Description of the resource.
    dhcpConfig VpcSubnetDhcpConfig
    DHCP configuration block
    displayName String
    Display name of the resource.
    ipAddresses List<String>
    If not provided, Ip assignment will be done based on VPC CIDRs
    ipBlocks List<String>
    List of IP block path for subnet IP allocation
    ipv4SubnetSize Double
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<VpcSubnetTag>
    A list of scope + tag pairs to associate with this resource.
    vpcSubnetId String
    ID of the resource.
    accessMode string
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    advancedConfig VpcSubnetAdvancedConfig
    Advanced Configuration for the Subnet
    context VpcSubnetContext
    Resource context
    description string
    Description of the resource.
    dhcpConfig VpcSubnetDhcpConfig
    DHCP configuration block
    displayName string
    Display name of the resource.
    ipAddresses string[]
    If not provided, Ip assignment will be done based on VPC CIDRs
    ipBlocks string[]
    List of IP block path for subnet IP allocation
    ipv4SubnetSize number
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags VpcSubnetTag[]
    A list of scope + tag pairs to associate with this resource.
    vpcSubnetId string
    ID of the resource.
    access_mode str
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    advanced_config VpcSubnetAdvancedConfigArgs
    Advanced Configuration for the Subnet
    context VpcSubnetContextArgs
    Resource context
    description str
    Description of the resource.
    dhcp_config VpcSubnetDhcpConfigArgs
    DHCP configuration block
    display_name str
    Display name of the resource.
    ip_addresses Sequence[str]
    If not provided, Ip assignment will be done based on VPC CIDRs
    ip_blocks Sequence[str]
    List of IP block path for subnet IP allocation
    ipv4_subnet_size float
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags Sequence[VpcSubnetTagArgs]
    A list of scope + tag pairs to associate with this resource.
    vpc_subnet_id str
    ID of the resource.
    accessMode String
    Subnet access mode, one of Private, Public, Isolated or Private_TGW. Default is Private
    advancedConfig Property Map
    Advanced Configuration for the Subnet
    context Property Map
    Resource context
    description String
    Description of the resource.
    dhcpConfig Property Map
    DHCP configuration block
    displayName String
    Display name of the resource.
    ipAddresses List<String>
    If not provided, Ip assignment will be done based on VPC CIDRs
    ipBlocks List<String>
    List of IP block path for subnet IP allocation
    ipv4SubnetSize Number
    If IP Addresses are not provided, this field will be used to carve out the ips from respective ip block defined in the parent VPC. The default is 64.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    vpcSubnetId String
    ID of the resource.

    Supporting Types

    VpcSubnetAdvancedConfig, VpcSubnetAdvancedConfigArgs

    ConnectivityState string
    Connectivity state for the subnet, one of CONNECTED, DISCONNECTED
    DhcpServerAddresses List<string>
    List of DHCP server addresses per address family, in CIDR format
    ExtraConfigs List<VpcSubnetAdvancedConfigExtraConfig>
    GatewayAddresses List<string>
    List of Gateway IP Addresses per address family, in CIDR format
    StaticIpAllocation VpcSubnetAdvancedConfigStaticIpAllocation
    Static IP allocation configuration
    ConnectivityState string
    Connectivity state for the subnet, one of CONNECTED, DISCONNECTED
    DhcpServerAddresses []string
    List of DHCP server addresses per address family, in CIDR format
    ExtraConfigs []VpcSubnetAdvancedConfigExtraConfig
    GatewayAddresses []string
    List of Gateway IP Addresses per address family, in CIDR format
    StaticIpAllocation VpcSubnetAdvancedConfigStaticIpAllocation
    Static IP allocation configuration
    connectivityState String
    Connectivity state for the subnet, one of CONNECTED, DISCONNECTED
    dhcpServerAddresses List<String>
    List of DHCP server addresses per address family, in CIDR format
    extraConfigs List<VpcSubnetAdvancedConfigExtraConfig>
    gatewayAddresses List<String>
    List of Gateway IP Addresses per address family, in CIDR format
    staticIpAllocation VpcSubnetAdvancedConfigStaticIpAllocation
    Static IP allocation configuration
    connectivityState string
    Connectivity state for the subnet, one of CONNECTED, DISCONNECTED
    dhcpServerAddresses string[]
    List of DHCP server addresses per address family, in CIDR format
    extraConfigs VpcSubnetAdvancedConfigExtraConfig[]
    gatewayAddresses string[]
    List of Gateway IP Addresses per address family, in CIDR format
    staticIpAllocation VpcSubnetAdvancedConfigStaticIpAllocation
    Static IP allocation configuration
    connectivity_state str
    Connectivity state for the subnet, one of CONNECTED, DISCONNECTED
    dhcp_server_addresses Sequence[str]
    List of DHCP server addresses per address family, in CIDR format
    extra_configs Sequence[VpcSubnetAdvancedConfigExtraConfig]
    gateway_addresses Sequence[str]
    List of Gateway IP Addresses per address family, in CIDR format
    static_ip_allocation VpcSubnetAdvancedConfigStaticIpAllocation
    Static IP allocation configuration
    connectivityState String
    Connectivity state for the subnet, one of CONNECTED, DISCONNECTED
    dhcpServerAddresses List<String>
    List of DHCP server addresses per address family, in CIDR format
    extraConfigs List<Property Map>
    gatewayAddresses List<String>
    List of Gateway IP Addresses per address family, in CIDR format
    staticIpAllocation Property Map
    Static IP allocation configuration

    VpcSubnetAdvancedConfigExtraConfig, VpcSubnetAdvancedConfigExtraConfigArgs

    VpcSubnetAdvancedConfigExtraConfigConfigPair, VpcSubnetAdvancedConfigExtraConfigConfigPairArgs

    Key string
    key for vendor-specific configuration
    Value string
    value for vendor-specific configuration
    Key string
    key for vendor-specific configuration
    Value string
    value for vendor-specific configuration
    key String
    key for vendor-specific configuration
    value String
    value for vendor-specific configuration
    key string
    key for vendor-specific configuration
    value string
    value for vendor-specific configuration
    key str
    key for vendor-specific configuration
    value str
    value for vendor-specific configuration
    key String
    key for vendor-specific configuration
    value String
    value for vendor-specific configuration

    VpcSubnetAdvancedConfigStaticIpAllocation, VpcSubnetAdvancedConfigStaticIpAllocationArgs

    Enabled bool
    Enable ip and mac address allocation for VPC Subnet ports from static ip pool. To enable this, dhcp pool shall be empty and static ip pool shall own all available ip addresses.
    Enabled bool
    Enable ip and mac address allocation for VPC Subnet ports from static ip pool. To enable this, dhcp pool shall be empty and static ip pool shall own all available ip addresses.
    enabled Boolean
    Enable ip and mac address allocation for VPC Subnet ports from static ip pool. To enable this, dhcp pool shall be empty and static ip pool shall own all available ip addresses.
    enabled boolean
    Enable ip and mac address allocation for VPC Subnet ports from static ip pool. To enable this, dhcp pool shall be empty and static ip pool shall own all available ip addresses.
    enabled bool
    Enable ip and mac address allocation for VPC Subnet ports from static ip pool. To enable this, dhcp pool shall be empty and static ip pool shall own all available ip addresses.
    enabled Boolean
    Enable ip and mac address allocation for VPC Subnet ports from static ip pool. To enable this, dhcp pool shall be empty and static ip pool shall own all available ip addresses.

    VpcSubnetContext, VpcSubnetContextArgs

    ProjectId string
    Id of the project which the resource belongs to.
    VpcId string
    Id of the VPC which the resource belongs to.
    ProjectId string
    Id of the project which the resource belongs to.
    VpcId string
    Id of the VPC which the resource belongs to.
    projectId String
    Id of the project which the resource belongs to.
    vpcId String
    Id of the VPC which the resource belongs to.
    projectId string
    Id of the project which the resource belongs to.
    vpcId string
    Id of the VPC which the resource belongs to.
    project_id str
    Id of the project which the resource belongs to.
    vpc_id str
    Id of the VPC which the resource belongs to.
    projectId String
    Id of the project which the resource belongs to.
    vpcId String
    Id of the VPC which the resource belongs to.

    VpcSubnetDhcpConfig, VpcSubnetDhcpConfigArgs

    DhcpServerAdditionalConfig VpcSubnetDhcpConfigDhcpServerAdditionalConfig
    Additional DHCP server config
    Mode string
    The operational mode of DHCP within the subnet, can be one of DHCP_SERVER, DHCP_RELAY, DHCP_DEACTIVATED. Default is DHCP_DEACTIVATED
    DhcpServerAdditionalConfig VpcSubnetDhcpConfigDhcpServerAdditionalConfig
    Additional DHCP server config
    Mode string
    The operational mode of DHCP within the subnet, can be one of DHCP_SERVER, DHCP_RELAY, DHCP_DEACTIVATED. Default is DHCP_DEACTIVATED
    dhcpServerAdditionalConfig VpcSubnetDhcpConfigDhcpServerAdditionalConfig
    Additional DHCP server config
    mode String
    The operational mode of DHCP within the subnet, can be one of DHCP_SERVER, DHCP_RELAY, DHCP_DEACTIVATED. Default is DHCP_DEACTIVATED
    dhcpServerAdditionalConfig VpcSubnetDhcpConfigDhcpServerAdditionalConfig
    Additional DHCP server config
    mode string
    The operational mode of DHCP within the subnet, can be one of DHCP_SERVER, DHCP_RELAY, DHCP_DEACTIVATED. Default is DHCP_DEACTIVATED
    dhcp_server_additional_config VpcSubnetDhcpConfigDhcpServerAdditionalConfig
    Additional DHCP server config
    mode str
    The operational mode of DHCP within the subnet, can be one of DHCP_SERVER, DHCP_RELAY, DHCP_DEACTIVATED. Default is DHCP_DEACTIVATED
    dhcpServerAdditionalConfig Property Map
    Additional DHCP server config
    mode String
    The operational mode of DHCP within the subnet, can be one of DHCP_SERVER, DHCP_RELAY, DHCP_DEACTIVATED. Default is DHCP_DEACTIVATED

    VpcSubnetDhcpConfigDhcpServerAdditionalConfig, VpcSubnetDhcpConfigDhcpServerAdditionalConfigArgs

    Options VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptions
    DHCPv4 options block
    ReservedIpRanges List<string>
    Specifies IP ranges that are reserved and excluded from being assigned by the DHCP server to clients. This is a list of IP ranges or IP addresses.
    Options VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptions
    DHCPv4 options block
    ReservedIpRanges []string
    Specifies IP ranges that are reserved and excluded from being assigned by the DHCP server to clients. This is a list of IP ranges or IP addresses.
    options VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptions
    DHCPv4 options block
    reservedIpRanges List<String>
    Specifies IP ranges that are reserved and excluded from being assigned by the DHCP server to clients. This is a list of IP ranges or IP addresses.
    options VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptions
    DHCPv4 options block
    reservedIpRanges string[]
    Specifies IP ranges that are reserved and excluded from being assigned by the DHCP server to clients. This is a list of IP ranges or IP addresses.
    options VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptions
    DHCPv4 options block
    reserved_ip_ranges Sequence[str]
    Specifies IP ranges that are reserved and excluded from being assigned by the DHCP server to clients. This is a list of IP ranges or IP addresses.
    options Property Map
    DHCPv4 options block
    reservedIpRanges List<String>
    Specifies IP ranges that are reserved and excluded from being assigned by the DHCP server to clients. This is a list of IP ranges or IP addresses.

    VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptions, VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsArgs

    option121 Property Map
    Specification for DHCP option 121
    others List<Property Map>
    DHCP option in generic format

    VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOption121, VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOption121Args

    VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOption121StaticRoute, VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOption121StaticRouteArgs

    Network string
    Destination network in CIDR format
    NextHop string
    IP Address for next hop of the route
    Network string
    Destination network in CIDR format
    NextHop string
    IP Address for next hop of the route
    network String
    Destination network in CIDR format
    nextHop String
    IP Address for next hop of the route
    network string
    Destination network in CIDR format
    nextHop string
    IP Address for next hop of the route
    network str
    Destination network in CIDR format
    next_hop str
    IP Address for next hop of the route
    network String
    Destination network in CIDR format
    nextHop String
    IP Address for next hop of the route

    VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOther, VpcSubnetDhcpConfigDhcpServerAdditionalConfigOptionsOtherArgs

    Code double
    Code of DHCP option
    Values List<string>
    List of values in string format
    Code float64
    Code of DHCP option
    Values []string
    List of values in string format
    code Double
    Code of DHCP option
    values List<String>
    List of values in string format
    code number
    Code of DHCP option
    values string[]
    List of values in string format
    code float
    Code of DHCP option
    values Sequence[str]
    List of values in string format
    code Number
    Code of DHCP option
    values List<String>
    List of values in string format

    VpcSubnetTag, VpcSubnetTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.9.0 published on Friday, Jun 20, 2025 by vmware
    vmware/terraform-provider-nsxt