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

nsxt.DhcpRelayService

Explore with Pulumi AI

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

Create DhcpRelayService Resource

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

Constructor syntax

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

@overload
def DhcpRelayService(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     dhcp_relay_profile_id: Optional[str] = None,
                     description: Optional[str] = None,
                     dhcp_relay_service_id: Optional[str] = None,
                     display_name: Optional[str] = None,
                     tags: Optional[Sequence[DhcpRelayServiceTagArgs]] = None)
func NewDhcpRelayService(ctx *Context, name string, args DhcpRelayServiceArgs, opts ...ResourceOption) (*DhcpRelayService, error)
public DhcpRelayService(string name, DhcpRelayServiceArgs args, CustomResourceOptions? opts = null)
public DhcpRelayService(String name, DhcpRelayServiceArgs args)
public DhcpRelayService(String name, DhcpRelayServiceArgs args, CustomResourceOptions options)

type: nsxt:DhcpRelayService
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. DhcpRelayServiceArgs
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. DhcpRelayServiceArgs
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. DhcpRelayServiceArgs
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. DhcpRelayServiceArgs
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. DhcpRelayServiceArgs
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 dhcpRelayServiceResource = new Nsxt.DhcpRelayService("dhcpRelayServiceResource", new()
{
    DhcpRelayProfileId = "string",
    Description = "string",
    DhcpRelayServiceId = "string",
    DisplayName = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.DhcpRelayServiceTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});
