Viewing docs for nsxt 3.11.0
published on Monday, Dec 15, 2025 by vmware
published on Monday, Dec 15, 2025 by vmware
Viewing docs for nsxt 3.11.0
published on Monday, Dec 15, 2025 by vmware
published on Monday, Dec 15, 2025 by vmware
This data source provides information about a IP Pool configured on NSX.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";
const ipPool = nsxt.getIpPool({
displayName: "DefaultIpPool",
});
import pulumi
import pulumi_nsxt as nsxt
ip_pool = nsxt.get_ip_pool(display_name="DefaultIpPool")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := nsxt.LookupIpPool(ctx, &nsxt.LookupIpPoolArgs{
DisplayName: pulumi.StringRef("DefaultIpPool"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;
return await Deployment.RunAsync(() =>
{
var ipPool = Nsxt.GetIpPool.Invoke(new()
{
DisplayName = "DefaultIpPool",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.NsxtFunctions;
import com.pulumi.nsxt.inputs.GetIpPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var ipPool = NsxtFunctions.getIpPool(GetIpPoolArgs.builder()
.displayName("DefaultIpPool")
.build());
}
}
variables:
ipPool:
fn::invoke:
function: nsxt:getIpPool
arguments:
displayName: DefaultIpPool
Using getIpPool
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getIpPool(args: GetIpPoolArgs, opts?: InvokeOptions): Promise<GetIpPoolResult>
function getIpPoolOutput(args: GetIpPoolOutputArgs, opts?: InvokeOptions): Output<GetIpPoolResult>def get_ip_pool(description: Optional[str] = None,
display_name: Optional[str] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetIpPoolResult
def get_ip_pool_output(description: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetIpPoolResult]func LookupIpPool(ctx *Context, args *LookupIpPoolArgs, opts ...InvokeOption) (*LookupIpPoolResult, error)
func LookupIpPoolOutput(ctx *Context, args *LookupIpPoolOutputArgs, opts ...InvokeOption) LookupIpPoolResultOutput> Note: This function is named LookupIpPool in the Go SDK.
public static class GetIpPool
{
public static Task<GetIpPoolResult> InvokeAsync(GetIpPoolArgs args, InvokeOptions? opts = null)
public static Output<GetIpPoolResult> Invoke(GetIpPoolInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetIpPoolResult> getIpPool(GetIpPoolArgs args, InvokeOptions options)
public static Output<GetIpPoolResult> getIpPool(GetIpPoolArgs args, InvokeOptions options)
fn::invoke:
function: nsxt:index/getIpPool:getIpPool
arguments:
# arguments dictionaryThe following arguments are supported:
- Description string
- The description of the IP pool.
- Display
Name string - The Display Name of the IP pool to retrieve.
- Id string
- The ID of IP pool to retrieve
- Description string
- The description of the IP pool.
- Display
Name string - The Display Name of the IP pool to retrieve.
- Id string
- The ID of IP pool to retrieve
- description String
- The description of the IP pool.
- display
Name String - The Display Name of the IP pool to retrieve.
- id String
- The ID of IP pool to retrieve
- description string
- The description of the IP pool.
- display
Name string - The Display Name of the IP pool to retrieve.
- id string
- The ID of IP pool to retrieve
- description str
- The description of the IP pool.
- display_
name str - The Display Name of the IP pool to retrieve.
- id str
- The ID of IP pool to retrieve
- description String
- The description of the IP pool.
- display
Name String - The Display Name of the IP pool to retrieve.
- id String
- The ID of IP pool to retrieve
getIpPool Result
The following output properties are available:
- Description string
- The description of the IP pool.
- Display
Name string - Id string
- Description string
- The description of the IP pool.
- Display
Name string - Id string
- description String
- The description of the IP pool.
- display
Name String - id String
- description string
- The description of the IP pool.
- display
Name string - id string
- description str
- The description of the IP pool.
- display_
name str - id str
- description String
- The description of the IP pool.
- display
Name String - id String
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxtTerraform Provider.
Viewing docs for nsxt 3.11.0
published on Monday, Dec 15, 2025 by vmware
published on Monday, Dec 15, 2025 by vmware
