fortinet.fortios.fortios_system_dhcp_server – Настройка DHCP-серверов в FortiOS и FortiGate Fortinet.
Примечание
Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios
Чтобы использовать его в книге задач, укажите: fortinet.fortios.fortios_system_dhcp_server
Новое в версии 2.8: модуля fortinet.fortios
Обзор
- Этот модуль может настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию system_dhcp и категорию сервера. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| access_token строка | Аутентификация на основе токена. Сгенерирован из графического интерфейса Fortigate. | |||
| state строка добавлен в 2.9 fortinet.fortios |
| Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущей версии на более глубоком уровне. Он был вынесен на этот внешний уровень. | ||
| system_dhcp_server словарь | Настройка 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 клиентам, подключенным к этому интерфейсу. Источник system.interface.name. | |||
| ip_mode строка |
| Метод, используемый для назначения IP-адреса клиенту. | ||
| ip_range список / элементы=строка | Конфигурация диапазона DHCP IP. | |||
| 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 строка | NTP-сервер 3. | |||
| ntp_service строка |
| Варианты назначения серверов Network Time Protocol (NTP) клиентам DHCP. | ||
| options список / элементы=строка | DHCP-параметры. | |||
| code целое число | Код DHCP-параметра. | |||
| id целое число / обязательно | Идентификатор. | |||
| ip строка | IP-адреса DHCP-параметра. | |||
| type строка |
| Тип DHCP-параметра. | ||
| value строка | Значение DHCP-параметра. | |||
| reserved_address список / элементы=строка | Параметры DHCP-сервера для назначения параметров IP определенным MAC-адресам. | |||
| action строка |
| Варианты конфигурации DHCP-сервера для клиента с зарезервированным MAC-адресом. | ||
| description строка | Описание. | |||
| id целое число / обязательно | Идентификатор. | |||
| ip строка | IP-адрес, который будет зарезервирован для MAC-адреса. | |||
| mac строка | MAC-адрес клиента, которому будет назначен зарезервированный IP-адрес. | |||
| server_type string |
| DHCP-сервер может быть обычным DHCP-сервером или IPsec DHCP-сервером. | ||
| state string |
| Устарело Начиная с Ansible 2.9, рекомендуется использовать параметр «state» верхнего уровня. Указывает, нужно ли создавать или удалять объект. | ||
| status string |
| Включить/выключить эту конфигурацию DHCP. | ||
| tftp_server list / elements=string | Один или несколько имен хостов или IP-адресов TFTP-серверов в кавычках, разделенных пробелами. | |||
| tftp_server string | TFTP-сервер. | |||
| timezone string |
| Выберите часовой пояс, который нужно назначить клиентам DHCP. | ||
| timezone_option string |
| Параметры DHCP-сервера для установки часового пояса клиента. | ||
| vci_match string |
| Включить/выключить сопоставление идентификатора класса поставщика (VCI). При включенном режиме обслуживаются только запросы DHCP с соответствующим VCI. | ||
| vci_string list / elements=string | Один или несколько строк VCI в кавычках, разделенных пробелами. | |||
| vci_string string | Строки VCI. | |||
| wifi_ac1 string | IP-адрес контроллера беспроводной сети 1 (DHCP-опция 138, RFC 5417). | |||
| wifi_ac2 string | IP-адрес контроллера беспроводной сети 2 (DHCP-опция 138, RFC 5417). | |||
| wifi_ac3 string | IP-адрес контроллера беспроводной сети 3 (DHCP-опция 138, RFC 5417). | |||
| wins_server1 string | WINS-сервер 1. | |||
| wins_server2 string | WINS-сервер 2. | |||
| vdom string | По умолчанию: "root" | Виртуальный домен, среди тех, что определены ранее. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. | ||
Примечания
Примечание
- Модуль fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure DHCP servers.
fortios_system_dhcp_server:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
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 string | всегда | Номер сборки образа fortigate Пример: 1547 |
| http_method string | всегда | Последний метод, используемый для предоставления содержимого в FortiGate Пример: PUT |
| http_status string | всегда | Последний результат, предоставленный FortiGate при последней операции Пример: 200 |
| mkey string | успех | Главный ключ (id), используемый в последнем вызове FortiGate Пример: id |
| name string | всегда | Имя таблицы, используемой для выполнения запроса Пример: urlfilter |
| path string | всегда | Путь к таблице, используемой для выполнения запроса Пример: webfilter |
| revision string | всегда | Внутренний номер версии Пример: 17.0.2.10658 |
| serial string | всегда | Серийный номер устройства Пример: FGVMEVYYQT3AB5352 |
| status string | всегда | Указание результата операции Пример: успех |
| vdom string | всегда | Используемый виртуальный домен Пример: root |
| version string | всегда | Версия FortiGate Пример: v5.6.3 |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_system_dhcp_server_module.html