Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fortios
  3. API Docs
  4. system
  5. system/dhcp
  6. Server
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

fortios.system/dhcp.Server

Explore with Pulumi AI

Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios

Configure DHCP servers.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fortios from "@pulumiverse/fortios";

const trname = new fortios.system.dhcp.Server("trname", {
    dnsService: "default",
    fosid: 1,
    "interface": "port2",
    ipRanges: [{
        endIp: "1.1.1.22",
        id: 1,
        startIp: "1.1.1.1",
    }],
    netmask: "255.255.255.0",
    ntpServer1: "192.168.52.22",
    status: "disable",
    timezone: "00",
});
Copy
import pulumi
import pulumiverse_fortios as fortios

trname = fortios.system.dhcp.Server("trname",
    dns_service="default",
    fosid=1,
    interface="port2",
    ip_ranges=[fortios.system.dhcp.ServerIpRangeArgs(
        end_ip="1.1.1.22",
        id=1,
        start_ip="1.1.1.1",
    )],
    netmask="255.255.255.0",
    ntp_server1="192.168.52.22",
    status="disable",
    timezone="00")
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-fortios/sdk/go/fortios/system"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := system.NewServer(ctx, "trname", &system.ServerArgs{
			DnsService: pulumi.String("default"),
			Fosid:      pulumi.Int(1),
			Interface:  pulumi.String("port2"),
			IpRanges: dhcp.ServerIpRangeArray{
				&dhcp.ServerIpRangeArgs{
					EndIp:   pulumi.String("1.1.1.22"),
					Id:      pulumi.Int(1),
					StartIp: pulumi.String("1.1.1.1"),
				},
			},
			Netmask:    pulumi.String("255.255.255.0"),
			NtpServer1: pulumi.String("192.168.52.22"),
			Status:     pulumi.String("disable"),
			Timezone:   pulumi.String("00"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortios = Pulumiverse.Fortios;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortios.System.Dhcp.Server("trname", new()
    {
        DnsService = "default",
        Fosid = 1,
        Interface = "port2",
        IpRanges = new[]
        {
            new Fortios.System.Dhcp.Inputs.ServerIpRangeArgs
            {
                EndIp = "1.1.1.22",
                Id = 1,
                StartIp = "1.1.1.1",
            },
        },
        Netmask = "255.255.255.0",
        NtpServer1 = "192.168.52.22",
        Status = "disable",
        Timezone = "00",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortios.system.Server;
import com.pulumi.fortios.system.ServerArgs;
import com.pulumi.fortios.system.inputs.ServerIpRangeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var trname = new Server("trname", ServerArgs.builder()
            .dnsService("default")
            .fosid(1)
            .interface_("port2")
            .ipRanges(ServerIpRangeArgs.builder()
                .endIp("1.1.1.22")
                .id(1)
                .startIp("1.1.1.1")
                .build())
            .netmask("255.255.255.0")
            .ntpServer1("192.168.52.22")
            .status("disable")
            .timezone("00")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortios:system/dhcp:Server
    properties:
      dnsService: default
      fosid: 1
      interface: port2
      ipRanges:
        - endIp: 1.1.1.22
          id: 1
          startIp: 1.1.1.1
      netmask: 255.255.255.0
      ntpServer1: 192.168.52.22
      status: disable
      timezone: '00'
Copy

Create Server Resource

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

Constructor syntax

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

@overload
def Server(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           interface: Optional[str] = None,
           netmask: Optional[str] = None,
           auto_configuration: Optional[str] = None,
           auto_managed_status: Optional[str] = None,
           conflicted_ip_timeout: Optional[int] = None,
           ddns_auth: Optional[str] = None,
           ddns_key: Optional[str] = None,
           ddns_keyname: Optional[str] = None,
           ddns_server_ip: Optional[str] = None,
           ddns_ttl: Optional[int] = None,
           ddns_update: Optional[str] = None,
           ddns_update_override: Optional[str] = None,
           ddns_zone: Optional[str] = None,
           default_gateway: Optional[str] = None,
           dhcp_settings_from_fortiipam: Optional[str] = None,
           dns_server1: Optional[str] = None,
           dns_server2: Optional[str] = None,
           dns_server3: Optional[str] = None,
           dns_server4: Optional[str] = None,
           dns_service: Optional[str] = None,
           domain: Optional[str] = None,
           dynamic_sort_subtable: Optional[str] = None,
           exclude_ranges: Optional[Sequence[ServerExcludeRangeArgs]] = None,
           filename: Optional[str] = None,
           forticlient_on_net_status: Optional[str] = None,
           fosid: Optional[int] = None,
           get_all_tables: Optional[str] = None,
           ip_mode: Optional[str] = None,
           ip_ranges: Optional[Sequence[ServerIpRangeArgs]] = None,
           ipsec_lease_hold: Optional[int] = None,
           lease_time: Optional[int] = None,
           mac_acl_default_action: Optional[str] = None,
           next_server: Optional[str] = None,
           ntp_server1: Optional[str] = None,
           ntp_server2: Optional[str] = None,
           ntp_server3: Optional[str] = None,
           ntp_service: Optional[str] = None,
           options: Optional[Sequence[ServerOptionArgs]] = None,
           relay_agent: Optional[str] = None,
           reserved_addresses: Optional[Sequence[ServerReservedAddressArgs]] = None,
           server_type: Optional[str] = None,
           shared_subnet: Optional[str] = None,
           status: Optional[str] = None,
           tftp_servers: Optional[Sequence[ServerTftpServerArgs]] = None,
           timezone: Optional[str] = None,
           timezone_option: Optional[str] = None,
           vci_match: Optional[str] = None,
           vci_strings: Optional[Sequence[ServerVciStringArgs]] = None,
           vdomparam: Optional[str] = None,
           wifi_ac1: Optional[str] = None,
           wifi_ac2: Optional[str] = None,
           wifi_ac3: Optional[str] = None,
           wifi_ac_service: Optional[str] = None,
           wins_server1: Optional[str] = None,
           wins_server2: Optional[str] = None)
func NewServer(ctx *Context, name string, args ServerArgs, opts ...ResourceOption) (*Server, error)
public Server(string name, ServerArgs args, CustomResourceOptions? opts = null)
public Server(String name, ServerArgs args)
public Server(String name, ServerArgs args, CustomResourceOptions options)

type: fortios:system/dhcp/server:Server
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. ServerArgs
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. ServerArgs
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. ServerArgs
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. ServerArgs
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. ServerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

Interface This property is required. string
DHCP server can assign IP configurations to clients connected to this interface.
Netmask This property is required. string
Netmask assigned by the DHCP server.
AutoConfiguration string
Enable/disable auto configuration. Valid values: disable, enable.
AutoManagedStatus string
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
ConflictedIpTimeout int
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
DdnsAuth string
DDNS authentication mode. Valid values: disable, tsig.
DdnsKey string
DDNS update key (base 64 encoding).
DdnsKeyname string
DDNS update key name.
DdnsServerIp string
DDNS server IP.
DdnsTtl int
TTL.
DdnsUpdate string
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
DdnsUpdateOverride string
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
DdnsZone string
Zone of your domain name (ex. DDNS.com).
DefaultGateway string
Default gateway IP address assigned by the DHCP server.
DhcpSettingsFromFortiipam string
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
DnsServer1 string
DNS server 1.
DnsServer2 string
DNS server 2.
DnsServer3 string
DNS server 3.
DnsServer4 string
DNS server 4.
DnsService string
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
Domain string
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
ExcludeRanges List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerExcludeRange>
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
Filename string
Name of the boot file on the TFTP server.
ForticlientOnNetStatus string
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
Fosid Changes to this property will trigger replacement. int
ID.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
IpMode string
Method used to assign client IP. Valid values: range, usrgrp.
IpRanges List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerIpRange>
DHCP IP range configuration. The structure of ip_range block is documented below.
IpsecLeaseHold int
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
LeaseTime int
Lease time in seconds, 0 means unlimited.
MacAclDefaultAction string
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
NextServer string
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
NtpServer1 string
NTP server 1.
NtpServer2 string
NTP server 2.
NtpServer3 string
NTP server 3.
NtpService string
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
Options List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerOption>
DHCP options. The structure of options block is documented below.
RelayAgent string
Relay agent IP.
ReservedAddresses List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerReservedAddress>
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
ServerType string
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
SharedSubnet string
Enable/disable shared subnet. Valid values: disable, enable.
Status string
Enable/disable this DHCP configuration. Valid values: disable, enable.
TftpServers List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerTftpServer>
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
Timezone string
Select the time zone to be assigned to DHCP clients.
TimezoneOption string
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
VciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
VciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerVciString>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
WifiAc1 string
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
WifiAc2 string
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
WifiAc3 string
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
WifiAcService string
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
WinsServer1 string
WINS server 1.
WinsServer2 string
WINS server 2.
Interface This property is required. string
DHCP server can assign IP configurations to clients connected to this interface.
Netmask This property is required. string
Netmask assigned by the DHCP server.
AutoConfiguration string
Enable/disable auto configuration. Valid values: disable, enable.
AutoManagedStatus string
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
ConflictedIpTimeout int
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
DdnsAuth string
DDNS authentication mode. Valid values: disable, tsig.
DdnsKey string
DDNS update key (base 64 encoding).
DdnsKeyname string
DDNS update key name.
DdnsServerIp string
DDNS server IP.
DdnsTtl int
TTL.
DdnsUpdate string
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
DdnsUpdateOverride string
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
DdnsZone string
Zone of your domain name (ex. DDNS.com).
DefaultGateway string
Default gateway IP address assigned by the DHCP server.
DhcpSettingsFromFortiipam string
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
DnsServer1 string
DNS server 1.
DnsServer2 string
DNS server 2.
DnsServer3 string
DNS server 3.
DnsServer4 string
DNS server 4.
DnsService string
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
Domain string
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
ExcludeRanges []ServerExcludeRangeArgs
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
Filename string
Name of the boot file on the TFTP server.
ForticlientOnNetStatus string
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
Fosid Changes to this property will trigger replacement. int
ID.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
IpMode string
Method used to assign client IP. Valid values: range, usrgrp.
IpRanges []ServerIpRangeArgs
DHCP IP range configuration. The structure of ip_range block is documented below.
IpsecLeaseHold int
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
LeaseTime int
Lease time in seconds, 0 means unlimited.
MacAclDefaultAction string
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
NextServer string
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
NtpServer1 string
NTP server 1.
NtpServer2 string
NTP server 2.
NtpServer3 string
NTP server 3.
NtpService string
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
Options []ServerOptionArgs
DHCP options. The structure of options block is documented below.
RelayAgent string
Relay agent IP.
ReservedAddresses []ServerReservedAddressArgs
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
ServerType string
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
SharedSubnet string
Enable/disable shared subnet. Valid values: disable, enable.
Status string
Enable/disable this DHCP configuration. Valid values: disable, enable.
TftpServers []ServerTftpServerArgs
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
Timezone string
Select the time zone to be assigned to DHCP clients.
TimezoneOption string
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
VciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
VciStrings []ServerVciStringArgs
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
WifiAc1 string
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
WifiAc2 string
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
WifiAc3 string
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
WifiAcService string
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
WinsServer1 string
WINS server 1.
WinsServer2 string
WINS server 2.
interface_ This property is required. String
DHCP server can assign IP configurations to clients connected to this interface.
netmask This property is required. String
Netmask assigned by the DHCP server.
autoConfiguration String
Enable/disable auto configuration. Valid values: disable, enable.
autoManagedStatus String
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
conflictedIpTimeout Integer
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
ddnsAuth String
DDNS authentication mode. Valid values: disable, tsig.
ddnsKey String
DDNS update key (base 64 encoding).
ddnsKeyname String
DDNS update key name.
ddnsServerIp String
DDNS server IP.
ddnsTtl Integer
TTL.
ddnsUpdate String
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
ddnsUpdateOverride String
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
ddnsZone String
Zone of your domain name (ex. DDNS.com).
defaultGateway String
Default gateway IP address assigned by the DHCP server.
dhcpSettingsFromFortiipam String
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
dnsServer1 String
DNS server 1.
dnsServer2 String
DNS server 2.
dnsServer3 String
DNS server 3.
dnsServer4 String
DNS server 4.
dnsService String
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
domain String
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
excludeRanges List<ServerExcludeRange>
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
filename String
Name of the boot file on the TFTP server.
forticlientOnNetStatus String
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
fosid Changes to this property will trigger replacement. Integer
ID.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ipMode String
Method used to assign client IP. Valid values: range, usrgrp.
ipRanges List<ServerIpRange>
DHCP IP range configuration. The structure of ip_range block is documented below.
ipsecLeaseHold Integer
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
leaseTime Integer
Lease time in seconds, 0 means unlimited.
macAclDefaultAction String
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
nextServer String
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
ntpServer1 String
NTP server 1.
ntpServer2 String
NTP server 2.
ntpServer3 String
NTP server 3.
ntpService String
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
options List<ServerOption>
DHCP options. The structure of options block is documented below.
relayAgent String
Relay agent IP.
reservedAddresses List<ServerReservedAddress>
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
serverType String
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
sharedSubnet String
Enable/disable shared subnet. Valid values: disable, enable.
status String
Enable/disable this DHCP configuration. Valid values: disable, enable.
tftpServers List<ServerTftpServer>
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
timezone String
Select the time zone to be assigned to DHCP clients.
timezoneOption String
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
vciMatch String
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
vciStrings List<ServerVciString>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
wifiAc1 String
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
wifiAc2 String
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
wifiAc3 String
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
wifiAcService String
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
winsServer1 String
WINS server 1.
winsServer2 String
WINS server 2.
interface This property is required. string
DHCP server can assign IP configurations to clients connected to this interface.
netmask This property is required. string
Netmask assigned by the DHCP server.
autoConfiguration string
Enable/disable auto configuration. Valid values: disable, enable.
autoManagedStatus string
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
conflictedIpTimeout number
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
ddnsAuth string
DDNS authentication mode. Valid values: disable, tsig.
ddnsKey string
DDNS update key (base 64 encoding).
ddnsKeyname string
DDNS update key name.
ddnsServerIp string
DDNS server IP.
ddnsTtl number
TTL.
ddnsUpdate string
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
ddnsUpdateOverride string
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
ddnsZone string
Zone of your domain name (ex. DDNS.com).
defaultGateway string
Default gateway IP address assigned by the DHCP server.
dhcpSettingsFromFortiipam string
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
dnsServer1 string
DNS server 1.
dnsServer2 string
DNS server 2.
dnsServer3 string
DNS server 3.
dnsServer4 string
DNS server 4.
dnsService string
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
domain string
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
excludeRanges ServerExcludeRange[]
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
filename string
Name of the boot file on the TFTP server.
forticlientOnNetStatus string
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
fosid Changes to this property will trigger replacement. number
ID.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ipMode string
Method used to assign client IP. Valid values: range, usrgrp.
ipRanges ServerIpRange[]
DHCP IP range configuration. The structure of ip_range block is documented below.
ipsecLeaseHold number
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
leaseTime number
Lease time in seconds, 0 means unlimited.
macAclDefaultAction string
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
nextServer string
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
ntpServer1 string
NTP server 1.
ntpServer2 string
NTP server 2.
ntpServer3 string
NTP server 3.
ntpService string
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
options ServerOption[]
DHCP options. The structure of options block is documented below.
relayAgent string
Relay agent IP.
reservedAddresses ServerReservedAddress[]
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
serverType string
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
sharedSubnet string
Enable/disable shared subnet. Valid values: disable, enable.
status string
Enable/disable this DHCP configuration. Valid values: disable, enable.
tftpServers ServerTftpServer[]
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
timezone string
Select the time zone to be assigned to DHCP clients.
timezoneOption string
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
vciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
vciStrings ServerVciString[]
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
wifiAc1 string
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
wifiAc2 string
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
wifiAc3 string
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
wifiAcService string
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
winsServer1 string
WINS server 1.
winsServer2 string
WINS server 2.
interface This property is required. str
DHCP server can assign IP configurations to clients connected to this interface.
netmask This property is required. str
Netmask assigned by the DHCP server.
auto_configuration str
Enable/disable auto configuration. Valid values: disable, enable.
auto_managed_status str
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
conflicted_ip_timeout int
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
ddns_auth str
DDNS authentication mode. Valid values: disable, tsig.
ddns_key str
DDNS update key (base 64 encoding).
ddns_keyname str
DDNS update key name.
ddns_server_ip str
DDNS server IP.
ddns_ttl int
TTL.
ddns_update str
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
ddns_update_override str
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
ddns_zone str
Zone of your domain name (ex. DDNS.com).
default_gateway str
Default gateway IP address assigned by the DHCP server.
dhcp_settings_from_fortiipam str
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
dns_server1 str
DNS server 1.
dns_server2 str
DNS server 2.
dns_server3 str
DNS server 3.
dns_server4 str
DNS server 4.
dns_service str
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
domain str
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
exclude_ranges Sequence[ServerExcludeRangeArgs]
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
filename str
Name of the boot file on the TFTP server.
forticlient_on_net_status str
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
fosid Changes to this property will trigger replacement. int
ID.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ip_mode str
Method used to assign client IP. Valid values: range, usrgrp.
ip_ranges Sequence[ServerIpRangeArgs]
DHCP IP range configuration. The structure of ip_range block is documented below.
ipsec_lease_hold int
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
lease_time int
Lease time in seconds, 0 means unlimited.
mac_acl_default_action str
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
next_server str
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
ntp_server1 str
NTP server 1.
ntp_server2 str
NTP server 2.
ntp_server3 str
NTP server 3.
ntp_service str
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
options Sequence[ServerOptionArgs]
DHCP options. The structure of options block is documented below.
relay_agent str
Relay agent IP.
reserved_addresses Sequence[ServerReservedAddressArgs]
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
server_type str
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
shared_subnet str
Enable/disable shared subnet. Valid values: disable, enable.
status str
Enable/disable this DHCP configuration. Valid values: disable, enable.
tftp_servers Sequence[ServerTftpServerArgs]
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
timezone str
Select the time zone to be assigned to DHCP clients.
timezone_option str
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
vci_match str
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
vci_strings Sequence[ServerVciStringArgs]
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
wifi_ac1 str
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
wifi_ac2 str
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
wifi_ac3 str
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
wifi_ac_service str
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
wins_server1 str
WINS server 1.
wins_server2 str
WINS server 2.
interface This property is required. String
DHCP server can assign IP configurations to clients connected to this interface.
netmask This property is required. String
Netmask assigned by the DHCP server.
autoConfiguration String
Enable/disable auto configuration. Valid values: disable, enable.
autoManagedStatus String
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
conflictedIpTimeout Number
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
ddnsAuth String
DDNS authentication mode. Valid values: disable, tsig.
ddnsKey String
DDNS update key (base 64 encoding).
ddnsKeyname String
DDNS update key name.
ddnsServerIp String
DDNS server IP.
ddnsTtl Number
TTL.
ddnsUpdate String
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
ddnsUpdateOverride String
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
ddnsZone String
Zone of your domain name (ex. DDNS.com).
defaultGateway String
Default gateway IP address assigned by the DHCP server.
dhcpSettingsFromFortiipam String
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
dnsServer1 String
DNS server 1.
dnsServer2 String
DNS server 2.
dnsServer3 String
DNS server 3.
dnsServer4 String
DNS server 4.
dnsService String
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
domain String
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
excludeRanges List<Property Map>
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
filename String
Name of the boot file on the TFTP server.
forticlientOnNetStatus String
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
fosid Changes to this property will trigger replacement. Number
ID.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
ipMode String
Method used to assign client IP. Valid values: range, usrgrp.
ipRanges List<Property Map>
DHCP IP range configuration. The structure of ip_range block is documented below.
ipsecLeaseHold Number
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
leaseTime Number
Lease time in seconds, 0 means unlimited.
macAclDefaultAction String
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
nextServer String
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
ntpServer1 String
NTP server 1.
ntpServer2 String
NTP server 2.
ntpServer3 String
NTP server 3.
ntpService String
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
options List<Property Map>
DHCP options. The structure of options block is documented below.
relayAgent String
Relay agent IP.
reservedAddresses List<Property Map>
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
serverType String
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
sharedSubnet String
Enable/disable shared subnet. Valid values: disable, enable.
status String
Enable/disable this DHCP configuration. Valid values: disable, enable.
tftpServers List<Property Map>
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
timezone String
Select the time zone to be assigned to DHCP clients.
timezoneOption String
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
vciMatch String
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
vciStrings List<Property Map>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
wifiAc1 String
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
wifiAc2 String
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
wifiAc3 String
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
wifiAcService String
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
winsServer1 String
WINS server 1.
winsServer2 String
WINS server 2.

Outputs

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

Get an existing Server 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?: ServerState, opts?: CustomResourceOptions): Server
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_configuration: Optional[str] = None,
        auto_managed_status: Optional[str] = None,
        conflicted_ip_timeout: Optional[int] = None,
        ddns_auth: Optional[str] = None,
        ddns_key: Optional[str] = None,
        ddns_keyname: Optional[str] = None,
        ddns_server_ip: Optional[str] = None,
        ddns_ttl: Optional[int] = None,
        ddns_update: Optional[str] = None,
        ddns_update_override: Optional[str] = None,
        ddns_zone: Optional[str] = None,
        default_gateway: Optional[str] = None,
        dhcp_settings_from_fortiipam: Optional[str] = None,
        dns_server1: Optional[str] = None,
        dns_server2: Optional[str] = None,
        dns_server3: Optional[str] = None,
        dns_server4: Optional[str] = None,
        dns_service: Optional[str] = None,
        domain: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        exclude_ranges: Optional[Sequence[ServerExcludeRangeArgs]] = None,
        filename: Optional[str] = None,
        forticlient_on_net_status: Optional[str] = None,
        fosid: Optional[int] = None,
        get_all_tables: Optional[str] = None,
        interface: Optional[str] = None,
        ip_mode: Optional[str] = None,
        ip_ranges: Optional[Sequence[ServerIpRangeArgs]] = None,
        ipsec_lease_hold: Optional[int] = None,
        lease_time: Optional[int] = None,
        mac_acl_default_action: Optional[str] = None,
        netmask: Optional[str] = None,
        next_server: Optional[str] = None,
        ntp_server1: Optional[str] = None,
        ntp_server2: Optional[str] = None,
        ntp_server3: Optional[str] = None,
        ntp_service: Optional[str] = None,
        options: Optional[Sequence[ServerOptionArgs]] = None,
        relay_agent: Optional[str] = None,
        reserved_addresses: Optional[Sequence[ServerReservedAddressArgs]] = None,
        server_type: Optional[str] = None,
        shared_subnet: Optional[str] = None,
        status: Optional[str] = None,
        tftp_servers: Optional[Sequence[ServerTftpServerArgs]] = None,
        timezone: Optional[str] = None,
        timezone_option: Optional[str] = None,
        vci_match: Optional[str] = None,
        vci_strings: Optional[Sequence[ServerVciStringArgs]] = None,
        vdomparam: Optional[str] = None,
        wifi_ac1: Optional[str] = None,
        wifi_ac2: Optional[str] = None,
        wifi_ac3: Optional[str] = None,
        wifi_ac_service: Optional[str] = None,
        wins_server1: Optional[str] = None,
        wins_server2: Optional[str] = None) -> Server
func GetServer(ctx *Context, name string, id IDInput, state *ServerState, opts ...ResourceOption) (*Server, error)
public static Server Get(string name, Input<string> id, ServerState? state, CustomResourceOptions? opts = null)
public static Server get(String name, Output<String> id, ServerState state, CustomResourceOptions options)
resources:  _:    type: fortios:system/dhcp/server:Server    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:
AutoConfiguration string
Enable/disable auto configuration. Valid values: disable, enable.
AutoManagedStatus string
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
ConflictedIpTimeout int
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
DdnsAuth string
DDNS authentication mode. Valid values: disable, tsig.
DdnsKey string
DDNS update key (base 64 encoding).
DdnsKeyname string
DDNS update key name.
DdnsServerIp string
DDNS server IP.
DdnsTtl int
TTL.
DdnsUpdate string
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
DdnsUpdateOverride string
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
DdnsZone string
Zone of your domain name (ex. DDNS.com).
DefaultGateway string
Default gateway IP address assigned by the DHCP server.
DhcpSettingsFromFortiipam string
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
DnsServer1 string
DNS server 1.
DnsServer2 string
DNS server 2.
DnsServer3 string
DNS server 3.
DnsServer4 string
DNS server 4.
DnsService string
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
Domain string
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
ExcludeRanges List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerExcludeRange>
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
Filename string
Name of the boot file on the TFTP server.
ForticlientOnNetStatus string
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
Fosid Changes to this property will trigger replacement. int
ID.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Interface string
DHCP server can assign IP configurations to clients connected to this interface.
IpMode string
Method used to assign client IP. Valid values: range, usrgrp.
IpRanges List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerIpRange>
DHCP IP range configuration. The structure of ip_range block is documented below.
IpsecLeaseHold int
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
LeaseTime int
Lease time in seconds, 0 means unlimited.
MacAclDefaultAction string
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
Netmask string
Netmask assigned by the DHCP server.
NextServer string
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
NtpServer1 string
NTP server 1.
NtpServer2 string
NTP server 2.
NtpServer3 string
NTP server 3.
NtpService string
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
Options List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerOption>
DHCP options. The structure of options block is documented below.
RelayAgent string
Relay agent IP.
ReservedAddresses List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerReservedAddress>
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
ServerType string
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
SharedSubnet string
Enable/disable shared subnet. Valid values: disable, enable.
Status string
Enable/disable this DHCP configuration. Valid values: disable, enable.
TftpServers List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerTftpServer>
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
Timezone string
Select the time zone to be assigned to DHCP clients.
TimezoneOption string
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
VciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
VciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerVciString>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
WifiAc1 string
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
WifiAc2 string
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
WifiAc3 string
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
WifiAcService string
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
WinsServer1 string
WINS server 1.
WinsServer2 string
WINS server 2.
AutoConfiguration string
Enable/disable auto configuration. Valid values: disable, enable.
AutoManagedStatus string
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
ConflictedIpTimeout int
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
DdnsAuth string
DDNS authentication mode. Valid values: disable, tsig.
DdnsKey string
DDNS update key (base 64 encoding).
DdnsKeyname string
DDNS update key name.
DdnsServerIp string
DDNS server IP.
DdnsTtl int
TTL.
DdnsUpdate string
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
DdnsUpdateOverride string
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
DdnsZone string
Zone of your domain name (ex. DDNS.com).
DefaultGateway string
Default gateway IP address assigned by the DHCP server.
DhcpSettingsFromFortiipam string
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
DnsServer1 string
DNS server 1.
DnsServer2 string
DNS server 2.
DnsServer3 string
DNS server 3.
DnsServer4 string
DNS server 4.
DnsService string
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
Domain string
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
DynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
ExcludeRanges []ServerExcludeRangeArgs
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
Filename string
Name of the boot file on the TFTP server.
ForticlientOnNetStatus string
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
Fosid Changes to this property will trigger replacement. int
ID.
GetAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
Interface string
DHCP server can assign IP configurations to clients connected to this interface.
IpMode string
Method used to assign client IP. Valid values: range, usrgrp.
IpRanges []ServerIpRangeArgs
DHCP IP range configuration. The structure of ip_range block is documented below.
IpsecLeaseHold int
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
LeaseTime int
Lease time in seconds, 0 means unlimited.
MacAclDefaultAction string
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
Netmask string
Netmask assigned by the DHCP server.
NextServer string
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
NtpServer1 string
NTP server 1.
NtpServer2 string
NTP server 2.
NtpServer3 string
NTP server 3.
NtpService string
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
Options []ServerOptionArgs
DHCP options. The structure of options block is documented below.
RelayAgent string
Relay agent IP.
ReservedAddresses []ServerReservedAddressArgs
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
ServerType string
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
SharedSubnet string
Enable/disable shared subnet. Valid values: disable, enable.
Status string
Enable/disable this DHCP configuration. Valid values: disable, enable.
TftpServers []ServerTftpServerArgs
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
Timezone string
Select the time zone to be assigned to DHCP clients.
TimezoneOption string
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
VciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
VciStrings []ServerVciStringArgs
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
Vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
WifiAc1 string
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
WifiAc2 string
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
WifiAc3 string
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
WifiAcService string
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
WinsServer1 string
WINS server 1.
WinsServer2 string
WINS server 2.
autoConfiguration String
Enable/disable auto configuration. Valid values: disable, enable.
autoManagedStatus String
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
conflictedIpTimeout Integer
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
ddnsAuth String
DDNS authentication mode. Valid values: disable, tsig.
ddnsKey String
DDNS update key (base 64 encoding).
ddnsKeyname String
DDNS update key name.
ddnsServerIp String
DDNS server IP.
ddnsTtl Integer
TTL.
ddnsUpdate String
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
ddnsUpdateOverride String
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
ddnsZone String
Zone of your domain name (ex. DDNS.com).
defaultGateway String
Default gateway IP address assigned by the DHCP server.
dhcpSettingsFromFortiipam String
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
dnsServer1 String
DNS server 1.
dnsServer2 String
DNS server 2.
dnsServer3 String
DNS server 3.
dnsServer4 String
DNS server 4.
dnsService String
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
domain String
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
excludeRanges List<ServerExcludeRange>
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
filename String
Name of the boot file on the TFTP server.
forticlientOnNetStatus String
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
fosid Changes to this property will trigger replacement. Integer
ID.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
interface_ String
DHCP server can assign IP configurations to clients connected to this interface.
ipMode String
Method used to assign client IP. Valid values: range, usrgrp.
ipRanges List<ServerIpRange>
DHCP IP range configuration. The structure of ip_range block is documented below.
ipsecLeaseHold Integer
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
leaseTime Integer
Lease time in seconds, 0 means unlimited.
macAclDefaultAction String
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
netmask String
Netmask assigned by the DHCP server.
nextServer String
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
ntpServer1 String
NTP server 1.
ntpServer2 String
NTP server 2.
ntpServer3 String
NTP server 3.
ntpService String
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
options List<ServerOption>
DHCP options. The structure of options block is documented below.
relayAgent String
Relay agent IP.
reservedAddresses List<ServerReservedAddress>
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
serverType String
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
sharedSubnet String
Enable/disable shared subnet. Valid values: disable, enable.
status String
Enable/disable this DHCP configuration. Valid values: disable, enable.
tftpServers List<ServerTftpServer>
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
timezone String
Select the time zone to be assigned to DHCP clients.
timezoneOption String
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
vciMatch String
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
vciStrings List<ServerVciString>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
wifiAc1 String
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
wifiAc2 String
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
wifiAc3 String
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
wifiAcService String
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
winsServer1 String
WINS server 1.
winsServer2 String
WINS server 2.
autoConfiguration string
Enable/disable auto configuration. Valid values: disable, enable.
autoManagedStatus string
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
conflictedIpTimeout number
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
ddnsAuth string
DDNS authentication mode. Valid values: disable, tsig.
ddnsKey string
DDNS update key (base 64 encoding).
ddnsKeyname string
DDNS update key name.
ddnsServerIp string
DDNS server IP.
ddnsTtl number
TTL.
ddnsUpdate string
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
ddnsUpdateOverride string
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
ddnsZone string
Zone of your domain name (ex. DDNS.com).
defaultGateway string
Default gateway IP address assigned by the DHCP server.
dhcpSettingsFromFortiipam string
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
dnsServer1 string
DNS server 1.
dnsServer2 string
DNS server 2.
dnsServer3 string
DNS server 3.
dnsServer4 string
DNS server 4.
dnsService string
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
domain string
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
dynamicSortSubtable string
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
excludeRanges ServerExcludeRange[]
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
filename string
Name of the boot file on the TFTP server.
forticlientOnNetStatus string
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
fosid Changes to this property will trigger replacement. number
ID.
getAllTables string
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
interface string
DHCP server can assign IP configurations to clients connected to this interface.
ipMode string
Method used to assign client IP. Valid values: range, usrgrp.
ipRanges ServerIpRange[]
DHCP IP range configuration. The structure of ip_range block is documented below.
ipsecLeaseHold number
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
leaseTime number
Lease time in seconds, 0 means unlimited.
macAclDefaultAction string
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
netmask string
Netmask assigned by the DHCP server.
nextServer string
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
ntpServer1 string
NTP server 1.
ntpServer2 string
NTP server 2.
ntpServer3 string
NTP server 3.
ntpService string
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
options ServerOption[]
DHCP options. The structure of options block is documented below.
relayAgent string
Relay agent IP.
reservedAddresses ServerReservedAddress[]
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
serverType string
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
sharedSubnet string
Enable/disable shared subnet. Valid values: disable, enable.
status string
Enable/disable this DHCP configuration. Valid values: disable, enable.
tftpServers ServerTftpServer[]
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
timezone string
Select the time zone to be assigned to DHCP clients.
timezoneOption string
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
vciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
vciStrings ServerVciString[]
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
vdomparam Changes to this property will trigger replacement. string
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
wifiAc1 string
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
wifiAc2 string
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
wifiAc3 string
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
wifiAcService string
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
winsServer1 string
WINS server 1.
winsServer2 string
WINS server 2.
auto_configuration str
Enable/disable auto configuration. Valid values: disable, enable.
auto_managed_status str
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
conflicted_ip_timeout int
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
ddns_auth str
DDNS authentication mode. Valid values: disable, tsig.
ddns_key str
DDNS update key (base 64 encoding).
ddns_keyname str
DDNS update key name.
ddns_server_ip str
DDNS server IP.
ddns_ttl int
TTL.
ddns_update str
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
ddns_update_override str
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
ddns_zone str
Zone of your domain name (ex. DDNS.com).
default_gateway str
Default gateway IP address assigned by the DHCP server.
dhcp_settings_from_fortiipam str
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
dns_server1 str
DNS server 1.
dns_server2 str
DNS server 2.
dns_server3 str
DNS server 3.
dns_server4 str
DNS server 4.
dns_service str
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
domain str
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
dynamic_sort_subtable str
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
exclude_ranges Sequence[ServerExcludeRangeArgs]
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
filename str
Name of the boot file on the TFTP server.
forticlient_on_net_status str
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
fosid Changes to this property will trigger replacement. int
ID.
get_all_tables str
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
interface str
DHCP server can assign IP configurations to clients connected to this interface.
ip_mode str
Method used to assign client IP. Valid values: range, usrgrp.
ip_ranges Sequence[ServerIpRangeArgs]
DHCP IP range configuration. The structure of ip_range block is documented below.
ipsec_lease_hold int
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
lease_time int
Lease time in seconds, 0 means unlimited.
mac_acl_default_action str
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
netmask str
Netmask assigned by the DHCP server.
next_server str
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
ntp_server1 str
NTP server 1.
ntp_server2 str
NTP server 2.
ntp_server3 str
NTP server 3.
ntp_service str
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
options Sequence[ServerOptionArgs]
DHCP options. The structure of options block is documented below.
relay_agent str
Relay agent IP.
reserved_addresses Sequence[ServerReservedAddressArgs]
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
server_type str
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
shared_subnet str
Enable/disable shared subnet. Valid values: disable, enable.
status str
Enable/disable this DHCP configuration. Valid values: disable, enable.
tftp_servers Sequence[ServerTftpServerArgs]
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
timezone str
Select the time zone to be assigned to DHCP clients.
timezone_option str
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
vci_match str
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
vci_strings Sequence[ServerVciStringArgs]
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
vdomparam Changes to this property will trigger replacement. str
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
wifi_ac1 str
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
wifi_ac2 str
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
wifi_ac3 str
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
wifi_ac_service str
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
wins_server1 str
WINS server 1.
wins_server2 str
WINS server 2.
autoConfiguration String
Enable/disable auto configuration. Valid values: disable, enable.
autoManagedStatus String
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. Valid values: disable, enable.
conflictedIpTimeout Number
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused.
ddnsAuth String
DDNS authentication mode. Valid values: disable, tsig.
ddnsKey String
DDNS update key (base 64 encoding).
ddnsKeyname String
DDNS update key name.
ddnsServerIp String
DDNS server IP.
ddnsTtl Number
TTL.
ddnsUpdate String
Enable/disable DDNS update for DHCP. Valid values: disable, enable.
ddnsUpdateOverride String
Enable/disable DDNS update override for DHCP. Valid values: disable, enable.
ddnsZone String
Zone of your domain name (ex. DDNS.com).
defaultGateway String
Default gateway IP address assigned by the DHCP server.
dhcpSettingsFromFortiipam String
Enable/disable populating of DHCP server settings from FortiIPAM. Valid values: disable, enable.
dnsServer1 String
DNS server 1.
dnsServer2 String
DNS server 2.
dnsServer3 String
DNS server 3.
dnsServer4 String
DNS server 4.
dnsService String
Options for assigning DNS servers to DHCP clients. Valid values: local, default, specify.
domain String
Domain name suffix for the IP addresses that the DHCP server assigns to clients.
dynamicSortSubtable String
Sort sub-tables, please do not set this parameter when configuring static sub-tables. Options: [ false, true, natural, alphabetical ]. false: Default value, do not sort tables; true/natural: sort tables in natural order. For example: [ a10, a2 ] -> [ a2, a10 ]; alphabetical: sort tables in alphabetical order. For example: [ a10, a2 ] -> [ a10, a2 ].
excludeRanges List<Property Map>
Exclude one or more ranges of IP addresses from being assigned to clients. The structure of exclude_range block is documented below.
filename String
Name of the boot file on the TFTP server.
forticlientOnNetStatus String
Enable/disable FortiClient-On-Net service for this DHCP server. Valid values: disable, enable.
fosid Changes to this property will trigger replacement. Number
ID.
getAllTables String
Get all sub-tables including unconfigured tables. Do not set this variable to true if you configure sub-table in another resource, otherwise, conflicts and overwrite will occur. Options: [ false, true ]. false: Default value, do not get unconfigured tables; true: get all tables including unconfigured tables.
interface String
DHCP server can assign IP configurations to clients connected to this interface.
ipMode String
Method used to assign client IP. Valid values: range, usrgrp.
ipRanges List<Property Map>
DHCP IP range configuration. The structure of ip_range block is documented below.
ipsecLeaseHold Number
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry).
leaseTime Number
Lease time in seconds, 0 means unlimited.
macAclDefaultAction String
MAC access control default action (allow or block assigning IP settings). Valid values: assign, block.
netmask String
Netmask assigned by the DHCP server.
nextServer String
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from.
ntpServer1 String
NTP server 1.
ntpServer2 String
NTP server 2.
ntpServer3 String
NTP server 3.
ntpService String
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. Valid values: local, default, specify.
options List<Property Map>
DHCP options. The structure of options block is documented below.
relayAgent String
Relay agent IP.
reservedAddresses List<Property Map>
Options for the DHCP server to assign IP settings to specific MAC addresses. The structure of reserved_address block is documented below.
serverType String
DHCP server can be a normal DHCP server or an IPsec DHCP server. Valid values: regular, ipsec.
sharedSubnet String
Enable/disable shared subnet. Valid values: disable, enable.
status String
Enable/disable this DHCP configuration. Valid values: disable, enable.
tftpServers List<Property Map>
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. The structure of tftp_server block is documented below.
timezone String
Select the time zone to be assigned to DHCP clients.
timezoneOption String
Options for the DHCP server to set the client's time zone. Valid values: disable, default, specify.
vciMatch String
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. Valid values: disable, enable.
vciStrings List<Property Map>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
vdomparam Changes to this property will trigger replacement. String
Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
wifiAc1 String
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417).
wifiAc2 String
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417).
wifiAc3 String
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417).
wifiAcService String
Options for assigning WiFi Access Controllers to DHCP clients Valid values: specify, local.
winsServer1 String
WINS server 1.
winsServer2 String
WINS server 2.

