Модуль fortinet.fortios.fortios_system_dhcp_server — настройка DHCP-серверов в Fortinet FortiOS и FortiGate.

access_token

string

Аутентификация на основе токена. Создаётся в графическом интерфейсе Fortigate.

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

• false ← (по умолчанию)
• true

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с пометкой member_path можно использовать для выполнения операции с элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан member_state, параметр state игнорируется.

Варианты:

• "present"
• "absent"

state

string / обязательный

Указывает, следует ли создать или удалить объект.

Варианты:

• "present"
• "absent"

system_dhcp_server

dictionary

Настройка DHCP-серверов.

auto_configuration

string

Включить/отключить автоматическую настройку.

Варианты:

• "disable"
• "enable"

auto_managed_status

string

Включить/отключить использование этого DHCP-сервера после назначения IP-адреса этому интерфейсу из FortiIPAM.

Варианты:

• "disable"
• "enable"

conflicted_ip_timeout

integer

Время в секундах, в течение которого нужно ждать после удаления конфликтующего IP-адреса из диапазона DHCP, прежде чем его можно будет использовать повторно.

ddns_auth

string

Режим аутентификации DDNS.

Варианты:

• "disable"
• "tsig"

ddns_key

string

Ключ обновления DDNS (кодировка Base64).

ddns_keyname

string

Имя ключа обновления DDNS.

ddns_server_ip

string

IP-адрес сервера DDNS.

ddns_ttl

integer

TTL.

ddns_update

string

Включить/отключить обновление DDNS для DHCP.

Варианты:

• "disable"
• "enable"

ddns_update_override

string

Включить/отключить переопределение обновления DDNS для DHCP.

Варианты:

• "disable"
• "enable"

ddns_zone

string

Зона доменного имени (например, DDNS.com).

default_gateway

string

IP-адрес шлюза по умолчанию, назначаемый DHCP-сервером.

dhcp_settings_from_fortiipam

string

Включить/отключить получение настроек DHCP-сервера из FortiIPAM.

Варианты:

• "disable"
• "enable"

dns_server1

string

DNS-сервер 1.

dns_server2

string

DNS-сервер 2.

dns_server3

string

DNS-сервер 3.

dns_server4

string

DNS-сервер 4.

dns_service

string

Параметры назначения DNS-серверов клиентам DHCP.

Варианты:

• "local"
• "default"
• "specify"

domain

string

Суффикс доменного имени для IP-адресов, которые DHCP-сервер назначает клиентам.

exclude_range

list / elements=dictionary

Исключить один или несколько диапазонов IP-адресов из числа назначаемых клиентам.

end_ip

string

Конец диапазона IP-адресов.

id

integer / обязательный

Идентификатор. См. <a href=’#notes’>Примечания</a>.

lease_time

integer

Время аренды в секундах; 0 означает время аренды по умолчанию.

start_ip

string

Начало диапазона IP-адресов.

uci_match

string

Включить/отключить сопоставление идентификатора класса пользователя (UCI). Если этот параметр включён, адреса из данного диапазона назначаются только в ответ на запросы DHCP с соответствующим UCI.

Варианты:

• "disable"
• "enable"

uci_string

list / elements=dictionary

Одна или несколько строк UCI в кавычках, разделённых пробелами.

uci_string

string / обязательный

Строки UCI.

vci_match

string

Включить/отключить сопоставление идентификатора класса производителя (VCI). Если этот параметр включён, адреса из данного диапазона назначаются только в ответ на запросы DHCP с соответствующим VCI.

Варианты:

• "disable"
• "enable"

vci_string

list / elements=dictionary

Одна или несколько строк VCI в кавычках, разделённых пробелами.

vci_string

string / обязательный

Строки VCI.

filename

string

Имя файла загрузки на сервере TFTP.

forticlient_on_net_status

string

Включить/отключить службу FortiClient-On-Net для этого DHCP-сервера.

Варианты:

• "disable"
• "enable"

id

integer / обязательный

Идентификатор. См. <a href=’#notes’>Примечания</a>.

interface

string

DHCP-сервер может назначать IP-конфигурации клиентам, подключённым к этому интерфейсу. Источник: system.interface.name.

ip_mode

string

Метод назначения IP-адреса клиенту.

Варианты:

• "range"
• "usrgrp"

ip_range

list / elements=dictionary

Настройка диапазона IP-адресов DHCP.

end_ip

string

Конец диапазона IP-адресов.

id

integer / обязательный

Идентификатор. См. <a href=’#notes’>Примечания</a>.

lease_time

integer

Время аренды в секундах; 0 означает время аренды по умолчанию.

start_ip

string

Начало диапазона IP-адресов.

uci_match

string

Включить/отключить сопоставление идентификатора класса пользователя (UCI). Если этот параметр включён, адреса из данного диапазона назначаются только в ответ на запросы DHCP с соответствующим UCI.

Варианты:

• "disable"
• "enable"

uci_string

list / elements=dictionary

Одна или несколько строк UCI в кавычках, разделённых пробелами.

uci_string

string / обязательный

Строки UCI.

vci_match

string

Включить/отключить сопоставление идентификатора класса производителя (VCI). Если этот параметр включён, адреса из данного диапазона назначаются только в ответ на запросы DHCP с соответствующим VCI.

Варианты:

• "disable"
• "enable"

vci_string

list / elements=dictionary

Одна или несколько строк VCI в кавычках, разделённых пробелами.

vci_string

string / обязательный

Строки VCI.

ipsec_lease_hold

integer

Срок аренды DHCP через IPsec истекает через указанное количество секунд после разрыва туннеля (0 отключает принудительное истечение срока действия).

lease_time

integer

Время аренды в секундах; 0 означает неограниченный срок.

mac_acl_default_action

string

Действие по умолчанию для управления доступом по MAC-адресу (разрешить или запретить назначение IP-параметров).

Варианты:

• "assign"
• "block"

netmask

string

Маска подсети, назначаемая DHCP-сервером.

next_server

string

IP-адрес сервера (например, TFTP-сервера), с которого клиенты DHCP могут загрузить файл загрузки.

ntp_server1

string

NTP-сервер 1.

ntp_server2

string

NTP-сервер 2.

ntp_server3

string

NTP-сервер 3.

ntp_service

string

Параметры назначения серверов Network Time Protocol (NTP) клиентам DHCP.

Варианты:

• "local"
• "default"
• "specify"

options

list / elements=dictionary

Параметры DHCP.

code

integer

Код параметра DHCP.

id

integer / обязательный

Идентификатор. См. <a href=’#notes’>Примечания</a>.

ip

list / elements=string

IP-адреса параметра DHCP.

type

string

Тип параметра DHCP.

Варианты:

• "hex"
• "string"
• "ip"
• "fqdn"

uci_match

string

Включить или отключить сопоставление идентификатора класса пользователя (UCI). Если параметр включен, этот параметр предоставляется только в ответ на запросы DHCP с совпадающим UCI.

Варианты:

• "disable"
• "enable"

uci_string

list / elements=dictionary

Одна или несколько строк UCI в кавычках, разделенных пробелами.

uci_string

string / обязательный

Строки UCI.

value

string

Значение параметра DHCP.

vci_match

string

Включить или отключить сопоставление идентификатора класса производителя (VCI). Если параметр включен, этот параметр предоставляется только в ответ на запросы DHCP с совпадающим VCI.

Варианты:

• "disable"
• "enable"

vci_string

list / elements=dictionary

Одна или несколько строк VCI в кавычках, разделенных пробелами.

vci_string

string / обязательный

Строки VCI.

relay_agent

string

IP-адрес агента ретрансляции.

reserved_address

list / elements=dictionary

Параметры, позволяющие DHCP-серверу назначать настройки IP-адреса определенным MAC-адресам.

action

string

Параметры настройки клиента DHCP-сервером с зарезервированным MAC-адресом.

Варианты:

• "assign"
• "block"
• "reserved"

circuit_id

string

Идентификатор канала Circuit-ID параметра 82 для клиента, которому будет назначен зарезервированный IP-адрес.

circuit_id_type

string

Тип параметра DHCP.

Варианты:

• "hex"
• "string"

description

string

Описание.

id

integer / обязательный

Идентификатор. См. <a href=’#notes’>Примечания</a>.

ip

string

IP-адрес, который будет зарезервирован для MAC-адреса.

mac

string

MAC-адрес клиента, которому будет назначен зарезервированный IP-адрес.

remote_id

string

Идентификатор Remote-ID параметра 82 для клиента, которому будет назначен зарезервированный IP-адрес.

remote_id_type

string

Тип параметра DHCP.

Варианты:

• "hex"
• "string"

type

string

Тип зарезервированного адреса DHCP.

Варианты:

• "mac"
• "option82"

server_type

string

DHCP-сервер может быть обычным DHCP-сервером или DHCP-сервером IPsec.

Варианты:

• "regular"
• "ipsec"

shared_subnet

string

Включить или отключить общую подсеть.

Варианты:

• "disable"
• "enable"

status

string

Включить или отключить эту конфигурацию DHCP.

Варианты:

• "disable"
• "enable"

tftp_server

list / elements=dictionary

Одно или несколько имен узлов или IP-адресов TFTP-серверов в кавычках, разделенных пробелами.

tftp_server

string / обязательный

TFTP-сервер.

timezone

string

Выберите часовой пояс, назначаемый клиентам DHCP. Источник: system.timezone.name.

Варианты:

• "01"
• "02"
• "03"
• "04"
• "05"
• "81"
• "06"
• "07"
• "08"
• "09"
• "10"
• "11"
• "12"
• "13"
• "74"
• "14"
• "77"
• "15"
• "87"
• "16"
• "17"
• "18"
• "19"
• "20"
• "75"
• "21"
• "22"
• "23"
• "24"
• "80"
• "79"
• "25"
• "26"
• "27"
• "28"
• "78"
• "29"
• "30"
• "31"
• "32"
• "33"
• "34"
• "35"
• "36"
• "37"
• "38"
• "83"
• "84"
• "40"
• "85"
• "39"
• "41"
• "42"
• "43"
• "44"
• "45"
• "46"
• "47"
• "51"
• "48"
• "49"
• "50"
• "52"
• "53"
• "54"
• "55"
• "56"
• "57"
• "58"
• "59"
• "60"
• "61"
• "62"
• "63"
• "64"
• "65"
• "66"
• "67"
• "68"
• "69"
• "70"
• "71"
• "72"
• "00"
• "82"
• "73"
• "86"
• "76"

timezone_option

string

Параметры, с помощью которых DHCP-сервер задает часовой пояс клиента.

Варианты:

• "disable"
• "default"
• "specify"

vci_match

string

Включить или отключить сопоставление идентификатора класса производителя (VCI). Если параметр включен, обслуживаются только запросы DHCP с совпадающим VCI.

Варианты:

• "disable"
• "enable"

vci_string

list / elements=dictionary

Одна или несколько строк VCI в кавычках, разделенных пробелами.

vci_string

string / обязательный

Строки VCI.

wifi_ac1

string

IP-адрес контроллера беспроводного доступа WiFi 1 (параметр DHCP 138, RFC 5417).

wifi_ac2

string

IP-адрес контроллера беспроводного доступа WiFi 2 (параметр DHCP 138, RFC 5417).

wifi_ac3

string

IP-адрес контроллера беспроводного доступа WiFi 3 (параметр DHCP 138, RFC 5417).

wifi_ac_service

string

Параметры назначения контроллеров беспроводного доступа WiFi клиентам DHCP.

Варианты:

• "specify"
• "local"

wins_server1

string

Сервер WINS 1.

wins_server2

string

Сервер WINS 2.

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate для последней выполненной операции

Возвращается: всегда

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем обращении к FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер ревизии

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"