Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. NsxvDhcpRelay
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.NsxvDhcpRelay

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create NsxvDhcpRelay Resource

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

    Constructor syntax

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

@overload
def NsxvDhcpRelay(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  edge_gateway: Optional[str] = None,
                  relay_agents: Optional[Sequence[NsxvDhcpRelayRelayAgentArgs]] = None,
                  domain_names: Optional[Sequence[str]] = None,
                  ip_addresses: Optional[Sequence[str]] = None,
                  ip_sets: Optional[Sequence[str]] = None,
                  nsxv_dhcp_relay_id: Optional[str] = None,
                  org: Optional[str] = None,
                  vdc: Optional[str] = None)
    func NewNsxvDhcpRelay(ctx *Context, name string, args NsxvDhcpRelayArgs, opts ...ResourceOption) (*NsxvDhcpRelay, error)
    public NsxvDhcpRelay(string name, NsxvDhcpRelayArgs args, CustomResourceOptions? opts = null)
    public NsxvDhcpRelay(String name, NsxvDhcpRelayArgs args)
public NsxvDhcpRelay(String name, NsxvDhcpRelayArgs args, CustomResourceOptions options)

    type: vcd:NsxvDhcpRelay
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 NsxvDhcpRelayArgs
    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 NsxvDhcpRelayArgs
    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 NsxvDhcpRelayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxvDhcpRelayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxvDhcpRelayArgs
    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 nsxvDhcpRelayResource = new Vcd.NsxvDhcpRelay("nsxvDhcpRelayResource", new()
{
    EdgeGateway = "string",
    RelayAgents = new[]
    {
        new Vcd.Inputs.NsxvDhcpRelayRelayAgentArgs
        {
            NetworkName = "string",
            GatewayIpAddress = "string",
        },
    },
    DomainNames = new[]
    {
        "string",
    },
    IpAddresses = new[]
    {
        "string",
    },
    IpSets = new[]
    {
        "string",
    },
    NsxvDhcpRelayId = "string",
    Org = "string",
    Vdc = "string",
});

    example, err := vcd.NewNsxvDhcpRelay(ctx, "nsxvDhcpRelayResource", &vcd.NsxvDhcpRelayArgs{
	EdgeGateway: pulumi.String("string"),
	RelayAgents: vcd.NsxvDhcpRelayRelayAgentArray{
		&vcd.NsxvDhcpRelayRelayAgentArgs{
			NetworkName:      pulumi.String("string"),
			GatewayIpAddress: pulumi.String("string"),
		},
	},
	DomainNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	IpAddresses: pulumi.StringArray{
		pulumi.String("string"),
	},
	IpSets: pulumi.StringArray{
		pulumi.String("string"),
	},
	NsxvDhcpRelayId: pulumi.String("string"),
	Org:             pulumi.String("string"),
	Vdc:             pulumi.String("string"),
})

    var nsxvDhcpRelayResource = new NsxvDhcpRelay("nsxvDhcpRelayResource", NsxvDhcpRelayArgs.builder()
    .edgeGateway("string")
    .relayAgents(NsxvDhcpRelayRelayAgentArgs.builder()
        .networkName("string")
        .gatewayIpAddress("string")
        .build())
    .domainNames("string")
    .ipAddresses("string")
    .ipSets("string")
    .nsxvDhcpRelayId("string")
    .org("string")
    .vdc("string")
    .build());

    nsxv_dhcp_relay_resource = vcd.NsxvDhcpRelay("nsxvDhcpRelayResource",
    edge_gateway="string",
    relay_agents=[{
        "network_name": "string",
        "gateway_ip_address": "string",
    }],
    domain_names=["string"],
    ip_addresses=["string"],
    ip_sets=["string"],
    nsxv_dhcp_relay_id="string",
    org="string",
    vdc="string")

    const nsxvDhcpRelayResource = new vcd.NsxvDhcpRelay("nsxvDhcpRelayResource", {
    edgeGateway: "string",
    relayAgents: [{
        networkName: "string",
        gatewayIpAddress: "string",
    }],
    domainNames: ["string"],
    ipAddresses: ["string"],
    ipSets: ["string"],
    nsxvDhcpRelayId: "string",
    org: "string",
    vdc: "string",
});

    type: vcd:NsxvDhcpRelay
