Spec-Zone.ru › Ansible

fortinet.fortios.fortios_system_dhcp_server модуль – Настройка DHCP-серверов в FortiOS и FortiGate Fortinet.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные зависимости, см. Требования для подробностей.

Чтобы использовать его в книге задач, укажите: fortinet.fortios.fortios_system_dhcp_server.

Добавлена в fortinet.fortios 2.0.0

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

Описание

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

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

string

Токенная аутентификация. Создается в GUI Fortigate.

enable_log

boolean

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

Варианты:

  • false ← (default)
  • true

member_path

string

Путь к атрибуту члена для операции.

Разделяется символом слеша, если атрибутов больше одного.

Параметр, помеченный как member_path, является допустимым для выполнения операции с членом.

member_state

string

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

При указании member_state опция state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / required

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

Варианты:

  • "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 (кодирование base 64).

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.

Choices:

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

domain

string

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

exclude_range

list / elements=dictionary

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

end_ip

string

Конец диапазона IP.

id

integer / required

ID. см. <a href=’#notes’>Примечания</a>.

lease_time

integer

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

start_ip

string

Начало диапазона IP.

uci_match

string

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

Choices:

  • "disable"
  • "enable"

uci_string

list / elements=dictionary

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

uci_string

string / required

Строки UCI.

vci_match

string

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

Choices:

  • "disable"
  • "enable"

vci_string

list / elements=dictionary

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

vci_string

string / required

Строки VCI.

filename

string

Имя загрузочного файла на TFTP-сервере.

forticlient_on_net_status

string

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

Choices:

  • "disable"
  • "enable"

id

integer / required

ID. см. <a href=’#notes’>Примечания</a>.

interface

string

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

ip_mode

string

Метод, используемый для назначения IP-адреса клиенту.

Choices:

  • "range"
  • "usrgrp"

ip_range

list / elements=dictionary

Конфигурация диапазона IP DHCP.

end_ip

string

Конец диапазона IP.

id

integer / required

ID. см. <a href=’#notes’>Примечания</a>.

lease_time

integer

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

start_ip

string

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

uci_match

string

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

Choices:

  • "disable"
  • "enable"

uci_string

list / elements=dictionary

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

uci_string

string / required

Строки UCI.

vci_match

string

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

Choices:

  • "disable"
  • "enable"

vci_string

list / elements=dictionary

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

vci_string

string / required

Строки VCI.

ipsec_lease_hold

integer

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

lease_time

integer

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

mac_acl_default_action

string

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

Choices:

  • "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

Параметры для назначения серверов протокола сетевого времени (NTP) клиентам DHCP.

Choices:

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

options

list / elements=dictionary

Параметры DHCP.

code

integer

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

id

integer / required

ID. см. <a href=’#notes’>Примечания</a>.

ip

list / elements=string

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

type

string

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

Choices:

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

uci_match

string

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

Варианты:

  • "disable"
  • "enable"

uci_string

list / elements=dictionary

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

uci_string

string / required

Строки UCI.

value

string

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

vci_match

string

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

Варианты:

  • "disable"
  • "enable"

vci_string

list / elements=dictionary

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

vci_string

string / required

Строки VCI.

relay_agent

string

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

reserved_address

list / elements=dictionary

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

action

string

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

Варианты:

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

circuit_id

string

Параметр 82 circuit-ID клиента, который получит зарезервированный IP-адрес.

circuit_id_type

string

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

Варианты:

  • "hex"
  • "string"

description

string

Описание.

id

integer / required

ID. см. <a href=’#notes’>Примечания</a>.

ip

string

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

mac

string

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

remote_id

string

Параметр 82 remote-ID клиента, который получит зарезервированный 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.

Choices:

  • "disable"
  • "enable"

tftp_server

list / elements=dictionary

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

tftp_server

string / required

TFTP-сервер.

timezone

string

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

Choices:

  • "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-сервера для установки часового пояса клиента.

Choices:

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

vci_match

