Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. IpPool
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.IpPool

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create IpPool Resource

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

    Constructor syntax

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

@overload
def IpPool(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           description: Optional[str] = None,
           display_name: Optional[str] = None,
           ip_pool_id: Optional[str] = None,
           subnets: Optional[Sequence[IpPoolSubnetArgs]] = None,
           tags: Optional[Sequence[IpPoolTagArgs]] = None)
    func NewIpPool(ctx *Context, name string, args *IpPoolArgs, opts ...ResourceOption) (*IpPool, error)
    public IpPool(string name, IpPoolArgs? args = null, CustomResourceOptions? opts = null)
    public IpPool(String name, IpPoolArgs args)
public IpPool(String name, IpPoolArgs args, CustomResourceOptions options)

    type: nsxt:IpPool
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 IpPoolArgs
    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 IpPoolArgs
    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 IpPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IpPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IpPoolArgs
    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 ipPoolResource = new Nsxt.IpPool("ipPoolResource", new()
{
    Description = "string",
    DisplayName = "string",
    IpPoolId = "string",
    Subnets = new[]
    {
        new Nsxt.Inputs.IpPoolSubnetArgs
        {
            AllocationRanges = new[]
            {
                "string",
            },
            Cidr = "string",
            DnsNameservers = new[]
            {
                "string",
            },
            DnsSuffix = "string",
            GatewayIp = "string",
        },
    },
    Tags = new[]
    {
        new Nsxt.Inputs.IpPoolTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewIpPool(ctx, "ipPoolResource", &nsxt.IpPoolArgs{
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	IpPoolId:    pulumi.String("string"),
	Subnets: nsxt.IpPoolSubnetArray{
		&nsxt.IpPoolSubnetArgs{
			AllocationRanges: pulumi.StringArray{
				pulumi.String("string"),
			},
			Cidr: pulumi.String("string"),
			DnsNameservers: pulumi.StringArray{
				pulumi.String("string"),
			},
			DnsSuffix: pulumi.String("string"),
			GatewayIp: pulumi.String("string"),
		},
	},
	Tags: nsxt.IpPoolTagArray{
		&nsxt.IpPoolTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var ipPoolResource = new IpPool("ipPoolResource", IpPoolArgs.builder()
    .description("string")
    .displayName("string")
    .ipPoolId("string")
    .subnets(IpPoolSubnetArgs.builder()
        .allocationRanges("string")
        .cidr("string")
        .dnsNameservers("string")
        .dnsSuffix("string")
        .gatewayIp("string")
        .build())
    .tags(IpPoolTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    ip_pool_resource = nsxt.IpPool("ipPoolResource",
    description="string",
    display_name="string",
    ip_pool_id="string",
    subnets=[{
        "allocation_ranges": ["string"],
        "cidr": "string",
        "dns_nameservers": ["string"],
        "dns_suffix": "string",
        "gateway_ip": "string",
    }],
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const ipPoolResource = new nsxt.IpPool("ipPoolResource", {
    description: "string",
    displayName: "string",
    ipPoolId: "string",
    subnets: [{
        allocationRanges: ["string"],
        cidr: "string",
        dnsNameservers: ["string"],
        dnsSuffix: "string",
        gatewayIp: "string",
    }],
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:IpPool
properties:
    description: string
    displayName: string
    ipPoolId: string
    subnets:
        - allocationRanges:
            - string
          cidr: string
          dnsNameservers:
            - string
          dnsSuffix: string
          gatewayIp: string
    tags:
        - scope: string
          tag: string

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

    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpPoolId string
    ID of the IP pool.
    Subnets List<IpPoolSubnet>
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    Tags List<IpPoolTag>
    A list of scope + tag pairs to associate with this IP pool.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpPoolId string
    ID of the IP pool.
    Subnets []IpPoolSubnetArgs
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    Tags []IpPoolTagArgs
    A list of scope + tag pairs to associate with this IP pool.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipPoolId String
    ID of the IP pool.
    subnets List<IpPoolSubnet>
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    tags List<IpPoolTag>
    A list of scope + tag pairs to associate with this IP pool.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    ipPoolId string
    ID of the IP pool.
    subnets IpPoolSubnet[]
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    tags IpPoolTag[]
    A list of scope + tag pairs to associate with this IP pool.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    ip_pool_id str
    ID of the IP pool.
    subnets Sequence[IpPoolSubnetArgs]
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    tags Sequence[IpPoolTagArgs]
    A list of scope + tag pairs to associate with this IP pool.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipPoolId String
    ID of the IP pool.
    subnets List<Property Map>
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    tags List<Property Map>
    A list of scope + tag pairs to associate with this IP pool.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed 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.
    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.
    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.
    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.
    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.
    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 IpPool Resource

    Get an existing IpPool 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?: IpPoolState, opts?: CustomResourceOptions): IpPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        ip_pool_id: Optional[str] = None,
        revision: Optional[float] = None,
        subnets: Optional[Sequence[IpPoolSubnetArgs]] = None,
        tags: Optional[Sequence[IpPoolTagArgs]] = None) -> IpPool
    func GetIpPool(ctx *Context, name string, id IDInput, state *IpPoolState, opts ...ResourceOption) (*IpPool, error)
    public static IpPool Get(string name, Input<string> id, IpPoolState? state, CustomResourceOptions? opts = null)
    public static IpPool get(String name, Output<String> id, IpPoolState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:IpPool    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpPoolId string
    ID of the IP pool.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Subnets List<IpPoolSubnet>
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    Tags List<IpPoolTag>
    A list of scope + tag pairs to associate with this IP pool.
    Description string
    Description of this resource.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    IpPoolId string
    ID of the IP pool.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Subnets []IpPoolSubnetArgs
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    Tags []IpPoolTagArgs
    A list of scope + tag pairs to associate with this IP pool.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipPoolId String
    ID of the IP pool.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    subnets List<IpPoolSubnet>
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    tags List<IpPoolTag>
    A list of scope + tag pairs to associate with this IP pool.
    description string
    Description of this resource.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    ipPoolId string
    ID of the IP pool.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    subnets IpPoolSubnet[]
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    tags IpPoolTag[]
    A list of scope + tag pairs to associate with this IP pool.
    description str
    Description of this resource.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    ip_pool_id str
    ID of the IP pool.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    subnets Sequence[IpPoolSubnetArgs]
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    tags Sequence[IpPoolTagArgs]
    A list of scope + tag pairs to associate with this IP pool.
    description String
    Description of this resource.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    ipPoolId String
    ID of the IP pool.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    subnets List<Property Map>
    Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets. Each subnet has the following arguments:
    tags List<Property Map>
    A list of scope + tag pairs to associate with this IP pool.

    Supporting Types

    IpPoolSubnet, IpPoolSubnetArgs

    AllocationRanges List<string>
    A collection of IPv4 Pool Ranges
    Cidr string
    Network address and the prefix length which will be associated with a layer-2 broadcast domainIPv4 Pool Ranges
    DnsNameservers List<string>
    A collection of up to 3 DNS servers for the subnet
    DnsSuffix string
    The DNS suffix for the DNS server
    GatewayIp string
    The default gateway address on a layer-3 router
    AllocationRanges []string
    A collection of IPv4 Pool Ranges
    Cidr string
    Network address and the prefix length which will be associated with a layer-2 broadcast domainIPv4 Pool Ranges
    DnsNameservers []string
    A collection of up to 3 DNS servers for the subnet
    DnsSuffix string
    The DNS suffix for the DNS server
    GatewayIp string
    The default gateway address on a layer-3 router
    allocationRanges List<String>
    A collection of IPv4 Pool Ranges
    cidr String
    Network address and the prefix length which will be associated with a layer-2 broadcast domainIPv4 Pool Ranges
    dnsNameservers List<String>
    A collection of up to 3 DNS servers for the subnet
    dnsSuffix String
    The DNS suffix for the DNS server
    gatewayIp String
    The default gateway address on a layer-3 router
    allocationRanges string[]
    A collection of IPv4 Pool Ranges
    cidr string
    Network address and the prefix length which will be associated with a layer-2 broadcast domainIPv4 Pool Ranges
    dnsNameservers string[]
    A collection of up to 3 DNS servers for the subnet
    dnsSuffix string
    The DNS suffix for the DNS server
    gatewayIp string
    The default gateway address on a layer-3 router
    allocation_ranges Sequence[str]
    A collection of IPv4 Pool Ranges
    cidr str
    Network address and the prefix length which will be associated with a layer-2 broadcast domainIPv4 Pool Ranges
    dns_nameservers Sequence[str]
    A collection of up to 3 DNS servers for the subnet
    dns_suffix str
    The DNS suffix for the DNS server
    gateway_ip str
    The default gateway address on a layer-3 router
    allocationRanges List<String>
    A collection of IPv4 Pool Ranges
    cidr String
    Network address and the prefix length which will be associated with a layer-2 broadcast domainIPv4 Pool Ranges
    dnsNameservers List<String>
    A collection of up to 3 DNS servers for the subnet
    dnsSuffix String
    The DNS suffix for the DNS server
    gatewayIp String
    The default gateway address on a layer-3 router

    IpPoolTag, IpPoolTagArgs

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

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt