Spec-Zone.ru › Ansible 2.8

fortios_system_dhcp_server – Настройка DHCP-серверов в Fortinet FortiOS и FortiGate

Новая в версии 2.8.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Краткое описание

  • Этот модуль позволяет настроить FortiGate или FortiOS, позволяя пользователю устанавливать и изменять системный параметр DHCP и категорию сервера. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.2

Требования

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

  • fortiosapi>=0.9.8

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
host
- / обязательно
IP-адрес FortiOS или FortiGate.
https
boolean
    Варианты:
  • no
  • да ←
Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password
-
Значение по умолчанию:
""
Пароль FortiOS или FortiGate.
system_dhcp_server
-
Значение по умолчанию:
null
Настройка DHCP-серверов.
auto-configuration
-
    Варианты:
  • отключить
  • включить
Включить/выключить автоматическую конфигурацию.
conflicted-ip-timeout
-
Время в секундах ожидания после удаления конфликтующего IP-адреса из диапазона DHCP, прежде чем он может быть повторно использован.
ddns-auth
-
    Варианты:
  • отключить
  • tsig
Режим аутентификации 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
- / обязательно
ID.
start-ip
-
Начало диапазона IP-адресов.
filename
-
Имя файла загрузки на TFTP-сервере.
forticlient-on-net-status
-
    Варианты:
  • отключить
  • включить
Включить/выключить службу FortiClient-On-Net для этого DHCP-сервера.
id
- / обязательно
ID.
interface
-
DHCP-сервер может назначать конфигурации IP клиентам, подключенным к этому интерфейсу. Источник system.interface.name.
ip-mode
-
    Варианты:
  • диапазон
  • usrgrp
Метод, используемый для назначения IP-адреса клиенту.
ip-range
-
Конфигурация диапазона DHCP IP.
end-ip
-
Конец диапазона IP-адресов.
id
- / обязательно
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
-
    Варианты:
  • локальный
  • по умолчанию
  • указать
Параметры назначения серверов протокола времени сети (NTP) клиентам DHCP.
options
-
Параметры DHCP.
code
-
Код опции DHCP.
id
- / обязательно
Идентификатор.
ip
-
IP-адреса DHCP опций.
type
-
    Варианты:
  • hex
  • string
  • ip
Тип DHCP опции.
value
-
Значение DHCP опции.
reserved-address
-
Параметры для DHCP-сервера для назначения IP-настроек определенным MAC-адресам.
action
-
    Варианты:
  • assign
  • block
  • reserved
Параметры для DHCP-сервера для настройки клиента с помощью зарезервированного MAC-адреса.
description
-
Описание.
id
- / обязательно
Идентификатор.
ip
-
IP-адрес, который будет зарезервирован для MAC-адреса.
mac
-
MAC-адрес клиента, которому будет назначен зарезервированный IP-адрес.
server-type
-
    Варианты:
  • regular
  • ipsec
DHCP-сервер может быть обычным DHCP-сервером или сервером DHCP с IPsec.
state
-
    Варианты:
  • present
  • absent
Указывает, нужно ли создать или удалить объект
status
-
    Варианты:
  • disable
  • enable
Включить/выключить эту конфигурацию DHCP.
tftp-server
-
Один или несколько имен хостов или IP-адресов TFTP-серверов в кавычках, разделенные пробелами.
tftp-server
- / обязательно
TFTP-сервер.
timezone
-
    Варианты:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 81
  • 6
  • 7
  • 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
  • 41
  • 42
  • 43
  • 39
  • 44
  • 46
  • 47
  • 51
  • 48
  • 45
  • 49
  • 50
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 62
  • 63
  • 61
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 0
  • 82
  • 73
  • 86
  • 76
Выберите часовой пояс, который нужно назначить клиентам DHCP.
timezone-option
-
    Варианты:
  • disable
  • default
  • specify
Параметры для DHCP-сервера для установки часового пояса клиента.
vci-match
-
    Варианты:
  • disable
  • enable
Включить/выключить сопоставление идентификатора класса поставщика (VCI). При включении обслуживаются только запросы DHCP с соответствующим VCI.
vci-string
-
Одно или несколько строк VCI в кавычках, разделенных пробелами.
vci-string
- / обязательно
Строки VCI.
wifi-ac1
-
IP-адрес WiFi контроллера доступа 1 (DHCP опция 138, RFC 5417).
wifi-ac2
-
IP-адрес WiFi контроллера доступа 2 (DHCP опция 138, RFC 5417).
wifi-ac3
-
IP-адрес WiFi контроллера доступа 3 (DHCP опция 138, RFC 5417).
wins-server1
-
WINS-сервер 1.
wins-server2
-
WINS-сервер 2.
username
- / обязательно
Имя пользователя FortiOS или FortiGate.
vdom
-
По умолчанию:
"root"
Виртуальная область, среди тех, которые определены ранее. vdom — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство.

Примечания

Примечание

  • Требуется библиотека fortiosapi, разработанная Fortinet
  • Выполнять как local_action в вашем playbook

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure DHCP servers.
    fortios_system_dhcp_server:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      system_dhcp_server:
        state: "present"
        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.8/modules/fortios_system_dhcp_server_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API