nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
nsxt.getPolicyDhcpServer
Explore with Pulumi AI
This data source provides information about policy DHCP servers configured on NSX.
This data source is applicable to NSX Policy Manager, NSX Global Manager and VMC.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";
const test = nsxt.getPolicyDhcpServer({
displayName: "dhcp-2",
});
import pulumi
import pulumi_nsxt as nsxt
test = nsxt.get_policy_dhcp_server(display_name="dhcp-2")
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.LookupPolicyDhcpServer(ctx, &nsxt.LookupPolicyDhcpServerArgs{
DisplayName: pulumi.StringRef("dhcp-2"),
}, 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.GetPolicyDhcpServer.Invoke(new()
{
DisplayName = "dhcp-2",
});
});
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.GetPolicyDhcpServerArgs;
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.getPolicyDhcpServer(GetPolicyDhcpServerArgs.builder()
.displayName("dhcp-2")
.build());
}
}
variables:
test:
fn::invoke:
function: nsxt:getPolicyDhcpServer
arguments:
displayName: dhcp-2
Multi-Tenancy
import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";
const demoproj = nsxt.getPolicyProject({
displayName: "demoproj",
});
const demodhcp = demoproj.then(demoproj => nsxt.getPolicyDhcpServer({
context: {
projectId: demoproj.id,
},
displayName: "demodhcp",
}));
import pulumi
import pulumi_nsxt as nsxt
demoproj = nsxt.get_policy_project(display_name="demoproj")
demodhcp = nsxt.get_policy_dhcp_server(context={
"project_id": demoproj.id,
},
display_name="demodhcp")
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.LookupPolicyDhcpServer(ctx, &nsxt.LookupPolicyDhcpServerArgs{
Context: nsxt.GetPolicyDhcpServerContext{
ProjectId: demoproj.Id,
},
DisplayName: pulumi.StringRef("demodhcp"),
}, 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 demodhcp = Nsxt.GetPolicyDhcpServer.Invoke(new()
{
Context = new Nsxt.Inputs.GetPolicyDhcpServerContextInputArgs
{
ProjectId = demoproj.Apply(getPolicyProjectResult => getPolicyProjectResult.Id),
},
DisplayName = "demodhcp",
});
});
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.GetPolicyDhcpServerArgs;
import com.pulumi.nsxt.inputs.GetPolicyDhcpServerContextArgs;
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 demodhcp = NsxtFunctions.getPolicyDhcpServer(GetPolicyDhcpServerArgs.builder()
.context(GetPolicyDhcpServerContextArgs.builder()
.projectId(demoproj.applyValue(getPolicyProjectResult -> getPolicyProjectResult.id()))
.build())
.displayName("demodhcp")
.build());
}
}
variables:
demoproj:
fn::invoke:
function: nsxt:getPolicyProject
arguments:
displayName: demoproj
demodhcp:
fn::invoke:
function: nsxt:getPolicyDhcpServer
arguments:
context:
projectId: ${demoproj.id}
displayName: demodhcp
Using getPolicyDhcpServer
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 getPolicyDhcpServer(args: GetPolicyDhcpServerArgs, opts?: InvokeOptions): Promise<GetPolicyDhcpServerResult>
function getPolicyDhcpServerOutput(args: GetPolicyDhcpServerOutputArgs, opts?: InvokeOptions): Output<GetPolicyDhcpServerResult>
def get_policy_dhcp_server(context: Optional[GetPolicyDhcpServerContext] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPolicyDhcpServerResult
def get_policy_dhcp_server_output(context: Optional[pulumi.Input[GetPolicyDhcpServerContextArgs]] = 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[GetPolicyDhcpServerResult]
func LookupPolicyDhcpServer(ctx *Context, args *LookupPolicyDhcpServerArgs, opts ...InvokeOption) (*LookupPolicyDhcpServerResult, error)
func LookupPolicyDhcpServerOutput(ctx *Context, args *LookupPolicyDhcpServerOutputArgs, opts ...InvokeOption) LookupPolicyDhcpServerResultOutput
> Note: This function is named LookupPolicyDhcpServer
in the Go SDK.
public static class GetPolicyDhcpServer
{
public static Task<GetPolicyDhcpServerResult> InvokeAsync(GetPolicyDhcpServerArgs args, InvokeOptions? opts = null)
public static Output<GetPolicyDhcpServerResult> Invoke(GetPolicyDhcpServerInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPolicyDhcpServerResult> getPolicyDhcpServer(GetPolicyDhcpServerArgs args, InvokeOptions options)
public static Output<GetPolicyDhcpServerResult> getPolicyDhcpServer(GetPolicyDhcpServerArgs args, InvokeOptions options)
fn::invoke:
function: nsxt:index/getPolicyDhcpServer:getPolicyDhcpServer
arguments:
# arguments dictionary
The following arguments are supported:
- Context
Get
Policy Dhcp Server Context - The context which the object belongs to
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of DHCP server to retrieve.
- Id string
- The ID of DHCP Server to retrieve. If ID is specified, no additional argument should be configured.
- Context
Get
Policy Dhcp Server Context - The context which the object belongs to
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of DHCP server to retrieve.
- Id string
- The ID of DHCP Server to retrieve. If ID is specified, no additional argument should be configured.
- context
Get
Policy Dhcp Server Context - The context which the object belongs to
- description String
- The description of the resource.
- display
Name String - The Display Name prefix of DHCP server to retrieve.
- id String
- The ID of DHCP Server to retrieve. If ID is specified, no additional argument should be configured.
- context
Get
Policy Dhcp Server Context - The context which the object belongs to
- description string
- The description of the resource.
- display
Name string - The Display Name prefix of DHCP server to retrieve.
- id string
- The ID of DHCP Server to retrieve. If ID is specified, no additional argument should be configured.
- context
Get
Policy Dhcp Server Context - The context which the object belongs to
- description str
- The description of the resource.
- display_
name str - The Display Name prefix of DHCP server to retrieve.
- id str
- The ID of DHCP Server to retrieve. If ID is specified, no additional argument should be configured.
- 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 DHCP server to retrieve.
- id String
- The ID of DHCP Server to retrieve. If ID is specified, no additional argument should be configured.
getPolicyDhcpServer 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.
- Context
Get
Policy Dhcp Server Context
- Description string
- The description of the resource.
- Display
Name string - Id string
- Path string
- The NSX path of the policy resource.
- Context
Get
Policy Dhcp Server Context
- description String
- The description of the resource.
- display
Name String - id String
- path String
- The NSX path of the policy resource.
- context
Get
Policy Dhcp Server Context
- description string
- The description of the resource.
- display
Name string - id string
- path string
- The NSX path of the policy resource.
- context
Get
Policy Dhcp Server Context
- description str
- The description of the resource.
- display_
name str - id str
- path str
- The NSX path of the policy resource.
- context
Get
Policy Dhcp Server Context
- description String
- The description of the resource.
- display
Name String - id String
- path String
- The NSX path of the policy resource.
- context Property Map
Supporting Types
GetPolicyDhcpServerContext
- 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.