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

nsxt.DhcpRelayProfile

Explore with Pulumi AI

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

    Create DhcpRelayProfile Resource

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

    Constructor syntax

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

@overload
def DhcpRelayProfile(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     server_addresses: Optional[Sequence[str]] = None,
                     description: Optional[str] = None,
                     dhcp_relay_profile_id: Optional[str] = None,
                     display_name: Optional[str] = None,
                     tags: Optional[Sequence[DhcpRelayProfileTagArgs]] = None)
    func NewDhcpRelayProfile(ctx *Context, name string, args DhcpRelayProfileArgs, opts ...ResourceOption) (*DhcpRelayProfile, error)
    public DhcpRelayProfile(string name, DhcpRelayProfileArgs args, CustomResourceOptions? opts = null)
    public DhcpRelayProfile(String name, DhcpRelayProfileArgs args)
public DhcpRelayProfile(String name, DhcpRelayProfileArgs args, CustomResourceOptions options)

    type: nsxt:DhcpRelayProfile
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 DhcpRelayProfileArgs
    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 DhcpRelayProfileArgs
    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 DhcpRelayProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DhcpRelayProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DhcpRelayProfileArgs
    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 dhcpRelayProfileResource = new Nsxt.DhcpRelayProfile("dhcpRelayProfileResource", new()
{
    ServerAddresses = new[]
    {
        "string",
    },
    Description = "string",
    DhcpRelayProfileId = "string",
    DisplayName = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.DhcpRelayProfileTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewDhcpRelayProfile(ctx, "dhcpRelayProfileResource", &nsxt.DhcpRelayProfileArgs{
	ServerAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:        pulumi.String("string"),
	DhcpRelayProfileId: pulumi.String("string"),
	DisplayName:        pulumi.String("string"),
	Tags: nsxt.DhcpRelayProfileTagArray{
		&nsxt.DhcpRelayProfileTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var dhcpRelayProfileResource = new DhcpRelayProfile("dhcpRelayProfileResource", DhcpRelayProfileArgs.builder()
    .serverAddresses("string")
    .description("string")
    .dhcpRelayProfileId("string")
    .displayName("string")
    .tags(DhcpRelayProfileTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    dhcp_relay_profile_resource = nsxt.DhcpRelayProfile("dhcpRelayProfileResource",
    server_addresses=["string"],
    description="string",
    dhcp_relay_profile_id="string",
    display_name="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const dhcpRelayProfileResource = new nsxt.DhcpRelayProfile("dhcpRelayProfileResource", {
    serverAddresses: ["string"],
    description: "string",
    dhcpRelayProfileId: "string",
    displayName: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:DhcpRelayProfile
properties:
    description: string
    dhcpRelayProfileId: string
    displayName: string
    serverAddresses:
        - string
    tags:
        - scope: string
          tag: string

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

    ServerAddresses List<string>
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    Description string
    Description of this resource.
    DhcpRelayProfileId string
    ID of the DHCP relay profile.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    Tags List<DhcpRelayProfileTag>
    A list of scope + tag pairs to associate with this DHCP relay profile.
    ServerAddresses []string
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    Description string
    Description of this resource.
    DhcpRelayProfileId string
    ID of the DHCP relay profile.
    DisplayName string
    The display name of this resource. Defaults to ID if not set.
    Tags []DhcpRelayProfileTagArgs
    A list of scope + tag pairs to associate with this DHCP relay profile.
    serverAddresses List<String>
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    description String
    Description of this resource.
    dhcpRelayProfileId String
    ID of the DHCP relay profile.
    displayName String
    The display name of this resource. Defaults to ID if not set.
    tags List<DhcpRelayProfileTag>
    A list of scope + tag pairs to associate with this DHCP relay profile.
    serverAddresses string[]
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    description string
    Description of this resource.
    dhcpRelayProfileId string
    ID of the DHCP relay profile.
    displayName string
    The display name of this resource. Defaults to ID if not set.
    tags DhcpRelayProfileTag[]
    A list of scope + tag pairs to associate with this DHCP relay profile.
    server_addresses Sequence[str]
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    description str
    Description of this resource.
    dhcp_relay_profile_id str
    ID of the DHCP relay profile.
    display_name str
    The display name of this resource. Defaults to ID if not set.
    tags Sequence[DhcpRelayProfileTagArgs]
    A list of scope + tag pairs to associate with this DHCP relay profile.
    serverAddresses List<String>
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    description String
    Description of this resource.
    dhcpRelayProfileId String
    ID of the DHCP relay profile.
    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 profile.

    Outputs

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

    Get an existing DhcpRelayProfile 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?: DhcpRelayProfileState, opts?: CustomResourceOptions): DhcpRelayProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        dhcp_relay_profile_id: Optional[str] = None,
        display_name: Optional[str] = None,
        revision: Optional[float] = None,
        server_addresses: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[DhcpRelayProfileTagArgs]] = None) -> DhcpRelayProfile
    func GetDhcpRelayProfile(ctx *Context, name string, id IDInput, state *DhcpRelayProfileState, opts ...ResourceOption) (*DhcpRelayProfile, error)
    public static DhcpRelayProfile Get(string name, Input<string> id, DhcpRelayProfileState? state, CustomResourceOptions? opts = null)
    public static DhcpRelayProfile get(String name, Output<String> id, DhcpRelayProfileState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:DhcpRelayProfile    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:
    Description string
    Description of this resource.
    DhcpRelayProfileId string
    ID of the DHCP relay profile.
    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.
    ServerAddresses List<string>
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    Tags List<DhcpRelayProfileTag>
    A list of scope + tag pairs to associate with this DHCP relay profile.
    Description string
    Description of this resource.
    DhcpRelayProfileId string
    ID of the DHCP relay profile.
    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.
    ServerAddresses []string
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    Tags []DhcpRelayProfileTagArgs
    A list of scope + tag pairs to associate with this DHCP relay profile.
    description String
    Description of this resource.
    dhcpRelayProfileId String
    ID of the DHCP relay profile.
    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.
    serverAddresses List<String>
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    tags List<DhcpRelayProfileTag>
    A list of scope + tag pairs to associate with this DHCP relay profile.
    description string
    Description of this resource.
    dhcpRelayProfileId string
    ID of the DHCP relay profile.
    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.
    serverAddresses string[]
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    tags DhcpRelayProfileTag[]
    A list of scope + tag pairs to associate with this DHCP relay profile.
    description str
    Description of this resource.
    dhcp_relay_profile_id str
    ID of the DHCP relay profile.
    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.
    server_addresses Sequence[str]
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    tags Sequence[DhcpRelayProfileTagArgs]
    A list of scope + tag pairs to associate with this DHCP relay profile.
    description String
    Description of this resource.
    dhcpRelayProfileId String
    ID of the DHCP relay profile.
    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.
    serverAddresses List<String>
    IP addresses of the DHCP relay servers. Maximum allowed amount is 2.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this DHCP relay profile.

    Supporting Types

    DhcpRelayProfileTag, DhcpRelayProfileTagArgs

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

    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