Supporting Types

ServerExcludeRange
, ServerExcludeRangeArgs

EndIp string
End of IP range.
Id int
ID.
LeaseTime int
Lease time in seconds, 0 means default lease time.
StartIp string
Start of IP range.
UciMatch string
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
UciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerExcludeRangeUciString>
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
VciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
VciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerExcludeRangeVciString>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
EndIp string
End of IP range.
Id int
ID.
LeaseTime int
Lease time in seconds, 0 means default lease time.
StartIp string
Start of IP range.
UciMatch string
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
UciStrings []ServerExcludeRangeUciString
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
VciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
VciStrings []ServerExcludeRangeVciString
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
endIp String
End of IP range.
id Integer
ID.
leaseTime Integer
Lease time in seconds, 0 means default lease time.
startIp String
Start of IP range.
uciMatch String
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
uciStrings List<ServerExcludeRangeUciString>
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
vciMatch String
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
vciStrings List<ServerExcludeRangeVciString>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
endIp string
End of IP range.
id number
ID.
leaseTime number
Lease time in seconds, 0 means default lease time.
startIp string
Start of IP range.
uciMatch string
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
uciStrings ServerExcludeRangeUciString[]
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
vciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
vciStrings ServerExcludeRangeVciString[]
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
end_ip str
End of IP range.
id int
ID.
lease_time int
Lease time in seconds, 0 means default lease time.
start_ip str
Start of IP range.
uci_match str
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
uci_strings Sequence[ServerExcludeRangeUciString]
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
vci_match str
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
vci_strings Sequence[ServerExcludeRangeVciString]
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
endIp String
End of IP range.
id Number
ID.
leaseTime Number
Lease time in seconds, 0 means default lease time.
startIp String
Start of IP range.
uciMatch String
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
uciStrings List<Property Map>
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
vciMatch String
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
vciStrings List<Property Map>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.