Copy
example, err := nsxt.NewDhcpRelayService(ctx, "dhcpRelayServiceResource", &nsxt.DhcpRelayServiceArgs{
DhcpRelayProfileId: pulumi.String("string"),
Description: pulumi.String("string"),
DhcpRelayServiceId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Tags: .DhcpRelayServiceTagArray{
&.DhcpRelayServiceTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
Copy
var dhcpRelayServiceResource = new DhcpRelayService("dhcpRelayServiceResource", DhcpRelayServiceArgs.builder()
    .dhcpRelayProfileId("string")
    .description("string")
    .dhcpRelayServiceId("string")
    .displayName("string")
    .tags(DhcpRelayServiceTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());
Copy
dhcp_relay_service_resource = nsxt.DhcpRelayService("dhcpRelayServiceResource",
    dhcp_relay_profile_id="string",
    description="string",
    dhcp_relay_service_id="string",
    display_name="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])
Copy
const dhcpRelayServiceResource = new nsxt.DhcpRelayService("dhcpRelayServiceResource", {
    dhcpRelayProfileId: "string",
    description: "string",
    dhcpRelayServiceId: "string",
    displayName: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});
Copy
type: nsxt:DhcpRelayService
properties:
    description: string
    dhcpRelayProfileId: string
    dhcpRelayServiceId: string
    displayName: string
    tags:
        - scope: string
          tag: string
Copy

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

DhcpRelayProfileId This property is required. string
DHCP relay profile referenced by the DHCP relay service.
Description string
Description of this resource.
DhcpRelayServiceId string
ID of the DHCP relay service.
DisplayName string
The display name of this resource. Defaults to ID if not set.
Tags List<DhcpRelayServiceTag>
A list of scope + tag pairs to associate with this dhcp_relay_service.
DhcpRelayProfileId This property is required. string
DHCP relay profile referenced by the DHCP relay service.
Description string
Description of this resource.
DhcpRelayServiceId string
ID of the DHCP relay service.
DisplayName string
The display name of this resource. Defaults to ID if not set.
Tags []DhcpRelayServiceTagArgs
A list of scope + tag pairs to associate with this dhcp_relay_service.
dhcpRelayProfileId This property is required. String
DHCP relay profile referenced by the DHCP relay service.
description String
Description of this resource.
dhcpRelayServiceId String
ID of the DHCP relay service.
displayName String
The display name of this resource. Defaults to ID if not set.
tags List<DhcpRelayServiceTag>
A list of scope + tag pairs to associate with this dhcp_relay_service.
dhcpRelayProfileId This property is required. string
DHCP relay profile referenced by the DHCP relay service.
description string
Description of this resource.
dhcpRelayServiceId string
ID of the DHCP relay service.
displayName string
The display name of this resource. Defaults to ID if not set.
tags DhcpRelayServiceTag[]
A list of scope + tag pairs to associate with this dhcp_relay_service.
dhcp_relay_profile_id This property is required. str
DHCP relay profile referenced by the DHCP relay service.
description str
Description of this resource.
dhcp_relay_service_id str
ID of the DHCP relay service.
display_name str
The display name of this resource. Defaults to ID if not set.
tags Sequence[DhcpRelayServiceTagArgs]
A list of scope + tag pairs to associate with this dhcp_relay_service.
dhcpRelayProfileId This property is required. String
DHCP relay profile referenced by the DHCP relay service.
description String
Description of this resource.
dhcpRelayServiceId String
ID of the DHCP relay service.
displayName String
The display name of this resource. Defaults to ID if not set.
tags List<Property Map>
A list of scope + tag pairs to associate with this dhcp_relay_service.

Outputs

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

Get an existing DhcpRelayService 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?: DhcpRelayServiceState, opts?: CustomResourceOptions): DhcpRelayService
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        dhcp_relay_profile_id: Optional[str] = None,
        dhcp_relay_service_id: Optional[str] = None,
        display_name: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[DhcpRelayServiceTagArgs]] = None) -> DhcpRelayService
func GetDhcpRelayService(ctx *Context, name string, id IDInput, state *DhcpRelayServiceState, opts ...ResourceOption) (*DhcpRelayService, error)
public static DhcpRelayService Get(string name, Input<string> id, DhcpRelayServiceState? state, CustomResourceOptions? opts = null)
public static DhcpRelayService get(String name, Output<String> id, DhcpRelayServiceState state, CustomResourceOptions options)
resources:  _:    type: nsxt:DhcpRelayService    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.
DhcpRelayProfileId string
DHCP relay profile referenced by the DHCP relay service.
DhcpRelayServiceId string
ID of the DHCP relay service.
DisplayName string
The display name of this resource. Defaults to ID if not set.
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<DhcpRelayServiceTag>
A list of scope + tag pairs to associate with this dhcp_relay_service.
Description string
Description of this resource.
DhcpRelayProfileId string
DHCP relay profile referenced by the DHCP relay service.
DhcpRelayServiceId string
ID of the DHCP relay service.
DisplayName string
The display name of this resource. Defaults to ID if not set.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Tags []DhcpRelayServiceTagArgs
A list of scope + tag pairs to associate with this dhcp_relay_service.
description String
Description of this resource.
dhcpRelayProfileId String
DHCP relay profile referenced by the DHCP relay service.
dhcpRelayServiceId String
ID of the DHCP relay service.
displayName String
The display name of this resource. Defaults to ID if not set.
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<DhcpRelayServiceTag>
A list of scope + tag pairs to associate with this dhcp_relay_service.
description string
Description of this resource.
dhcpRelayProfileId string
DHCP relay profile referenced by the DHCP relay service.
dhcpRelayServiceId string
ID of the DHCP relay service.
displayName string
The display name of this resource. Defaults to ID if not set.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags DhcpRelayServiceTag[]
A list of scope + tag pairs to associate with this dhcp_relay_service.
description str
Description of this resource.
dhcp_relay_profile_id str
DHCP relay profile referenced by the DHCP relay service.
dhcp_relay_service_id str
ID of the DHCP relay service.
display_name str
The display name of this resource. Defaults to ID if not set.
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[DhcpRelayServiceTagArgs]
A list of scope + tag pairs to associate with this dhcp_relay_service.
description String
Description of this resource.
dhcpRelayProfileId String
DHCP relay profile referenced by the DHCP relay service.
dhcpRelayServiceId String
ID of the DHCP relay service.
displayName String
The display name of this resource. Defaults to ID if not set.
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_relay_service.

Supporting Types

DhcpRelayServiceTag
, DhcpRelayServiceTagArgs

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

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