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

nsxt.LogicalDhcpPort

Explore with Pulumi AI

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

    Create LogicalDhcpPort Resource

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

    Constructor syntax

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

@overload
def LogicalDhcpPort(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    dhcp_server_id: Optional[str] = None,
                    logical_switch_id: Optional[str] = None,
                    admin_state: Optional[str] = None,
                    description: Optional[str] = None,
                    display_name: Optional[str] = None,
                    logical_dhcp_port_id: Optional[str] = None,
                    tags: Optional[Sequence[LogicalDhcpPortTagArgs]] = None)
    func NewLogicalDhcpPort(ctx *Context, name string, args LogicalDhcpPortArgs, opts ...ResourceOption) (*LogicalDhcpPort, error)
    public LogicalDhcpPort(string name, LogicalDhcpPortArgs args, CustomResourceOptions? opts = null)
    public LogicalDhcpPort(String name, LogicalDhcpPortArgs args)
public LogicalDhcpPort(String name, LogicalDhcpPortArgs args, CustomResourceOptions options)

    type: nsxt:LogicalDhcpPort
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 LogicalDhcpPortArgs
    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 LogicalDhcpPortArgs
    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 LogicalDhcpPortArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogicalDhcpPortArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogicalDhcpPortArgs
    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 logicalDhcpPortResource = new Nsxt.LogicalDhcpPort("logicalDhcpPortResource", new()
{
    DhcpServerId = "string",
    LogicalSwitchId = "string",
    AdminState = "string",
    Description = "string",
    DisplayName = "string",
    LogicalDhcpPortId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.LogicalDhcpPortTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewLogicalDhcpPort(ctx, "logicalDhcpPortResource", &nsxt.LogicalDhcpPortArgs{
	DhcpServerId:      pulumi.String("string"),
	LogicalSwitchId:   pulumi.String("string"),
	AdminState:        pulumi.String("string"),
	Description:       pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	LogicalDhcpPortId: pulumi.String("string"),
	Tags: nsxt.LogicalDhcpPortTagArray{
		&nsxt.LogicalDhcpPortTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var logicalDhcpPortResource = new LogicalDhcpPort("logicalDhcpPortResource", LogicalDhcpPortArgs.builder()
    .dhcpServerId("string")
    .logicalSwitchId("string")
    .adminState("string")
    .description("string")
    .displayName("string")
    .logicalDhcpPortId("string")
    .tags(LogicalDhcpPortTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    logical_dhcp_port_resource = nsxt.LogicalDhcpPort("logicalDhcpPortResource",
    dhcp_server_id="string",
    logical_switch_id="string",
    admin_state="string",
    description="string",
    display_name="string",
    logical_dhcp_port_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const logicalDhcpPortResource = new nsxt.LogicalDhcpPort("logicalDhcpPortResource", {
    dhcpServerId: "string",
    logicalSwitchId: "string",
    adminState: "string",
    description: "string",
    displayName: "string",
    logicalDhcpPortId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:LogicalDhcpPort
properties:
    adminState: string
    description: string
    dhcpServerId: string
    displayName: string
    logicalDhcpPortId: string
    logicalSwitchId: string
    tags:
        - scope: string
          tag: string

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

    DhcpServerId string
    Logical DHCP server ID for the logical port.
    LogicalSwitchId string
    Logical switch ID for the logical port.
    AdminState string
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    Description string
    Description of this resource.
    DisplayName string
    Display name, defaults to ID if not set.
    LogicalDhcpPortId string
    ID of the logical DHCP port.
    Tags List<LogicalDhcpPortTag>
    A list of scope + tag pairs to associate with this logical port.
    DhcpServerId string
    Logical DHCP server ID for the logical port.
    LogicalSwitchId string
    Logical switch ID for the logical port.
    AdminState string
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    Description string
    Description of this resource.
    DisplayName string
    Display name, defaults to ID if not set.
    LogicalDhcpPortId string
    ID of the logical DHCP port.
    Tags []LogicalDhcpPortTagArgs
    A list of scope + tag pairs to associate with this logical port.
    dhcpServerId String
    Logical DHCP server ID for the logical port.
    logicalSwitchId String
    Logical switch ID for the logical port.
    adminState String
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description String
    Description of this resource.
    displayName String
    Display name, defaults to ID if not set.
    logicalDhcpPortId String
    ID of the logical DHCP port.
    tags List<LogicalDhcpPortTag>
    A list of scope + tag pairs to associate with this logical port.
    dhcpServerId string
    Logical DHCP server ID for the logical port.
    logicalSwitchId string
    Logical switch ID for the logical port.
    adminState string
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description string
    Description of this resource.
    displayName string
    Display name, defaults to ID if not set.
    logicalDhcpPortId string
    ID of the logical DHCP port.
    tags LogicalDhcpPortTag[]
    A list of scope + tag pairs to associate with this logical port.
    dhcp_server_id str
    Logical DHCP server ID for the logical port.
    logical_switch_id str
    Logical switch ID for the logical port.
    admin_state str
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description str
    Description of this resource.
    display_name str
    Display name, defaults to ID if not set.
    logical_dhcp_port_id str
    ID of the logical DHCP port.
    tags Sequence[LogicalDhcpPortTagArgs]
    A list of scope + tag pairs to associate with this logical port.
    dhcpServerId String
    Logical DHCP server ID for the logical port.
    logicalSwitchId String
    Logical switch ID for the logical port.
    adminState String
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description String
    Description of this resource.
    displayName String
    Display name, defaults to ID if not set.
    logicalDhcpPortId String
    ID of the logical DHCP port.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this logical port.

    Outputs

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

    Get an existing LogicalDhcpPort 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?: LogicalDhcpPortState, opts?: CustomResourceOptions): LogicalDhcpPort
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state: Optional[str] = None,
        description: Optional[str] = None,
        dhcp_server_id: Optional[str] = None,
        display_name: Optional[str] = None,
        logical_dhcp_port_id: Optional[str] = None,
        logical_switch_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[LogicalDhcpPortTagArgs]] = None) -> LogicalDhcpPort
    func GetLogicalDhcpPort(ctx *Context, name string, id IDInput, state *LogicalDhcpPortState, opts ...ResourceOption) (*LogicalDhcpPort, error)
    public static LogicalDhcpPort Get(string name, Input<string> id, LogicalDhcpPortState? state, CustomResourceOptions? opts = null)
    public static LogicalDhcpPort get(String name, Output<String> id, LogicalDhcpPortState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:LogicalDhcpPort    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:
    AdminState string
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    Description string
    Description of this resource.
    DhcpServerId string
    Logical DHCP server ID for the logical port.
    DisplayName string
    Display name, defaults to ID if not set.
    LogicalDhcpPortId string
    ID of the logical DHCP port.
    LogicalSwitchId string
    Logical switch ID for the logical port.
    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<LogicalDhcpPortTag>
    A list of scope + tag pairs to associate with this logical port.
    AdminState string
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    Description string
    Description of this resource.
    DhcpServerId string
    Logical DHCP server ID for the logical port.
    DisplayName string
    Display name, defaults to ID if not set.
    LogicalDhcpPortId string
    ID of the logical DHCP port.
    LogicalSwitchId string
    Logical switch ID for the logical port.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []LogicalDhcpPortTagArgs
    A list of scope + tag pairs to associate with this logical port.
    adminState String
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description String
    Description of this resource.
    dhcpServerId String
    Logical DHCP server ID for the logical port.
    displayName String
    Display name, defaults to ID if not set.
    logicalDhcpPortId String
    ID of the logical DHCP port.
    logicalSwitchId String
    Logical switch ID for the logical port.
    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<LogicalDhcpPortTag>
    A list of scope + tag pairs to associate with this logical port.
    adminState string
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description string
    Description of this resource.
    dhcpServerId string
    Logical DHCP server ID for the logical port.
    displayName string
    Display name, defaults to ID if not set.
    logicalDhcpPortId string
    ID of the logical DHCP port.
    logicalSwitchId string
    Logical switch ID for the logical port.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags LogicalDhcpPortTag[]
    A list of scope + tag pairs to associate with this logical port.
    admin_state str
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description str
    Description of this resource.
    dhcp_server_id str
    Logical DHCP server ID for the logical port.
    display_name str
    Display name, defaults to ID if not set.
    logical_dhcp_port_id str
    ID of the logical DHCP port.
    logical_switch_id str
    Logical switch ID for the logical port.
    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[LogicalDhcpPortTagArgs]
    A list of scope + tag pairs to associate with this logical port.
    adminState String
    Admin state for the logical port. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description String
    Description of this resource.
    dhcpServerId String
    Logical DHCP server ID for the logical port.
    displayName String
    Display name, defaults to ID if not set.
    logicalDhcpPortId String
    ID of the logical DHCP port.
    logicalSwitchId String
    Logical switch ID for the logical port.
    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 logical port.

    Supporting Types

    LogicalDhcpPortTag, LogicalDhcpPortTagArgs

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

    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