nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
nsxt.getPolicyIpPool
Explore with Pulumi AI
This data source provides information about policy IP Pools configured on NSX.
This data source is applicable to NSX Policy Manager.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";
const test = nsxt.getPolicyIpPool({
displayName: "ippool1",
});
import pulumi
import pulumi_nsxt as nsxt
test = nsxt.get_policy_ip_pool(display_name="ippool1")
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.LookupPolicyIpPool(ctx, &nsxt.LookupPolicyIpPoolArgs{
DisplayName: pulumi.StringRef("ippool1"),
}, 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 test = Nsxt.GetPolicyIpPool.Invoke(new()
{
DisplayName = "ippool1",
});
});
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.GetPolicyIpPoolArgs;
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 test = NsxtFunctions.getPolicyIpPool(GetPolicyIpPoolArgs.builder()
.displayName("ippool1")
.build());
}
}
variables:
test:
fn::invoke:
function: nsxt:getPolicyIpPool
arguments:
displayName: ippool1
Multi-Tenancy
import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";
const demoproj = nsxt.getPolicyProject({
displayName: "demoproj",
});
const demopool = demoproj.then(demoproj => nsxt.getPolicyIpPool({
context: {
projectId: demoproj.id,
},
displayName: "demopool",
}));
import pulumi
import pulumi_nsxt as nsxt
demoproj = nsxt.get_policy_project(display_name="demoproj")
demopool = nsxt.get_policy_ip_pool(context={
"project_id": demoproj.id,
},
display_name="demopool")
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 {
demoproj, err := nsxt.LookupPolicyProject(ctx, &nsxt.LookupPolicyProjectArgs{
DisplayName: pulumi.StringRef("demoproj"),
}, nil)
if err != nil {
return err
}
_, err = nsxt.LookupPolicyIpPool(ctx, &nsxt.LookupPolicyIpPoolArgs{
Context: nsxt.GetPolicyIpPoolContext{
ProjectId: demoproj.Id,
},
DisplayName: pulumi.StringRef("demopool"),
}, 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 demoproj = Nsxt.GetPolicyProject.Invoke(new()
{
DisplayName = "demoproj",
});
var demopool = Nsxt.GetPolicyIpPool.Invoke(new()
{
Context = new Nsxt.Inputs.GetPolicyIpPoolContextInputArgs
{
ProjectId = demoproj.Apply(getPolicyProjectResult => getPolicyProjectResult.Id),
},
DisplayName = "demopool",
});
});
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.GetPolicyProjectArgs;
import com.pulumi.nsxt.inputs.GetPolicyIpPoolArgs;
import com.pulumi.nsxt.inputs.GetPolicyIpPoolContextArgs;
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 demoproj = NsxtFunctions.getPolicyProject(GetPolicyProjectArgs.builder()
.displayName("demoproj")
.build());
final var demopool = NsxtFunctions.getPolicyIpPool(GetPolicyIpPoolArgs.builder()
.context(GetPolicyIpPoolContextArgs.builder()
.projectId(demoproj.applyValue(getPolicyProjectResult -> getPolicyProjectResult.id()))
.build())
.displayName("demopool")
.build());
}
}
variables:
demoproj:
fn::invoke:
function: nsxt:getPolicyProject
arguments:
displayName: demoproj
demopool:
fn::invoke:
function: nsxt:getPolicyIpPool
arguments:
context:
projectId: ${demoproj.id}
displayName: demopool
Using getPolicyIpPool
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 getPolicyIpPool(args: GetPolicyIpPoolArgs, opts?: InvokeOptions): Promise<GetPolicyIpPoolResult>
function getPolicyIpPoolOutput(args: GetPolicyIpPoolOutputArgs, opts?: InvokeOptions): Output<GetPolicyIpPoolResult>
def get_policy_ip_pool(context: Optional[GetPolicyIpPoolContext] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPolicyIpPoolResult
def get_policy_ip_pool_output(context: Optional[pulumi.Input[GetPolicyIpPoolContextArgs]] = None,
description: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPolicyIpPoolResult]
func LookupPolicyIpPool(ctx *Context, args *LookupPolicyIpPoolArgs, opts ...InvokeOption) (*LookupPolicyIpPoolResult, error)
func LookupPolicyIpPoolOutput(ctx *Context, args *LookupPolicyIpPoolOutputArgs, opts ...InvokeOption) LookupPolicyIpPoolResultOutput
> Note: This function is named LookupPolicyIpPool
in the Go SDK.
public static class GetPolicyIpPool
{
public static Task<GetPolicyIpPoolResult> InvokeAsync(GetPolicyIpPoolArgs args, InvokeOptions? opts = null)
public static Output<GetPolicyIpPoolResult> Invoke(GetPolicyIpPoolInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPolicyIpPoolResult> getPolicyIpPool(GetPolicyIpPoolArgs args, InvokeOptions options)
public static Output<GetPolicyIpPoolResult> getPolicyIpPool(GetPolicyIpPoolArgs args, InvokeOptions options)
fn::invoke:
function: nsxt:index/getPolicyIpPool:getPolicyIpPool
arguments:
# arguments dictionary
The following arguments are supported:
- Context
Get
Policy Ip Pool Context - The context which the object belongs to
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of the IP Pool Config to retrieve.
- Id string
- The ID of IP Pool Config to retrieve.
- Context
Get
Policy Ip Pool Context - The context which the object belongs to
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of the IP Pool Config to retrieve.
- Id string
- The ID of IP Pool Config to retrieve.
- context
Get
Policy Ip Pool Context - The context which the object belongs to
- description String
- The description of the resource.
- display
Name String - The Display Name prefix of the IP Pool Config to retrieve.
- id String
- The ID of IP Pool Config to retrieve.
- context
Get
Policy Ip Pool Context - The context which the object belongs to
- description string
- The description of the resource.
- display
Name string - The Display Name prefix of the IP Pool Config to retrieve.
- id string
- The ID of IP Pool Config to retrieve.
- context
Get
Policy Ip Pool Context - The context which the object belongs to
- description str
- The description of the resource.
- display_
name str - The Display Name prefix of the IP Pool Config to retrieve.
- id str
- The ID of IP Pool Config to retrieve.
- context Property Map
- The context which the object belongs to
- description String
- The description of the resource.
- display
Name String - The Display Name prefix of the IP Pool Config to retrieve.
- id String
- The ID of IP Pool Config to retrieve.
getPolicyIpPool Result
The following output properties are available:
- Description string
- The description of the resource.
- Display
Name string - Id string
- Path string
- The NSX path of the policy resource.
- Realized
Id string - The id of realized pool object. This id should be used in
nsxt.EdgeTransportNode
resource. - Context
Get
Policy Ip Pool Context
- Description string
- The description of the resource.
- Display
Name string - Id string
- Path string
- The NSX path of the policy resource.
- Realized
Id string - The id of realized pool object. This id should be used in
nsxt.EdgeTransportNode
resource. - Context
Get
Policy Ip Pool Context
- description String
- The description of the resource.
- display
Name String - id String
- path String
- The NSX path of the policy resource.
- realized
Id String - The id of realized pool object. This id should be used in
nsxt.EdgeTransportNode
resource. - context
Get
Policy Ip Pool Context
- description string
- The description of the resource.
- display
Name string - id string
- path string
- The NSX path of the policy resource.
- realized
Id string - The id of realized pool object. This id should be used in
nsxt.EdgeTransportNode
resource. - context
Get
Policy Ip Pool Context
- description str
- The description of the resource.
- display_
name str - id str
- path str
- The NSX path of the policy resource.
- realized_
id str - The id of realized pool object. This id should be used in
nsxt.EdgeTransportNode
resource. - context
Get
Policy Ip Pool Context
- description String
- The description of the resource.
- display
Name String - id String
- path String
- The NSX path of the policy resource.
- realized
Id String - The id of realized pool object. This id should be used in
nsxt.EdgeTransportNode
resource. - context Property Map
Supporting Types
GetPolicyIpPoolContext
- Project
Id string - The ID of the project which the object belongs to
- Project
Id string - The ID of the project which the object belongs to
- project
Id String - The ID of the project which the object belongs to
- project
Id string - The ID of the project which the object belongs to
- project_
id str - The ID of the project which the object belongs to
- project
Id String - The ID of the project which the object belongs to
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxt
Terraform Provider.