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

nsxt.PolicyDhcpServer

Explore with Pulumi AI

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

    Create PolicyDhcpServer Resource

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

    Constructor syntax

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

@overload
def PolicyDhcpServer(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     display_name: Optional[str] = None,
                     context: Optional[PolicyDhcpServerContextArgs] = None,
                     description: Optional[str] = None,
                     edge_cluster_path: Optional[str] = None,
                     lease_time: Optional[float] = None,
                     nsx_id: Optional[str] = None,
                     policy_dhcp_server_id: Optional[str] = None,
                     preferred_edge_paths: Optional[Sequence[str]] = None,
                     server_addresses: Optional[Sequence[str]] = None,
                     tags: Optional[Sequence[PolicyDhcpServerTagArgs]] = None)
    func NewPolicyDhcpServer(ctx *Context, name string, args PolicyDhcpServerArgs, opts ...ResourceOption) (*PolicyDhcpServer, error)
    public PolicyDhcpServer(string name, PolicyDhcpServerArgs args, CustomResourceOptions? opts = null)
    public PolicyDhcpServer(String name, PolicyDhcpServerArgs args)
public PolicyDhcpServer(String name, PolicyDhcpServerArgs args, CustomResourceOptions options)

    type: nsxt:PolicyDhcpServer
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 PolicyDhcpServerArgs
    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 PolicyDhcpServerArgs
    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 PolicyDhcpServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyDhcpServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyDhcpServerArgs
    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 policyDhcpServerResource = new Nsxt.PolicyDhcpServer("policyDhcpServerResource", new()
{
    DisplayName = "string",
    Context = new Nsxt.Inputs.PolicyDhcpServerContextArgs
    {
        ProjectId = "string",
    },
    Description = "string",
    EdgeClusterPath = "string",
    LeaseTime = 0,
    NsxId = "string",
    PolicyDhcpServerId = "string",
    PreferredEdgePaths = new[]
    {
        "string",
    },
    ServerAddresses = new[]
    {
        "string",
    },
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyDhcpServerTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyDhcpServer(ctx, "policyDhcpServerResource", &nsxt.PolicyDhcpServerArgs{
	DisplayName: pulumi.String("string"),
	Context: &nsxt.PolicyDhcpServerContextArgs{
		ProjectId: pulumi.String("string"),
	},
	Description:        pulumi.String("string"),
	EdgeClusterPath:    pulumi.String("string"),
	LeaseTime:          pulumi.Float64(0),
	NsxId:              pulumi.String("string"),
	PolicyDhcpServerId: pulumi.String("string"),
	PreferredEdgePaths: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServerAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: nsxt.PolicyDhcpServerTagArray{
		&nsxt.PolicyDhcpServerTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyDhcpServerResource = new PolicyDhcpServer("policyDhcpServerResource", PolicyDhcpServerArgs.builder()
    .displayName("string")
    .context(PolicyDhcpServerContextArgs.builder()
        .projectId("string")
        .build())
    .description("string")
    .edgeClusterPath("string")
    .leaseTime(0)
    .nsxId("string")
    .policyDhcpServerId("string")
    .preferredEdgePaths("string")
    .serverAddresses("string")
    .tags(PolicyDhcpServerTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_dhcp_server_resource = nsxt.PolicyDhcpServer("policyDhcpServerResource",
    display_name="string",
    context={
        "project_id": "string",
    },
    description="string",
    edge_cluster_path="string",
    lease_time=0,
    nsx_id="string",
    policy_dhcp_server_id="string",
    preferred_edge_paths=["string"],
    server_addresses=["string"],
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyDhcpServerResource = new nsxt.PolicyDhcpServer("policyDhcpServerResource", {
    displayName: "string",
    context: {
        projectId: "string",
    },
    description: "string",
    edgeClusterPath: "string",
    leaseTime: 0,
    nsxId: "string",
    policyDhcpServerId: "string",
    preferredEdgePaths: ["string"],
    serverAddresses: ["string"],
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyDhcpServer
properties:
    context:
        projectId: string
    description: string
    displayName: string
    edgeClusterPath: string
    leaseTime: 0
    nsxId: string
    policyDhcpServerId: string
    preferredEdgePaths:
        - string
    serverAddresses:
        - string
    tags:
        - scope: string
          tag: string

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

    DisplayName string
    Display name of the resource.
    Context PolicyDhcpServerContext
    The context which the object belongs to
    Description string
    Description of the resource.
    EdgeClusterPath string
    The Policy path to the edge cluster for this DHCP Server.
    LeaseTime double
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyDhcpServerId string
    ID of the resource.
    PreferredEdgePaths List<string>
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    ServerAddresses List<string>
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    Tags List<PolicyDhcpServerTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    Context PolicyDhcpServerContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    EdgeClusterPath string
    The Policy path to the edge cluster for this DHCP Server.
    LeaseTime float64
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyDhcpServerId string
    ID of the resource.
    PreferredEdgePaths []string
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    ServerAddresses []string
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    Tags []PolicyDhcpServerTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    context PolicyDhcpServerContext
    The context which the object belongs to
    description String
    Description of the resource.
    edgeClusterPath String
    The Policy path to the edge cluster for this DHCP Server.
    leaseTime Double
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyDhcpServerId String
    ID of the resource.
    preferredEdgePaths List<String>
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    serverAddresses List<String>
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    tags List<PolicyDhcpServerTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    context PolicyDhcpServerContext
    The context which the object belongs to
    description string
    Description of the resource.
    edgeClusterPath string
    The Policy path to the edge cluster for this DHCP Server.
    leaseTime number
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyDhcpServerId string
    ID of the resource.
    preferredEdgePaths string[]
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    serverAddresses string[]
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    tags PolicyDhcpServerTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    context PolicyDhcpServerContextArgs
    The context which the object belongs to
    description str
    Description of the resource.
    edge_cluster_path str
    The Policy path to the edge cluster for this DHCP Server.
    lease_time float
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_dhcp_server_id str
    ID of the resource.
    preferred_edge_paths Sequence[str]
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    server_addresses Sequence[str]
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    tags Sequence[PolicyDhcpServerTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    context Property Map
    The context which the object belongs to
    description String
    Description of the resource.
    edgeClusterPath String
    The Policy path to the edge cluster for this DHCP Server.
    leaseTime Number
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyDhcpServerId String
    ID of the resource.
    preferredEdgePaths List<String>
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    serverAddresses List<String>
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PolicyDhcpServer 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 PolicyDhcpServer Resource

    Get an existing PolicyDhcpServer 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?: PolicyDhcpServerState, opts?: CustomResourceOptions): PolicyDhcpServer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        context: Optional[PolicyDhcpServerContextArgs] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        edge_cluster_path: Optional[str] = None,
        lease_time: Optional[float] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_dhcp_server_id: Optional[str] = None,
        preferred_edge_paths: Optional[Sequence[str]] = None,
        revision: Optional[float] = None,
        server_addresses: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[PolicyDhcpServerTagArgs]] = None) -> PolicyDhcpServer
    func GetPolicyDhcpServer(ctx *Context, name string, id IDInput, state *PolicyDhcpServerState, opts ...ResourceOption) (*PolicyDhcpServer, error)
    public static PolicyDhcpServer Get(string name, Input<string> id, PolicyDhcpServerState? state, CustomResourceOptions? opts = null)
    public static PolicyDhcpServer get(String name, Output<String> id, PolicyDhcpServerState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyDhcpServer    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:
    Context PolicyDhcpServerContext
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    EdgeClusterPath string
    The Policy path to the edge cluster for this DHCP Server.
    LeaseTime double
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    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.
    PolicyDhcpServerId string
    ID of the resource.
    PreferredEdgePaths List<string>
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    ServerAddresses List<string>
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    Tags List<PolicyDhcpServerTag>
    A list of scope + tag pairs to associate with this resource.
    Context PolicyDhcpServerContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    EdgeClusterPath string
    The Policy path to the edge cluster for this DHCP Server.
    LeaseTime float64
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    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.
    PolicyDhcpServerId string
    ID of the resource.
    PreferredEdgePaths []string
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    ServerAddresses []string
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    Tags []PolicyDhcpServerTagArgs
    A list of scope + tag pairs to associate with this resource.
    context PolicyDhcpServerContext
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    edgeClusterPath String
    The Policy path to the edge cluster for this DHCP Server.
    leaseTime Double
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    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.
    policyDhcpServerId String
    ID of the resource.
    preferredEdgePaths List<String>
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    serverAddresses List<String>
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    tags List<PolicyDhcpServerTag>
    A list of scope + tag pairs to associate with this resource.
    context PolicyDhcpServerContext
    The context which the object belongs to
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    edgeClusterPath string
    The Policy path to the edge cluster for this DHCP Server.
    leaseTime number
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    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.
    policyDhcpServerId string
    ID of the resource.
    preferredEdgePaths string[]
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    serverAddresses string[]
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    tags PolicyDhcpServerTag[]
    A list of scope + tag pairs to associate with this resource.
    context PolicyDhcpServerContextArgs
    The context which the object belongs to
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    edge_cluster_path str
    The Policy path to the edge cluster for this DHCP Server.
    lease_time float
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    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.
    policy_dhcp_server_id str
    ID of the resource.
    preferred_edge_paths Sequence[str]
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    server_addresses Sequence[str]
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    tags Sequence[PolicyDhcpServerTagArgs]
    A list of scope + tag pairs to associate with this resource.
    context Property Map
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    edgeClusterPath String
    The Policy path to the edge cluster for this DHCP Server.
    leaseTime Number
    IP address lease time in seconds. Valid values from 60 to 4294967295. Default is 86400.
    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.
    policyDhcpServerId String
    ID of the resource.
    preferredEdgePaths List<String>
    Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    serverAddresses List<String>
    DHCP server address in CIDR format. At most 2 supported; one IPv4 and one IPv6 address. Server address can also be specified on segment subnet level.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PolicyDhcpServerContext, PolicyDhcpServerContextArgs

    ProjectId string
    The ID of the project which the object belongs to
    ProjectId string
    The ID of the project which the object belongs to
    projectId String
    The ID of the project which the object belongs to
    projectId string
    The ID of the project which the object belongs to
    project_id str
    The ID of the project which the object belongs to
    projectId String
    The ID of the project which the object belongs to

    PolicyDhcpServerTag, PolicyDhcpServerTagArgs

    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.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt