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

fortios.system/dhcp.getServer

Explore with Pulumi AI

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

    Use this data source to get information on an fortios systemdhcp server

    Using getServer

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOptions): Output<GetServerResult>
    def get_server(fosid: Optional[int] = None,
               vdomparam: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetServerResult
def get_server_output(fosid: Optional[pulumi.Input[int]] = None,
               vdomparam: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetServerResult]
    func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput

    > Note: This function is named LookupServer in the Go SDK.

    public static class GetServer 
{
    public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
    public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: fortios:system/dhcp/getServer:getServer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Fosid int
    Specify the fosid of the desired systemdhcp server.
    Vdomparam string
    Specifies the vdom to which the data source 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.
    Fosid int
    Specify the fosid of the desired systemdhcp server.
    Vdomparam string
    Specifies the vdom to which the data source 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.
    fosid Integer
    Specify the fosid of the desired systemdhcp server.
    vdomparam String
    Specifies the vdom to which the data source 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.
    fosid number
    Specify the fosid of the desired systemdhcp server.
    vdomparam string
    Specifies the vdom to which the data source 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.
    fosid int
    Specify the fosid of the desired systemdhcp server.
    vdomparam str
    Specifies the vdom to which the data source 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.
    fosid Number
    Specify the fosid of the desired systemdhcp server.
    vdomparam String
    Specifies the vdom to which the data source 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.

    getServer Result

    The following output properties are available:

    AutoConfiguration string
    Enable/disable auto configuration.
    AutoManagedStatus string
    Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM.
    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.
    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.
    DdnsUpdateOverride string
    Enable/disable DDNS update override for DHCP.
    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.
    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.
    Domain string
    Domain name suffix for the IP addresses that the DHCP server assigns to clients.
    ExcludeRanges List<Pulumiverse.Fortios.System.Dhcp.Outputs.GetServerExcludeRange>
    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.
    Fosid int
    ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    Interface string
    DHCP server can assign IP configurations to clients connected to this interface.
    IpMode string
    Method used to assign client IP.
    IpRanges List<Pulumiverse.Fortios.System.Dhcp.Outputs.GetServerIpRange>
    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 default lease time.
    MacAclDefaultAction string
    MAC access control default action (allow or block assigning IP settings).
    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.
    Options List<Pulumiverse.Fortios.System.Dhcp.Outputs.GetServerOption>
    DHCP options. The structure of options block is documented below.
    RelayAgent string
    Relay agent IP.
    ReservedAddresses List<Pulumiverse.Fortios.System.Dhcp.Outputs.GetServerReservedAddress>
    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.
    SharedSubnet string
    Enable/disable shared subnet.
    Status string
    Enable/disable this DHCP configuration.
    TftpServers List<Pulumiverse.Fortios.System.Dhcp.Outputs.GetServerTftpServer>
    TFTP server.
    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.
    VciMatch string
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    VciStrings List<Pulumiverse.Fortios.System.Dhcp.Outputs.GetServerVciString>
    VCI strings.
    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
    WinsServer1 string
    WINS server 1.
    WinsServer2 string
    WINS server 2.
    Vdomparam string
    AutoConfiguration string
    Enable/disable auto configuration.
    AutoManagedStatus string
    Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM.
    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.
    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.
    DdnsUpdateOverride string
    Enable/disable DDNS update override for DHCP.
    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.
    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.
    Domain string
    Domain name suffix for the IP addresses that the DHCP server assigns to clients.
    ExcludeRanges []GetServerExcludeRange
    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.
    Fosid int
    ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    Interface string
    DHCP server can assign IP configurations to clients connected to this interface.
    IpMode string
    Method used to assign client IP.
    IpRanges []GetServerIpRange
    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 default lease time.
    MacAclDefaultAction string
    MAC access control default action (allow or block assigning IP settings).
    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.
    Options []GetServerOption
    DHCP options. The structure of options block is documented below.
    RelayAgent string
    Relay agent IP.
    ReservedAddresses []GetServerReservedAddress
    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.
    SharedSubnet string
    Enable/disable shared subnet.
    Status string
    Enable/disable this DHCP configuration.
    TftpServers []GetServerTftpServer
    TFTP server.
    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.
    VciMatch string
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    VciStrings []GetServerVciString
    VCI strings.
    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
    WinsServer1 string
    WINS server 1.
    WinsServer2 string
    WINS server 2.
    Vdomparam string
    autoConfiguration String
    Enable/disable auto configuration.
    autoManagedStatus String
    Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM.
    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.
    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.
    ddnsUpdateOverride String
    Enable/disable DDNS update override for DHCP.
    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.
    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.
    domain String
    Domain name suffix for the IP addresses that the DHCP server assigns to clients.
    excludeRanges List<GetServerExcludeRange>
    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.
    fosid Integer
    ID.
    id String
    The provider-assigned unique ID for this managed resource.
    interface_ String
    DHCP server can assign IP configurations to clients connected to this interface.
    ipMode String
    Method used to assign client IP.
    ipRanges List<GetServerIpRange>
    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 default lease time.
    macAclDefaultAction String
    MAC access control default action (allow or block assigning IP settings).
    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.
    options List<GetServerOption>
    DHCP options. The structure of options block is documented below.
    relayAgent String
    Relay agent IP.
    reservedAddresses List<GetServerReservedAddress>
    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.
    sharedSubnet String
    Enable/disable shared subnet.
    status String
    Enable/disable this DHCP configuration.
    tftpServers List<GetServerTftpServer>
    TFTP server.
    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.
    vciMatch String
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vciStrings List<GetServerVciString>
    VCI strings.
    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
    winsServer1 String
    WINS server 1.
    winsServer2 String
    WINS server 2.
    vdomparam String
    autoConfiguration string
    Enable/disable auto configuration.
    autoManagedStatus string
    Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM.
    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.
    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.
    ddnsUpdateOverride string
    Enable/disable DDNS update override for DHCP.
    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.
    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.
    domain string
    Domain name suffix for the IP addresses that the DHCP server assigns to clients.
    excludeRanges GetServerExcludeRange[]
    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.
    fosid number
    ID.
    id string
    The provider-assigned unique ID for this managed resource.
    interface string
    DHCP server can assign IP configurations to clients connected to this interface.
    ipMode string
    Method used to assign client IP.
    ipRanges GetServerIpRange[]
    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 default lease time.
    macAclDefaultAction string
    MAC access control default action (allow or block assigning IP settings).
    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.
    options GetServerOption[]
    DHCP options. The structure of options block is documented below.
    relayAgent string
    Relay agent IP.
    reservedAddresses GetServerReservedAddress[]
    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.
    sharedSubnet string
    Enable/disable shared subnet.
    status string
    Enable/disable this DHCP configuration.
    tftpServers GetServerTftpServer[]
    TFTP server.
    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.
    vciMatch string
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vciStrings GetServerVciString[]
    VCI strings.
    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
    winsServer1 string
    WINS server 1.
    winsServer2 string
    WINS server 2.
    vdomparam string
    auto_configuration str
    Enable/disable auto configuration.
    auto_managed_status str
    Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM.
    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.
    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.
    ddns_update_override str
    Enable/disable DDNS update override for DHCP.
    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.
    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.
    domain str
    Domain name suffix for the IP addresses that the DHCP server assigns to clients.
    exclude_ranges Sequence[GetServerExcludeRange]
    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.
    fosid int
    ID.
    id str
    The provider-assigned unique ID for this managed resource.
    interface str
    DHCP server can assign IP configurations to clients connected to this interface.
    ip_mode str
    Method used to assign client IP.
    ip_ranges Sequence[GetServerIpRange]
    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 default lease time.
    mac_acl_default_action str
    MAC access control default action (allow or block assigning IP settings).
    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.
    options Sequence[GetServerOption]
    DHCP options. The structure of options block is documented below.
    relay_agent str
    Relay agent IP.
    reserved_addresses Sequence[GetServerReservedAddress]
    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.
    shared_subnet str
    Enable/disable shared subnet.
    status str
    Enable/disable this DHCP configuration.
    tftp_servers Sequence[GetServerTftpServer]
    TFTP server.
    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.
    vci_match str
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vci_strings Sequence[GetServerVciString]
    VCI strings.
    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
    wins_server1 str
    WINS server 1.
    wins_server2 str
    WINS server 2.
    vdomparam str
    autoConfiguration String
    Enable/disable auto configuration.
    autoManagedStatus String
    Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM.
    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.
    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.
    ddnsUpdateOverride String
    Enable/disable DDNS update override for DHCP.
    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.
    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.
    domain String
    Domain name suffix for the IP addresses that the DHCP server assigns to clients.
    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.
    fosid Number
    ID.
    id String
    The provider-assigned unique ID for this managed resource.
    interface String
    DHCP server can assign IP configurations to clients connected to this interface.
    ipMode String
    Method used to assign client IP.
    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 default lease time.
    macAclDefaultAction String
    MAC access control default action (allow or block assigning IP settings).
    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.
    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.
    sharedSubnet String
    Enable/disable shared subnet.
    status String
    Enable/disable this DHCP configuration.
    tftpServers List<Property Map>
    TFTP server.
    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.
    vciMatch String
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vciStrings List<Property Map>
    VCI strings.
    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
    winsServer1 String
    WINS server 1.
    winsServer2 String
    WINS server 2.
    vdomparam String

    Supporting Types

    GetServerExcludeRange

    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.
    UciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.GetServerExcludeRangeUciString>
    UCI strings.
    VciMatch string
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    VciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.GetServerExcludeRangeVciString>
    VCI strings.
    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.
    UciStrings []GetServerExcludeRangeUciString
    UCI strings.
    VciMatch string
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    VciStrings []GetServerExcludeRangeVciString
    VCI strings.
    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.
    uciStrings List<GetServerExcludeRangeUciString>
    UCI strings.
    vciMatch String
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vciStrings List<GetServerExcludeRangeVciString>
    VCI strings.
    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.
    uciStrings GetServerExcludeRangeUciString[]
    UCI strings.
    vciMatch string
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vciStrings GetServerExcludeRangeVciString[]
    VCI strings.
    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.
    uci_strings Sequence[GetServerExcludeRangeUciString]
    UCI strings.
    vci_match str
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vci_strings Sequence[GetServerExcludeRangeVciString]
    VCI strings.
    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.
    uciStrings List<Property Map>
    UCI strings.
    vciMatch String
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vciStrings List<Property Map>
    VCI strings.

    GetServerExcludeRangeUciString

    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.

    GetServerExcludeRangeVciString

    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.

    GetServerIpRange

    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.
    UciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.GetServerIpRangeUciString>
    UCI strings.
    VciMatch string
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    VciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.GetServerIpRangeVciString>
    VCI strings.
    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.
    UciStrings []GetServerIpRangeUciString
    UCI strings.
    VciMatch string
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    VciStrings []GetServerIpRangeVciString
    VCI strings.
    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.
    uciStrings List<GetServerIpRangeUciString>
    UCI strings.
    vciMatch String
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vciStrings List<GetServerIpRangeVciString>
    VCI strings.
    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.
    uciStrings GetServerIpRangeUciString[]
    UCI strings.
    vciMatch string
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vciStrings GetServerIpRangeVciString[]
    VCI strings.
    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.
    uci_strings Sequence[GetServerIpRangeUciString]
    UCI strings.
    vci_match str
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vci_strings Sequence[GetServerIpRangeVciString]
    VCI strings.
    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.
    uciStrings List<Property Map>
    UCI strings.
    vciMatch String
    Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range.
    vciStrings List<Property Map>
    VCI strings.

    GetServerIpRangeUciString

    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.

    GetServerIpRangeVciString

    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.

    GetServerOption

    Code int
    DHCP option code.
    Id int
    ID.
    Ip string
    IP address to be reserved for the MAC address.
    Type string
    DHCP reserved-address type.
    UciMatch string
    Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range.
    UciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.GetServerOptionUciString>
    UCI strings.
    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 range.
    VciStrings List<Pulumiverse.Fortios.System.Dhcp.Inputs.GetServerOptionVciString>
    VCI strings.
    Code int
    DHCP option code.
    Id int
    ID.
    Ip string
    IP address to be reserved for the MAC address.
    Type string
    DHCP reserved-address type.
    UciMatch string
    Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range.
    UciStrings []GetServerOptionUciString
    UCI strings.
    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 range.
    VciStrings []GetServerOptionVciString
    VCI strings.
    code Integer
    DHCP option code.
    id Integer
    ID.
    ip String
    IP address to be reserved for the MAC address.
    type String
    DHCP reserved-address type.
    uciMatch String
    Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range.
    uciStrings List<GetServerOptionUciString>
    UCI strings.
    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 range.
    vciStrings List<GetServerOptionVciString>
    VCI strings.
    code number
    DHCP option code.
    id number
    ID.
    ip string
    IP address to be reserved for the MAC address.
    type string
    DHCP reserved-address type.
    uciMatch string
    Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range.
    uciStrings GetServerOptionUciString[]
    UCI strings.
    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 range.
    vciStrings GetServerOptionVciString[]
    VCI strings.
    code int
    DHCP option code.
    id int
    ID.
    ip str
    IP address to be reserved for the MAC address.
    type str
    DHCP reserved-address type.
    uci_match str
    Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range.
    uci_strings Sequence[GetServerOptionUciString]
    UCI strings.
    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 range.
    vci_strings Sequence[GetServerOptionVciString]
    VCI strings.
    code Number
    DHCP option code.
    id Number
    ID.
    ip String
    IP address to be reserved for the MAC address.
    type String
    DHCP reserved-address type.
    uciMatch String
    Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range.
    uciStrings List<Property Map>
    UCI strings.
    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 range.
    vciStrings List<Property Map>
    VCI strings.

    GetServerOptionUciString

    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.

    GetServerOptionVciString

    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.

    GetServerReservedAddress

    Action string
    Options for the DHCP server to configure the client with the reserved MAC address.
    CircuitId string
    Option 82 circuit-ID of the client that will get the reserved IP address.
    CircuitIdType string
    DHCP option type.
    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.
    Type string
    DHCP reserved-address type.
    Action string
    Options for the DHCP server to configure the client with the reserved MAC address.
    CircuitId string
    Option 82 circuit-ID of the client that will get the reserved IP address.
    CircuitIdType string
    DHCP option type.
    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.
    Type string
    DHCP reserved-address type.
    action String
    Options for the DHCP server to configure the client with the reserved MAC address.
    circuitId String
    Option 82 circuit-ID of the client that will get the reserved IP address.
    circuitIdType String
    DHCP option type.
    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.
    type String
    DHCP reserved-address type.
    action string
    Options for the DHCP server to configure the client with the reserved MAC address.
    circuitId string
    Option 82 circuit-ID of the client that will get the reserved IP address.
    circuitIdType string
    DHCP option type.
    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.
    type string
    DHCP reserved-address type.
    action str
    Options for the DHCP server to configure the client with the reserved MAC address.
    circuit_id str
    Option 82 circuit-ID of the client that will get the reserved IP address.
    circuit_id_type str
    DHCP option type.
    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.
    type str
    DHCP reserved-address type.
    action String
    Options for the DHCP server to configure the client with the reserved MAC address.
    circuitId String
    Option 82 circuit-ID of the client that will get the reserved IP address.
    circuitIdType String
    DHCP option type.
    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.
    type String
    DHCP reserved-address type.

    GetServerTftpServer

    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.

    GetServerVciString

    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.

    Package Details

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