ServerExcludeRangeUciString
, ServerExcludeRangeUciStringArgs

UciString string
UCI strings.
UciString string
UCI strings.
uciString String
UCI strings.
uciString string
UCI strings.
uci_string str
UCI strings.
uciString String
UCI strings.

ServerExcludeRangeVciString
, ServerExcludeRangeVciStringArgs

VciString string
VCI strings.
VciString string
VCI strings.
vciString String
VCI strings.
vciString string
VCI strings.
vci_string str
VCI strings.
vciString String
VCI strings.

ServerIpRange
, ServerIpRangeArgs

EndIp string
End of IP range.
Id int
ID.
LeaseTime int
Lease time in seconds, 0 means default lease time.
StartIp string
Start of IP range.
UciMatch string
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
UciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerIpRangeUciString>
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
VciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
VciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerIpRangeVciString>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
EndIp string
End of IP range.
Id int
ID.
LeaseTime int
Lease time in seconds, 0 means default lease time.
StartIp string
Start of IP range.
UciMatch string
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
UciStrings []ServerIpRangeUciString
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
VciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
VciStrings []ServerIpRangeVciString
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
endIp String
End of IP range.
id Integer
ID.
leaseTime Integer
Lease time in seconds, 0 means default lease time.
startIp String
Start of IP range.
uciMatch String
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
uciStrings List<ServerIpRangeUciString>
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
vciMatch String
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
vciStrings List<ServerIpRangeVciString>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
endIp string
End of IP range.
id number
ID.
leaseTime number
Lease time in seconds, 0 means default lease time.
startIp string
Start of IP range.
uciMatch string
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
uciStrings ServerIpRangeUciString[]
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
vciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
vciStrings ServerIpRangeVciString[]
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
end_ip str
End of IP range.
id int
ID.
lease_time int
Lease time in seconds, 0 means default lease time.
start_ip str
Start of IP range.
uci_match str
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
uci_strings Sequence[ServerIpRangeUciString]
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
vci_match str
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
vci_strings Sequence[ServerIpRangeVciString]
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
endIp String
End of IP range.
id Number
ID.
leaseTime Number
Lease time in seconds, 0 means default lease time.
startIp String
Start of IP range.
uciMatch String
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. Valid values: disable, enable.
uciStrings List<Property Map>
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
vciMatch String
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. Valid values: disable, enable.
vciStrings List<Property Map>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.

