fortios_system_dhcp_server – Настройка DHCP-серверов в Fortinet’s FortiOS и FortiGate
Новое в версии 2.8.
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию system_dhcp и категорию сервера. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.5
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| host строка | IP-адрес FortiOS или FortiGate. | |||
| https логический тип |
| Указывает, нужно ли использовать протокол HTTPS при запросах к FortiGate. | ||
| password строка | По умолчанию: "" | Пароль FortiOS или FortiGate. | ||
| ssl_verify логический тип добавлено в 2.9 |
| Обеспечивает проверку сертификата FortiGate с помощью надлежащего центра сертификации. | ||
| state строка добавлено в 2.9 |
| Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущей версии на более глубоком уровне. Он был перемещен на этот внешний уровень. | ||
| system_dhcp_server словарь | По умолчанию: null | Настройка DHCP-серверов. | ||
| auto_configuration строка |
| Включение/выключение автоматической настройки. | ||
| conflicted_ip_timeout целое число | Время в секундах ожидания после удаления конфликтующего IP-адреса из диапазона DHCP, прежде чем он сможет быть повторно использован. | |||
| ddns_auth строка |
| Режим аутентификации DDNS. | ||
| ddns_key строка | Ключ обновления DDNS (кодировка base 64). | |||
| ddns_keyname строка | Имя ключа обновления DDNS. | |||
| ddns_server_ip строка | IP-адрес сервера DDNS. | |||
| ddns_ttl целое число | TTL. | |||
| ddns_update строка |
| Включение/выключение обновления DDNS для DHCP. | ||
| ddns_update_override строка |
| Включение/выключение переопределения обновления DDNS для DHCP. | ||
| ddns_zone строка | Зона вашего доменного имени (например, DDNS.com). | |||
| default_gateway строка | IP-адрес шлюза по умолчанию, назначенный DHCP-сервером. | |||
| dns_server1 строка | DNS-сервер 1. | |||
| dns_server2 строка | DNS-сервер 2. | |||
| dns_server3 строка | DNS-сервер 3. | |||
| dns_service строка |
| Варианты назначения DNS-серверов клиентам DHCP. | ||
| domain строка | Суффикс доменного имени для IP-адресов, которые DHCP-сервер назначает клиентам. | |||
| exclude_range список | Исключение одного или нескольких диапазонов IP-адресов из назначения клиентам. | |||
| end_ip строка | Конец диапазона IP. | |||
| id целое число / обязательно | Идентификатор. | |||
| start_ip строка | Начало диапазона IP. | |||
| filename строка | Имя файла загрузки на TFTP-сервере. | |||
| forticlient_on_net_status строка |
| Включение/выключение службы FortiClient-On-Net для этого DHCP-сервера. | ||
| id целое число / обязательно | Идентификатор. | |||
| interface строка | DHCP-сервер может назначает IP-конфигурации клиентам, подключенным к этому интерфейсу. Имя интерфейса системы-источника. | |||
| ip_mode строка |
| Метод, используемый для назначения IP-адресов клиентам. | ||
| ip_range список | Настройка диапазона IP DHCP. | |||
| end_ip строка | Конец диапазона IP. | |||
| id целое число / обязательно | Идентификатор. | |||
| start_ip строка | Начало диапазона IP. | |||
| ipsec_lease_hold целое число | Время в секундах, в течение которого аренда DHCP по IPsec сохраняется после разрыва туннеля (0 для отключения принудительного истечения срока действия). | |||
| lease_time целое число | Время аренды в секундах, 0 означает неограниченное время. | |||
| mac_acl_default_action строка |
| Действие по умолчанию для управления доступом MAC (разрешить или заблокировать назначение IP-настроек). | ||
| netmask строка | Маска сети, назначенная DHCP-сервером. | |||
| next_server строка | IP-адрес сервера (например, TFTP-сервера), с которого клиенты DHCP могут загружать файл загрузки. | |||
| ntp_server1 строка | NTP-сервер 1. | |||
| ntp_server2 строка | NTP-сервер 2. | |||
| ntp_server3 string | NTP сервер 3. | |||
| ntp_service string |
| Параметры для назначения серверов протокола Network Time Protocol (NTP) клиентам DHCP. | ||
| options list | Параметры DHCP. | |||
| code integer | Код параметра DHCP. | |||
| id integer / required | Идентификатор. | |||
| ip string | IP-адреса параметров DHCP. | |||
| type string |
| Тип параметра DHCP. | ||
| value string | Значение параметра DHCP. | |||
| reserved_address list | Параметры для назначения DHCP-сервером настроек IP конкретным MAC-адресам. | |||
| action string |
| Параметры для конфигурации DHCP-сервера с резервированным MAC-адресом клиента. | ||
| description string | Описание. | |||
| id integer / required | Идентификатор. | |||
| ip string | IP-адрес, который будет зарезервирован для MAC-адреса. | |||
| mac string | MAC-адрес клиента, которому будет назначен зарезервированный IP-адрес. | |||
| server_type string |
| DHCP-сервер может быть обычным DHCP-сервером или IPsec DHCP-сервером. | ||
| state string |
| Устарело Начиная с Ansible 2.9, рекомендуется использовать параметр «state» на верхнем уровне. Указывает, нужно ли создать или удалить объект. | ||
| status string |
| Включить/выключить эту конфигурацию DHCP. | ||
| tftp_server list | Один или несколько имен хостов или IP-адресов TFTP-серверов в кавычках, разделенных пробелами. | |||
| tftp_server string | TFTP-сервер. | |||
| timezone string |
| Выберите часовой пояс, который будет назначен клиентам DHCP. | ||
| timezone_option string |
| Параметры для установки часового пояса клиента DHCP-сервером. | ||
| vci_match string |
| Включить/выключить сопоставление идентификатора класса поставщика (VCI). При включении обслуживаются только запросы DHCP с соответствующим VCI. | ||
| vci_string list | Одно или несколько строк 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). | |||
| wins_server1 string | WINS-сервер 1. | |||
| wins_server2 string | WINS-сервер 2. | |||
| username string | Имя пользователя FortiOS или FortiGate. | |||
| vdom string | По умолчанию: "root" | Виртуальная область (vdom) из предварительно определённых. Vdom — это виртуальный экземпляр FortiGate, который может быть сконфигурирован и использован как отдельное устройство. | ||
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная Fortinet
- Выполняется как local_action в вашем playbook
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure DHCP servers.
fortios_system_dhcp_server:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
system_dhcp_server:
auto_configuration: "disable"
conflicted_ip_timeout: "4"
ddns_auth: "disable"
ddns_key: "<your_own_value>"
ddns_keyname: "<your_own_value>"
ddns_server_ip: "<your_own_value>"
ddns_ttl: "9"
ddns_update: "disable"
ddns_update_override: "disable"
ddns_zone: "<your_own_value>"
default_gateway: "<your_own_value>"
dns_server1: "<your_own_value>"
dns_server2: "<your_own_value>"
dns_server3: "<your_own_value>"
dns_service: "local"
domain: "<your_own_value>"
exclude_range:
-
end_ip: "<your_own_value>"
id: "21"
start_ip: "<your_own_value>"
filename: "<your_own_value>"
forticlient_on_net_status: "disable"
id: "25"
interface: "<your_own_value> (source system.interface.name)"
ip_mode: "range"
ip_range:
-
end_ip: "<your_own_value>"
id: "30"
start_ip: "<your_own_value>"
ipsec_lease_hold: "32"
lease_time: "33"
mac_acl_default_action: "assign"
netmask: "<your_own_value>"
next_server: "<your_own_value>"
ntp_server1: "<your_own_value>"
ntp_server2: "<your_own_value>"
ntp_server3: "<your_own_value>"
ntp_service: "local"
options:
-
code: "42"
id: "43"
ip: "<your_own_value>"
type: "hex"
value: "<your_own_value>"
reserved_address:
-
action: "assign"
description: "<your_own_value>"
id: "50"
ip: "<your_own_value>"
mac: "<your_own_value>"
server_type: "regular"
status: "disable"
tftp_server:
-
tftp_server: "<your_own_value>"
timezone: "01"
timezone_option: "disable"
vci_match: "disable"
vci_string:
-
vci_string: "<your_own_value>"
wifi_ac1: "<your_own_value>"
wifi_ac2: "<your_own_value>"
wifi_ac3: "<your_own_value>"
wins_server1: "<your_own_value>"
wins_server2: "<your_own_value>"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| build строка | всегда | Номер сборки образа Fortigate Пример: 1547 |
| http_method строка | всегда | Последний метод, используемый для предоставления содержимого в FortiGate Пример: PUT |
| http_status строка | всегда | Последний результат, предоставленный FortiGate по последней операции Пример: 200 |
| mkey строка | успех | Главный ключ (id), используемый в последнем вызове FortiGate Пример: id |
| name строка | всегда | Имя таблицы, используемой для выполнения запроса Пример: urlfilter |
| path строка | всегда | Путь таблицы, используемой для выполнения запроса Пример: webfilter |
| revision строка | всегда | Внутренний номер ревизии Пример: 17.0.2.10658 |
| serial строка | всегда | Серийный номер устройства Пример: FGVMEVYYQT3AB5352 |
| status строка | всегда | Указание результата операции Пример: success |
| vdom строка | всегда | Используемый виртуальный домен Пример: root |
| version строка | всегда | Версия FortiGate Пример: v5.6.3 |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_system_dhcp_server_module.html