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

vcd.NsxtNetworkDhcp

Explore with Pulumi AI

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

    Create NsxtNetworkDhcp Resource

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

    Constructor syntax

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

@overload
def NsxtNetworkDhcp(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    org_network_id: Optional[str] = None,
                    dns_servers: Optional[Sequence[str]] = None,
                    lease_time: Optional[float] = None,
                    listener_ip_address: Optional[str] = None,
                    mode: Optional[str] = None,
                    nsxt_network_dhcp_id: Optional[str] = None,
                    org: Optional[str] = None,
                    pools: Optional[Sequence[NsxtNetworkDhcpPoolArgs]] = None,
                    vdc: Optional[str] = None)
    func NewNsxtNetworkDhcp(ctx *Context, name string, args NsxtNetworkDhcpArgs, opts ...ResourceOption) (*NsxtNetworkDhcp, error)
    public NsxtNetworkDhcp(string name, NsxtNetworkDhcpArgs args, CustomResourceOptions? opts = null)
    public NsxtNetworkDhcp(String name, NsxtNetworkDhcpArgs args)
public NsxtNetworkDhcp(String name, NsxtNetworkDhcpArgs args, CustomResourceOptions options)

    type: vcd:NsxtNetworkDhcp
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 NsxtNetworkDhcpArgs
    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 NsxtNetworkDhcpArgs
    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 NsxtNetworkDhcpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NsxtNetworkDhcpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NsxtNetworkDhcpArgs
    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 nsxtNetworkDhcpResource = new Vcd.NsxtNetworkDhcp("nsxtNetworkDhcpResource", new()
{
    OrgNetworkId = "string",
    DnsServers = new[]
    {
        "string",
    },
    LeaseTime = 0,
    ListenerIpAddress = "string",
    Mode = "string",
    NsxtNetworkDhcpId = "string",
    Org = "string",
    Pools = new[]
    {
        new Vcd.Inputs.NsxtNetworkDhcpPoolArgs
        {
            EndAddress = "string",
            StartAddress = "string",
        },
    },
});

    example, err := vcd.NewNsxtNetworkDhcp(ctx, "nsxtNetworkDhcpResource", &vcd.NsxtNetworkDhcpArgs{
	OrgNetworkId: pulumi.String("string"),
	DnsServers: pulumi.StringArray{
		pulumi.String("string"),
	},
	LeaseTime:         pulumi.Float64(0),
	ListenerIpAddress: pulumi.String("string"),
	Mode:              pulumi.String("string"),
	NsxtNetworkDhcpId: pulumi.String("string"),
	Org:               pulumi.String("string"),
	Pools: vcd.NsxtNetworkDhcpPoolArray{
		&vcd.NsxtNetworkDhcpPoolArgs{
			EndAddress:   pulumi.String("string"),
			StartAddress: pulumi.String("string"),
		},
	},
})

    var nsxtNetworkDhcpResource = new NsxtNetworkDhcp("nsxtNetworkDhcpResource", NsxtNetworkDhcpArgs.builder()
    .orgNetworkId("string")
    .dnsServers("string")
    .leaseTime(0)
    .listenerIpAddress("string")
    .mode("string")
    .nsxtNetworkDhcpId("string")
    .org("string")
    .pools(NsxtNetworkDhcpPoolArgs.builder()
        .endAddress("string")
        .startAddress("string")
        .build())
    .build());

    nsxt_network_dhcp_resource = vcd.NsxtNetworkDhcp("nsxtNetworkDhcpResource",
    org_network_id="string",
    dns_servers=["string"],
    lease_time=0,
    listener_ip_address="string",
    mode="string",
    nsxt_network_dhcp_id="string",
    org="string",
    pools=[{
        "end_address": "string",
        "start_address": "string",
    }])

    const nsxtNetworkDhcpResource = new vcd.NsxtNetworkDhcp("nsxtNetworkDhcpResource", {
    orgNetworkId: "string",
    dnsServers: ["string"],
    leaseTime: 0,
    listenerIpAddress: "string",
    mode: "string",
    nsxtNetworkDhcpId: "string",
    org: "string",
    pools: [{
        endAddress: "string",
        startAddress: "string",
    }],
});

    type: vcd:NsxtNetworkDhcp