ServerIpRangeUciString
, ServerIpRangeUciStringArgs

UciString string
UCI strings.
UciString string
UCI strings.
uciString String
UCI strings.
uciString string
UCI strings.
uci_string str
UCI strings.
uciString String
UCI strings.

ServerIpRangeVciString
, ServerIpRangeVciStringArgs

VciString string
VCI strings.
VciString string
VCI strings.
vciString String
VCI strings.
vciString string
VCI strings.
vci_string str
VCI strings.
vciString String
VCI strings.

ServerOption
, ServerOptionArgs

Code int
DHCP option code.
Id int
ID.
Ip string
DHCP option IPs.
Type string
DHCP option type. Valid values: hex, string, ip, fqdn.
UciMatch string
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this option. Valid values: disable, enable.
UciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerOptionUciString>
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
Value string
DHCP option value.
VciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this option. Valid values: disable, enable.
VciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.ServerOptionVciString>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
Code int
DHCP option code.
Id int
ID.
Ip string
DHCP option IPs.
Type string
DHCP option type. Valid values: hex, string, ip, fqdn.
UciMatch string
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this option. Valid values: disable, enable.
UciStrings []ServerOptionUciString
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
Value string
DHCP option value.
VciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this option. Valid values: disable, enable.
VciStrings []ServerOptionVciString
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
code Integer
DHCP option code.
id Integer
ID.
ip String
DHCP option IPs.
type String
DHCP option type. Valid values: hex, string, ip, fqdn.
uciMatch String
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this option. Valid values: disable, enable.
uciStrings List<ServerOptionUciString>
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
value String
DHCP option value.
vciMatch String
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this option. Valid values: disable, enable.
vciStrings List<ServerOptionVciString>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
code number
DHCP option code.
id number
ID.
ip string
DHCP option IPs.
type string
DHCP option type. Valid values: hex, string, ip, fqdn.
uciMatch string
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this option. Valid values: disable, enable.
uciStrings ServerOptionUciString[]
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
value string
DHCP option value.
vciMatch string
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this option. Valid values: disable, enable.
vciStrings ServerOptionVciString[]
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
code int
DHCP option code.
id int
ID.
ip str
DHCP option IPs.
type str
DHCP option type. Valid values: hex, string, ip, fqdn.
uci_match str
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this option. Valid values: disable, enable.
uci_strings Sequence[ServerOptionUciString]
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
value str
DHCP option value.
vci_match str
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this option. Valid values: disable, enable.
vci_strings Sequence[ServerOptionVciString]
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.
code Number
DHCP option code.
id Number
ID.
ip String
DHCP option IPs.
type String
DHCP option type. Valid values: hex, string, ip, fqdn.
uciMatch String
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this option. Valid values: disable, enable.
uciStrings List<Property Map>
One or more UCI strings in quotes separated by spaces. The structure of uci_string block is documented below.
value String
DHCP option value.
vciMatch String
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this option. Valid values: disable, enable.
vciStrings List<Property Map>
One or more VCI strings in quotes separated by spaces. The structure of vci_string block is documented below.