string

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

Choices:

  • "disable"
  • "enable"

vci_string

list / elements=dictionary

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

vci_string

string / required

Строки 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).

wifi_ac_service

string

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

Choices:

  • "specify"
  • "local"

wins_server1

string

WINS-сервер 1.

wins_server2

string

WINS-сервер 2.

vdom

string

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

Default: "root"

Примечания

Примечание

  • Мы настоятельно рекомендуем использовать собственное значение в качестве идентификатора вместо 0. Хотя «0» — это специальный заполнитель, позволяющий бэкенду назначать последний доступный номер для объекта, он имеет ограничения. Дополнительные сведения см. в разделе «Вопросы и ответы».
  • Устаревший fortiosapi был заменен, httpapi — предпочтительный способ запуска playbook’ев.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure DHCP servers.
  fortinet.fortios.fortios_system_dhcp_server:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_dhcp_server:
          auto_configuration: "disable"
          auto_managed_status: "disable"
          conflicted_ip_timeout: "1800"
          ddns_auth: "disable"
          ddns_key: "<your_own_value>"
          ddns_keyname: "<your_own_value>"
          ddns_server_ip: "<your_own_value>"
          ddns_ttl: "300"
          ddns_update: "disable"
          ddns_update_override: "disable"
          ddns_zone: "<your_own_value>"
          default_gateway: "<your_own_value>"
          dhcp_settings_from_fortiipam: "disable"
          dns_server1: "<your_own_value>"
          dns_server2: "<your_own_value>"
          dns_server3: "<your_own_value>"
          dns_server4: "<your_own_value>"
          dns_service: "local"
          domain: "<your_own_value>"
          exclude_range:
              -
                  end_ip: "<your_own_value>"
                  id: "24"
                  lease_time: "0"
                  start_ip: "<your_own_value>"
                  uci_match: "disable"
                  uci_string:
                      -
                          uci_string: "<your_own_value>"
                  vci_match: "disable"
                  vci_string:
                      -
                          vci_string: "<your_own_value>"
          filename: "<your_own_value>"
          forticlient_on_net_status: "disable"
          id: "35"
          interface: "<your_own_value> (source system.interface.name)"
          ip_mode: "range"
          ip_range:
              -
                  end_ip: "<your_own_value>"
                  id: "40"
                  lease_time: "0"
                  start_ip: "<your_own_value>"
                  uci_match: "disable"
                  uci_string:
                      -
                          uci_string: "<your_own_value>"
                  vci_match: "disable"
                  vci_string:
                      -
                          vci_string: "<your_own_value>"
          ipsec_lease_hold: "60"
          lease_time: "604800"
          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: "0"
                  id: "60"
                  ip: "<your_own_value>"
                  type: "hex"
                  uci_match: "disable"
                  uci_string:
                      -
                          uci_string: "<your_own_value>"
                  value: "<your_own_value>"
                  vci_match: "disable"
                  vci_string:
                      -
                          vci_string: "<your_own_value>"
          relay_agent: "<your_own_value>"
          reserved_address:
              -
                  action: "assign"
                  circuit_id: "<your_own_value>"
                  circuit_id_type: "hex"
                  description: "<your_own_value>"
                  id: "76"
                  ip: "<your_own_value>"
                  mac: "<your_own_value>"
                  remote_id: "<your_own_value>"
                  remote_id_type: "hex"
                  type: "mac"
          server_type: "regular"
          shared_subnet: "disable"
          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_ac_service: "specify"
          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

строка

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

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

Пример: "id"

name

строка

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

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

Пример: "urlfilter"

path

строка

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

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

Пример: "webfilter"

revision

строка

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

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

Пример: "17.0.2.10658"

serial

строка

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

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

Пример: "FGVMEVYYQT3AB5352"

status

строка

Указание результата операции

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

Пример: "success"

vdom

строка

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

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

Пример: "root"

version

строка

Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_dhcp_server_module.html

Spec-Zone.ru

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