properties:
    dnsServers:
        - string
    leaseTime: 0
    listenerIpAddress: string
    mode: string
    nsxtNetworkDhcpId: string
    org: string
    orgNetworkId: string
    pools:
        - endAddress: string
          startAddress: string

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

    OrgNetworkId string
    ID of parent Org VDC Routed network.
    DnsServers List<string>
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    LeaseTime double
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    ListenerIpAddress string
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    Mode string
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    NsxtNetworkDhcpId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    Pools List<NsxtNetworkDhcpPool>
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    Vdc string
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    OrgNetworkId string
    ID of parent Org VDC Routed network.
    DnsServers []string
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    LeaseTime float64
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    ListenerIpAddress string
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    Mode string
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    NsxtNetworkDhcpId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    Pools []NsxtNetworkDhcpPoolArgs
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    Vdc string
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    orgNetworkId String
    ID of parent Org VDC Routed network.
    dnsServers List<String>
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    leaseTime Double
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    listenerIpAddress String
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    mode String
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    nsxtNetworkDhcpId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    pools List<NsxtNetworkDhcpPool>
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    vdc String
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    orgNetworkId string
    ID of parent Org VDC Routed network.
    dnsServers string[]
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    leaseTime number
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    listenerIpAddress string
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    mode string
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    nsxtNetworkDhcpId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    pools NsxtNetworkDhcpPool[]
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    vdc string
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    org_network_id str
    ID of parent Org VDC Routed network.
    dns_servers Sequence[str]
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    lease_time float
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    listener_ip_address str
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    mode str
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    nsxt_network_dhcp_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.
    pools Sequence[NsxtNetworkDhcpPoolArgs]
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    vdc str
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    orgNetworkId String
    ID of parent Org VDC Routed network.
    dnsServers List<String>
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    leaseTime Number
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    listenerIpAddress String
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    mode String
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    nsxtNetworkDhcpId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    pools List<Property Map>
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    vdc String
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    Outputs

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

    Get an existing NsxtNetworkDhcp 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?: NsxtNetworkDhcpState, opts?: CustomResourceOptions): NsxtNetworkDhcp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dns_servers: Optional[Sequence[str]] = None,
        lease_time: Optional[float] = None,
        listener_ip_address: Optional[str] = None,
        mode: Optional[str] = None,
        nsxt_network_dhcp_id: Optional[str] = None,
        org: Optional[str] = None,
        org_network_id: Optional[str] = None,
        pools: Optional[Sequence[NsxtNetworkDhcpPoolArgs]] = None,
        vdc: Optional[str] = None) -> NsxtNetworkDhcp
    func GetNsxtNetworkDhcp(ctx *Context, name string, id IDInput, state *NsxtNetworkDhcpState, opts ...ResourceOption) (*NsxtNetworkDhcp, error)
    public static NsxtNetworkDhcp Get(string name, Input<string> id, NsxtNetworkDhcpState? state, CustomResourceOptions? opts = null)
    public static NsxtNetworkDhcp get(String name, Output<String> id, NsxtNetworkDhcpState state, CustomResourceOptions options)
    resources:  _:    type: vcd:NsxtNetworkDhcp    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:
    DnsServers List<string>
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    LeaseTime double
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    ListenerIpAddress string
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    Mode string
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    NsxtNetworkDhcpId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    OrgNetworkId string
    ID of parent Org VDC Routed network.
    Pools List<NsxtNetworkDhcpPool>
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    Vdc string
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    DnsServers []string
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    LeaseTime float64
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    ListenerIpAddress string
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    Mode string
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    NsxtNetworkDhcpId string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    OrgNetworkId string
    ID of parent Org VDC Routed network.
    Pools []NsxtNetworkDhcpPoolArgs
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    Vdc string
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    dnsServers List<String>
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    leaseTime Double
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    listenerIpAddress String
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    mode String
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    nsxtNetworkDhcpId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    orgNetworkId String
    ID of parent Org VDC Routed network.
    pools List<NsxtNetworkDhcpPool>
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    vdc String
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    dnsServers string[]
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    leaseTime number
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    listenerIpAddress string
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    mode string
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    nsxtNetworkDhcpId string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    orgNetworkId string
    ID of parent Org VDC Routed network.
    pools NsxtNetworkDhcpPool[]
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    vdc string
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    dns_servers Sequence[str]
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    lease_time float
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    listener_ip_address str
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    mode str
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    nsxt_network_dhcp_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.
    org_network_id str
    ID of parent Org VDC Routed network.
    pools Sequence[NsxtNetworkDhcpPoolArgs]
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    vdc str
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    dnsServers List<String>
    The DNS server IPs to be assigned by this DHCP service. Maximum two values.
    leaseTime Number
    Lease time in seconds. Minimum value is 60s and maximum is 4294967295s (~ 49 days).
    listenerIpAddress String
    IP address of DHCP server in network. Must match subnet. Only used when mode=NETWORK.
    mode String
    One of EDGE, NETWORK or RELAY. Default is EDGE

    • EDGE can be used with Routed Org VDC networks.
    • NETWORK can be used for Isolated and Routed Org VDC networks. It requires listener_ip_address to be set and Edge Cluster must be assigned to VDC.
    • RELAY can be used with Routed Org VDC networks, but requires DHCP forwarding configuration in NSX-T Edge Gateway.
    nsxtNetworkDhcpId String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    orgNetworkId String
    ID of parent Org VDC Routed network.
    pools List<Property Map>
    One or more blocks to define DHCP pool ranges. Must not be set when mode=RELAY. See Pools and example for usage details.
    vdc String
    The name of VDC to use, optional if defined at provider level

    Deprecated: Deprecated

    Supporting Types

    NsxtNetworkDhcpPool, NsxtNetworkDhcpPoolArgs

    EndAddress string
    End address of DHCP pool IP range
    StartAddress string
    Start address of DHCP pool IP range
    EndAddress string
    End address of DHCP pool IP range
    StartAddress string
    Start address of DHCP pool IP range
    endAddress String
    End address of DHCP pool IP range
    startAddress String
    Start address of DHCP pool IP range
    endAddress string
    End address of DHCP pool IP range
    startAddress string
    Start address of DHCP pool IP range
    end_address str
    End address of DHCP pool IP range
    start_address str
    Start address of DHCP pool IP range
    endAddress String
    End address of DHCP pool IP range
    startAddress String
    Start address of DHCP pool IP range

    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