Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_system_dhcp6_server — настройка DHCPv6-серверов в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_dhcp6_server.

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

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

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

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

Требования

Следующие требования необходимы на узле, на котором выполняется этот модуль.

  • ansible>=2.16

Параметры

Параметр

Комментарии

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_dhcp6_server

dictionary

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

delegated_prefix_iaid

integer

IAID полученного делегированного префикса от вышестоящего интерфейса.

delegated_prefix_route

string

Включить или отключить автоматическое добавление маршрута для делегированного префикса.

Варианты:

  • "disable"
  • "enable"

dns_search_list

string

Параметры списка поиска DNS.

Варианты:

  • "delegated"
  • "specify"

dns_server1

string

DNS-сервер 1.

dns_server2

string

DNS-сервер 2.

dns_server3

string

DNS-сервер 3.

dns_server4

string

DNS-сервер 4.

dns_service

string

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

Варианты:

  • "delegated"
  • "default"
  • "specify"

domain

string

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

id

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

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

interface

string

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

ip_mode

string

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

Варианты:

  • "range"
  • "delegated"

ip_range

list / elements=dictionary

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

end_ip

string

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

id

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

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

start_ip

string

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

vci_match

string

Включить или отключить сопоставление параметров класса поставщика. Если оно включено, этот диапазон используется только для DHCP-запросов с совпадающим VC.

Варианты:

  • "disable"
  • "enable"

vci_string

list / elements=dictionary

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

vci_string

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

Строки VCI.

lease_time

integer

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

option1

string

Параметр 1.

option2

string

Параметр 2.

option3

string

Параметр 3.

options

list / elements=dictionary

Параметры DHCPv6.

code

integer

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

id

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

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

ip6

list / elements=string

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

type

string

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

Варианты:

  • "hex"
  • "string"
  • "ip6"
  • "fqdn"

value

string

Значение параметра DHCPv6 (шестнадцатеричное значение должно содержать четное количество символов).

vci_match

string

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

Варианты:

  • "disable"
  • "enable"

vci_string

list / elements=dictionary

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

vci_string

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

Строки VCI.

prefix_mode

string

Назначение префикса от клиента DHCPv6 или RA.

Варианты:

  • "dhcp6"
  • "ra"

prefix_range

list / elements=dictionary

Настройка префикса DHCP.

end_prefix

string

Конец диапазона префиксов.

id

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

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

prefix_length

integer

Длина префикса.

start_prefix

string

Начало диапазона префиксов.

rapid_commit

string

Включить или отключить поддержку быстрого подтверждения.

Варианты:

  • "disable"
  • "enable"

status

string

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

Варианты:

  • "disable"
  • "enable"

subnet

string

Подсеть или идентификатор подсети, если используется делегированный режим IP.

upstream_interface

string

Имя интерфейса, с которого поступают делегированные сведения. Источник: system.interface.name.

vdom

string

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

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

Примечания

Примечание

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

Примеры

- name: Configure DHCPv6 servers.
  fortinet.fortios.fortios_system_dhcp6_server:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_dhcp6_server:
          delegated_prefix_iaid: "0"
          delegated_prefix_route: "disable"
          dns_search_list: "delegated"
          dns_server1: "<your_own_value>"
          dns_server2: "<your_own_value>"
          dns_server3: "<your_own_value>"
          dns_server4: "<your_own_value>"
          dns_service: "delegated"
          domain: "<your_own_value>"
          id: "12"
          interface: "<your_own_value> (source system.interface.name)"
          ip_mode: "range"
          ip_range:
              -
                  end_ip: "<your_own_value>"
                  id: "17"
                  start_ip: "<your_own_value>"
                  vci_match: "disable"
                  vci_string:
                      -
                          vci_string: "<your_own_value>"
          lease_time: "604800"
          option1: "<your_own_value>"
          option2: "<your_own_value>"
          option3: "<your_own_value>"
          options:
              -
                  code: "0"
                  id: "28"
                  ip6: "<your_own_value>"
                  type: "hex"
                  value: "<your_own_value>"
                  vci_match: "disable"
                  vci_string:
                      -
                          vci_string: "<your_own_value>"
          prefix_mode: "dhcp6"
          prefix_range:
              -
                  end_prefix: "<your_own_value>"
                  id: "38"
                  prefix_length: "0"
                  start_prefix: "<your_own_value>"
          rapid_commit: "disable"
          status: "disable"
          subnet: "<your_own_value>"
          upstream_interface: "<your_own_value> (source system.interface.name)"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ

Описание

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"

Авторы

  • 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_system_dhcp6_server_module.html

Spec-Zone.ru

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