ServerOptionUciString
, ServerOptionUciStringArgs

UciString string
UCI strings.
UciString string
UCI strings.
uciString String
UCI strings.
uciString string
UCI strings.
uci_string str
UCI strings.
uciString String
UCI strings.

ServerOptionVciString
, ServerOptionVciStringArgs

VciString string
VCI strings.
VciString string
VCI strings.
vciString String
VCI strings.
vciString string
VCI strings.
vci_string str
VCI strings.
vciString String
VCI strings.

ServerReservedAddress
, ServerReservedAddressArgs

Action string
Options for the DHCP server to configure the client with the reserved MAC address. Valid values: assign, block, reserved.
CircuitId string
Option 82 circuit-ID of the client that will get the reserved IP address.
CircuitIdType string
DHCP option type. Valid values: hex, string.
Description string
Description.
Id int
ID.
Ip string
IP address to be reserved for the MAC address.
Mac string
MAC address of the client that will get the reserved IP address.
RemoteId string
Option 82 remote-ID of the client that will get the reserved IP address.
RemoteIdType string
DHCP option type. Valid values: hex, string.
Type string
DHCP reserved-address type. Valid values: mac, option82.
Action string
Options for the DHCP server to configure the client with the reserved MAC address. Valid values: assign, block, reserved.
CircuitId string
Option 82 circuit-ID of the client that will get the reserved IP address.
CircuitIdType string
DHCP option type. Valid values: hex, string.
Description string
Description.
Id int
ID.
Ip string
IP address to be reserved for the MAC address.
Mac string
MAC address of the client that will get the reserved IP address.
RemoteId string
Option 82 remote-ID of the client that will get the reserved IP address.
RemoteIdType string
DHCP option type. Valid values: hex, string.
Type string
DHCP reserved-address type. Valid values: mac, option82.
action String
Options for the DHCP server to configure the client with the reserved MAC address. Valid values: assign, block, reserved.
circuitId String
Option 82 circuit-ID of the client that will get the reserved IP address.
circuitIdType String
DHCP option type. Valid values: hex, string.
description String
Description.
id Integer
ID.
ip String
IP address to be reserved for the MAC address.
mac String
MAC address of the client that will get the reserved IP address.
remoteId String
Option 82 remote-ID of the client that will get the reserved IP address.
remoteIdType String
DHCP option type. Valid values: hex, string.
type String
DHCP reserved-address type. Valid values: mac, option82.
action string
Options for the DHCP server to configure the client with the reserved MAC address. Valid values: assign, block, reserved.
circuitId string
Option 82 circuit-ID of the client that will get the reserved IP address.
circuitIdType string
DHCP option type. Valid values: hex, string.
description string
Description.
id number
ID.
ip string
IP address to be reserved for the MAC address.
mac string
MAC address of the client that will get the reserved IP address.
remoteId string
Option 82 remote-ID of the client that will get the reserved IP address.
remoteIdType string
DHCP option type. Valid values: hex, string.
type string
DHCP reserved-address type. Valid values: mac, option82.
action str
Options for the DHCP server to configure the client with the reserved MAC address. Valid values: assign, block, reserved.
circuit_id str
Option 82 circuit-ID of the client that will get the reserved IP address.
circuit_id_type str
DHCP option type. Valid values: hex, string.
description str
Description.
id int
ID.
ip str
IP address to be reserved for the MAC address.
mac str
MAC address of the client that will get the reserved IP address.
remote_id str
Option 82 remote-ID of the client that will get the reserved IP address.
remote_id_type str
DHCP option type. Valid values: hex, string.
type str
DHCP reserved-address type. Valid values: mac, option82.
action String
Options for the DHCP server to configure the client with the reserved MAC address. Valid values: assign, block, reserved.
circuitId String
Option 82 circuit-ID of the client that will get the reserved IP address.
circuitIdType String
DHCP option type. Valid values: hex, string.
description String
Description.
id Number
ID.
ip String
IP address to be reserved for the MAC address.
mac String
MAC address of the client that will get the reserved IP address.
remoteId String
Option 82 remote-ID of the client that will get the reserved IP address.
remoteIdType String
DHCP option type. Valid values: hex, string.
type String
DHCP reserved-address type. Valid values: mac, option82.

ServerTftpServer
, ServerTftpServerArgs

TftpServer string
TFTP server.
TftpServer string
TFTP server.
tftpServer String
TFTP server.
tftpServer string
TFTP server.
tftp_server str
TFTP server.
tftpServer String
TFTP server.

ServerVciString
, ServerVciStringArgs

VciString string
VCI strings.
VciString string
VCI strings.
vciString String
VCI strings.
vciString string
VCI strings.
vci_string str
VCI strings.
vciString String
VCI strings.

Import

SystemDhcp Server can be imported using any of these accepted formats:

$ pulumi import fortios:system/dhcp/server:Server labelname {{fosid}}
Copy

If you do not want to import arguments of block:

$ export “FORTIOS_IMPORT_TABLE”=“false”

$ pulumi import fortios:system/dhcp/server:Server labelname {{fosid}}
Copy

$ unset “FORTIOS_IMPORT_TABLE”

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortios pulumiverse/pulumi-fortios
License
Apache-2.0
Notes
This Pulumi package is based on the fortios Terraform Provider.
Fortios v0.0.6 published on Tuesday, Jul 9, 2024 by pulumiverse
pulumiverse/pulumi-fortios