properties:
    domainNames:
        - string
    edgeGateway: string
    ipAddresses:
        - string
    ipSets:
        - string
    nsxvDhcpRelayId: string
    org: string
    relayAgents:
        - gatewayIpAddress: string
          networkName: string
    vdc: string

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

    EdgeGateway string
    The name of the edge gateway on which DHCP relay is to be configured.
    RelayAgents List<NsxvDhcpRelayRelayAgent>

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    DomainNames List<string>
    A set of domain names.
    IpAddresses List<string>
    A set of IP addresses.
    IpSets List<string>
    A set of IP set names.
    NsxvDhcpRelayId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    Vdc string
    The name of VDC to use, optional if defined at provider level.
    EdgeGateway string
    The name of the edge gateway on which DHCP relay is to be configured.
    RelayAgents []NsxvDhcpRelayRelayAgentArgs

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    DomainNames []string
    A set of domain names.
    IpAddresses []string
    A set of IP addresses.
    IpSets []string
    A set of IP set names.
    NsxvDhcpRelayId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    Vdc string
    The name of VDC to use, optional if defined at provider level.
    edgeGateway String
    The name of the edge gateway on which DHCP relay is to be configured.
    relayAgents List<NsxvDhcpRelayRelayAgent>

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    domainNames List<String>
    A set of domain names.
    ipAddresses List<String>
    A set of IP addresses.
    ipSets List<String>
    A set of IP set names.
    nsxvDhcpRelayId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc String
    The name of VDC to use, optional if defined at provider level.
    edgeGateway string
    The name of the edge gateway on which DHCP relay is to be configured.
    relayAgents NsxvDhcpRelayRelayAgent[]

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    domainNames string[]
    A set of domain names.
    ipAddresses string[]
    A set of IP addresses.
    ipSets string[]
    A set of IP set names.
    nsxvDhcpRelayId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc string
    The name of VDC to use, optional if defined at provider level.
    edge_gateway str
    The name of the edge gateway on which DHCP relay is to be configured.
    relay_agents Sequence[NsxvDhcpRelayRelayAgentArgs]

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    domain_names Sequence[str]
    A set of domain names.
    ip_addresses Sequence[str]
    A set of IP addresses.
    ip_sets Sequence[str]
    A set of IP set names.
    nsxv_dhcp_relay_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc str
    The name of VDC to use, optional if defined at provider level.
    edgeGateway String
    The name of the edge gateway on which DHCP relay is to be configured.
    relayAgents List<Property Map>

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    domainNames List<String>
    A set of domain names.
    ipAddresses List<String>
    A set of IP addresses.
    ipSets List<String>
    A set of IP set names.
    nsxvDhcpRelayId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc String
    The name of VDC to use, optional if defined at provider level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NsxvDhcpRelay resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NsxvDhcpRelay Resource

    Get an existing NsxvDhcpRelay 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?: NsxvDhcpRelayState, opts?: CustomResourceOptions): NsxvDhcpRelay
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        domain_names: Optional[Sequence[str]] = None,
        edge_gateway: Optional[str] = None,
        ip_addresses: Optional[Sequence[str]] = None,
        ip_sets: Optional[Sequence[str]] = None,
        nsxv_dhcp_relay_id: Optional[str] = None,
        org: Optional[str] = None,
        relay_agents: Optional[Sequence[NsxvDhcpRelayRelayAgentArgs]] = None,
        vdc: Optional[str] = None) -> NsxvDhcpRelay
    func GetNsxvDhcpRelay(ctx *Context, name string, id IDInput, state *NsxvDhcpRelayState, opts ...ResourceOption) (*NsxvDhcpRelay, error)
    public static NsxvDhcpRelay Get(string name, Input<string> id, NsxvDhcpRelayState? state, CustomResourceOptions? opts = null)
    public static NsxvDhcpRelay get(String name, Output<String> id, NsxvDhcpRelayState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxvDhcpRelay    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:
    DomainNames List<string>
    A set of domain names.
    EdgeGateway string
    The name of the edge gateway on which DHCP relay is to be configured.
    IpAddresses List<string>
    A set of IP addresses.
    IpSets List<string>
    A set of IP set names.
    NsxvDhcpRelayId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    RelayAgents List<NsxvDhcpRelayRelayAgent>

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    Vdc string
    The name of VDC to use, optional if defined at provider level.
    DomainNames []string
    A set of domain names.
    EdgeGateway string
    The name of the edge gateway on which DHCP relay is to be configured.
    IpAddresses []string
    A set of IP addresses.
    IpSets []string
    A set of IP set names.
    NsxvDhcpRelayId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    RelayAgents []NsxvDhcpRelayRelayAgentArgs

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    Vdc string
    The name of VDC to use, optional if defined at provider level.
    domainNames List<String>
    A set of domain names.
    edgeGateway String
    The name of the edge gateway on which DHCP relay is to be configured.
    ipAddresses List<String>
    A set of IP addresses.
    ipSets List<String>
    A set of IP set names.
    nsxvDhcpRelayId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    relayAgents List<NsxvDhcpRelayRelayAgent>

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    vdc String
    The name of VDC to use, optional if defined at provider level.
    domainNames string[]
    A set of domain names.
    edgeGateway string
    The name of the edge gateway on which DHCP relay is to be configured.
    ipAddresses string[]
    A set of IP addresses.
    ipSets string[]
    A set of IP set names.
    nsxvDhcpRelayId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    relayAgents NsxvDhcpRelayRelayAgent[]

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    vdc string
    The name of VDC to use, optional if defined at provider level.
    domain_names Sequence[str]
    A set of domain names.
    edge_gateway str
    The name of the edge gateway on which DHCP relay is to be configured.
    ip_addresses Sequence[str]
    A set of IP addresses.
    ip_sets Sequence[str]
    A set of IP set names.
    nsxv_dhcp_relay_id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    relay_agents Sequence[NsxvDhcpRelayRelayAgentArgs]

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    vdc str
    The name of VDC to use, optional if defined at provider level.
    domainNames List<String>
    A set of domain names.
    edgeGateway String
    The name of the edge gateway on which DHCP relay is to be configured.
    ipAddresses List<String>
    A set of IP addresses.
    ipSets List<String>
    A set of IP set names.
    nsxvDhcpRelayId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    relayAgents List<Property Map>

    One or more blocks to define Org network and optional IP address of edge gateway interfaces from which DHCP messages are to be relayed to the external DHCP relay server(s). See Relay Agent and example for usage details.

    vdc String
    The name of VDC to use, optional if defined at provider level.

    Supporting Types

    NsxvDhcpRelayRelayAgent, NsxvDhcpRelayRelayAgentArgs

    NetworkName string
    Org network which is to be used for relaying DHCP message to specified servers
    GatewayIpAddress string
    Optional gateway IP address of org network which is to be used for relaying DHCP message to specified servers
    NetworkName string
    Org network which is to be used for relaying DHCP message to specified servers
    GatewayIpAddress string
    Optional gateway IP address of org network which is to be used for relaying DHCP message to specified servers
    networkName String
    Org network which is to be used for relaying DHCP message to specified servers
    gatewayIpAddress String
    Optional gateway IP address of org network which is to be used for relaying DHCP message to specified servers
    networkName string
    Org network which is to be used for relaying DHCP message to specified servers
    gatewayIpAddress string
    Optional gateway IP address of org network which is to be used for relaying DHCP message to specified servers
    network_name str
    Org network which is to be used for relaying DHCP message to specified servers
    gateway_ip_address str
    Optional gateway IP address of org network which is to be used for relaying DHCP message to specified servers
    networkName String
    Org network which is to be used for relaying DHCP message to specified servers
    gatewayIpAddress String
    Optional gateway IP address of org network which is to be used for relaying DHCP message to specified servers

    Package Details

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