Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. DhcpServerProfile
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.DhcpServerProfile

Explore with Pulumi AI

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

Create DhcpServerProfile Resource

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

Constructor syntax

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

@overload
def DhcpServerProfile(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      edge_cluster_id: Optional[str] = None,
                      description: Optional[str] = None,
                      dhcp_server_profile_id: Optional[str] = None,
                      display_name: Optional[str] = None,
                      edge_cluster_member_indexes: Optional[Sequence[float]] = None,
                      tags: Optional[Sequence[DhcpServerProfileTagArgs]] = None)
func NewDhcpServerProfile(ctx *Context, name string, args DhcpServerProfileArgs, opts ...ResourceOption) (*DhcpServerProfile, error)
public DhcpServerProfile(string name, DhcpServerProfileArgs args, CustomResourceOptions? opts = null)
public DhcpServerProfile(String name, DhcpServerProfileArgs args)
public DhcpServerProfile(String name, DhcpServerProfileArgs args, CustomResourceOptions options)

type: nsxt:DhcpServerProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DhcpServerProfileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DhcpServerProfileArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DhcpServerProfileArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DhcpServerProfileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DhcpServerProfileArgs
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 dhcpServerProfileResource = new Nsxt.DhcpServerProfile("dhcpServerProfileResource", new()
{
    EdgeClusterId = "string",
    Description = "string",
    DhcpServerProfileId = "string",
    DisplayName = "string",
    EdgeClusterMemberIndexes = new[]
    {
        0,
    },
    Tags = new[]
    {
        new Nsxt.Inputs.DhcpServerProfileTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});
Copy
example, err := nsxt.NewDhcpServerProfile(ctx, "dhcpServerProfileResource", &nsxt.DhcpServerProfileArgs{
EdgeClusterId: pulumi.String("string"),
Description: pulumi.String("string"),
DhcpServerProfileId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
EdgeClusterMemberIndexes: pulumi.Float64Array{
pulumi.Float64(0),
},
Tags: .DhcpServerProfileTagArray{
&.DhcpServerProfileTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
Copy
var dhcpServerProfileResource = new DhcpServerProfile("dhcpServerProfileResource", DhcpServerProfileArgs.builder()
    .edgeClusterId("string")
    .description("string")
    .dhcpServerProfileId("string")
    .displayName("string")
    .edgeClusterMemberIndexes(0)
    .tags(DhcpServerProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());
Copy
dhcp_server_profile_resource = nsxt.DhcpServerProfile("dhcpServerProfileResource",
    edge_cluster_id="string",
    description="string",
    dhcp_server_profile_id="string",
    display_name="string",
    edge_cluster_member_indexes=[0],
    tags=[{
        "scope": "string",
        "tag": "string",
    }])
Copy
const dhcpServerProfileResource = new nsxt.DhcpServerProfile("dhcpServerProfileResource", {
    edgeClusterId: "string",
    description: "string",
    dhcpServerProfileId: "string",
    displayName: "string",
    edgeClusterMemberIndexes: [0],
    tags: [{
        scope: "string",
        tag: "string",
    }],
});
Copy
type: nsxt:DhcpServerProfile
properties:
    description: string
    dhcpServerProfileId: string
    displayName: string
    edgeClusterId: string
    edgeClusterMemberIndexes:
        - 0
    tags:
        - scope: string
          tag: string
Copy

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

EdgeClusterId This property is required. string
Edge cluster uuid.
Description string
Description of this resource.
DhcpServerProfileId string
ID of the DHCP server profile.
DisplayName string
The display name of this resource. Defaults to ID if not set.
EdgeClusterMemberIndexes List<double>
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
Tags List<DhcpServerProfileTag>
A list of scope + tag pairs to associate with this DHCP profile.
EdgeClusterId This property is required. string
Edge cluster uuid.
Description string
Description of this resource.
DhcpServerProfileId string
ID of the DHCP server profile.
DisplayName string
The display name of this resource. Defaults to ID if not set.
EdgeClusterMemberIndexes []float64
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
Tags []DhcpServerProfileTagArgs
A list of scope + tag pairs to associate with this DHCP profile.
edgeClusterId This property is required. String
Edge cluster uuid.
description String
Description of this resource.
dhcpServerProfileId String
ID of the DHCP server profile.
displayName String
The display name of this resource. Defaults to ID if not set.
edgeClusterMemberIndexes List<Double>
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
tags List<DhcpServerProfileTag>
A list of scope + tag pairs to associate with this DHCP profile.
edgeClusterId This property is required. string
Edge cluster uuid.
description string
Description of this resource.
dhcpServerProfileId string
ID of the DHCP server profile.
displayName string
The display name of this resource. Defaults to ID if not set.
edgeClusterMemberIndexes number[]
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
tags DhcpServerProfileTag[]
A list of scope + tag pairs to associate with this DHCP profile.
edge_cluster_id This property is required. str
Edge cluster uuid.
description str
Description of this resource.
dhcp_server_profile_id str
ID of the DHCP server profile.
display_name str
The display name of this resource. Defaults to ID if not set.
edge_cluster_member_indexes Sequence[float]
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
tags Sequence[DhcpServerProfileTagArgs]
A list of scope + tag pairs to associate with this DHCP profile.
edgeClusterId This property is required. String
Edge cluster uuid.
description String
Description of this resource.
dhcpServerProfileId String
ID of the DHCP server profile.
displayName String
The display name of this resource. Defaults to ID if not set.
edgeClusterMemberIndexes List<Number>
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
tags List<Property Map>
A list of scope + tag pairs to associate with this DHCP profile.

Outputs

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

Get an existing DhcpServerProfile 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?: DhcpServerProfileState, opts?: CustomResourceOptions): DhcpServerProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        dhcp_server_profile_id: Optional[str] = None,
        display_name: Optional[str] = None,
        edge_cluster_id: Optional[str] = None,
        edge_cluster_member_indexes: Optional[Sequence[float]] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[DhcpServerProfileTagArgs]] = None) -> DhcpServerProfile
func GetDhcpServerProfile(ctx *Context, name string, id IDInput, state *DhcpServerProfileState, opts ...ResourceOption) (*DhcpServerProfile, error)
public static DhcpServerProfile Get(string name, Input<string> id, DhcpServerProfileState? state, CustomResourceOptions? opts = null)
public static DhcpServerProfile get(String name, Output<String> id, DhcpServerProfileState state, CustomResourceOptions options)
resources:  _:    type: nsxt:DhcpServerProfile    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
DhcpServerProfileId string
ID of the DHCP server profile.
DisplayName string
The display name of this resource. Defaults to ID if not set.
EdgeClusterId string
Edge cluster uuid.
EdgeClusterMemberIndexes List<double>
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Tags List<DhcpServerProfileTag>
A list of scope + tag pairs to associate with this DHCP profile.
Description string
Description of this resource.
DhcpServerProfileId string
ID of the DHCP server profile.
DisplayName string
The display name of this resource. Defaults to ID if not set.
EdgeClusterId string
Edge cluster uuid.
EdgeClusterMemberIndexes []float64
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Tags []DhcpServerProfileTagArgs
A list of scope + tag pairs to associate with this DHCP profile.
description String
Description of this resource.
dhcpServerProfileId String
ID of the DHCP server profile.
displayName String
The display name of this resource. Defaults to ID if not set.
edgeClusterId String
Edge cluster uuid.
edgeClusterMemberIndexes List<Double>
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags List<DhcpServerProfileTag>
A list of scope + tag pairs to associate with this DHCP profile.
description string
Description of this resource.
dhcpServerProfileId string
ID of the DHCP server profile.
displayName string
The display name of this resource. Defaults to ID if not set.
edgeClusterId string
Edge cluster uuid.
edgeClusterMemberIndexes number[]
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags DhcpServerProfileTag[]
A list of scope + tag pairs to associate with this DHCP profile.
description str
Description of this resource.
dhcp_server_profile_id str
ID of the DHCP server profile.
display_name str
The display name of this resource. Defaults to ID if not set.
edge_cluster_id str
Edge cluster uuid.
edge_cluster_member_indexes Sequence[float]
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags Sequence[DhcpServerProfileTagArgs]
A list of scope + tag pairs to associate with this DHCP profile.
description String
Description of this resource.
dhcpServerProfileId String
ID of the DHCP server profile.
displayName String
The display name of this resource. Defaults to ID if not set.
edgeClusterId String
Edge cluster uuid.
edgeClusterMemberIndexes List<Number>
Up to 2 edge nodes from the given cluster. If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags List<Property Map>
A list of scope + tag pairs to associate with this DHCP profile.

Supporting Types

DhcpServerProfileTag
, DhcpServerProfileTagArgs

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

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt