Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_switch_controller_global — настройка глобальных параметров FortiSwitch в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

Обзор

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функций и глобальной категории switch_controller. Примеры включают все параметры; перед использованием необходимо настроить их значения в соответствии с источниками данных. Проверено с 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"

switch_controller_global

dictionary

Настройка глобальных параметров FortiSwitch.

allow_multiple_interfaces

string

Включить или отключить использование нескольких интерфейсов FortiLink для резервных подключений между управляемым FortiSwitch и FortiGate.

Варианты:

  • "enable"
  • "disable"

bounce_quarantined_link

string

Включить или отключить перезапуск порта коммутатора, на котором в последний раз обнаруживалось устройство в карантине (административное отключение и повторное включение канала). Это помогает повторно запустить процесс DHCP для устройства.

Варианты:

  • "disable"
  • "enable"

custom_command

list / elements=dictionary

Список пользовательских команд для отправки на все FortiSwitch в VDOM.

command_entry

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

Список команд FortiSwitch.

command_name

string

Имя пользовательской команды для отправки на все FortiSwitch в VDOM. Источник: switch-controller.custom-command.command-name.

default_virtual_switch_vlan

string

VLAN по умолчанию для портов, добавляемых в virtual-switch. Источник: system.interface.name.

dhcp_option82_circuit_id

list / elements=string

Список параметров, включаемых для передачи сведений об идентификации клиента.

Варианты:

  • "intfname"
  • "vlan"
  • "hostname"
  • "mode"
  • "description"

dhcp_option82_format

string

Строка формата параметра DHCP option-82.

Варианты:

  • "ascii"
  • "legacy"

dhcp_option82_remote_id

list / elements=string

Список параметров, включаемых для передачи сведений об идентификации клиента.

Варианты:

  • "mac"
  • "hostname"
  • "ip"

dhcp_server_access_list

string

Включить или отключить список контроля доступа сервера DHCP snooping.

Варианты:

  • "enable"
  • "disable"

dhcp_snoop_client_db_exp

integer

Срок действия записей базы данных сервера DHCP snooping (300–259200 с).

dhcp_snoop_client_req

string

Режим широковещательной передачи DHCP-пакетов клиента.

Варианты:

  • "drop-untrusted"
  • "forward-untrusted"

dhcp_snoop_db_per_port_learn_limit

integer

Ограничение на обучение записей dhcp-server для каждого интерфейса (0–1024).

disable_discovery

list / elements=dictionary

Запретить обнаружение этого FortiSwitch.

name

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

Серийный номер FortiSwitch.

fips_enforce

string

Включить или отключить соблюдение требований FIPS на управляемых устройствах FortiSwitch.

Варианты:

  • "disable"
  • "enable"

firewall_auth_user_hold_period

integer

Время удержания MAC-пользователей, прошедших аутентификацию брандмауэром, в минутах (5–1440).

firmware_provision_on_authorization

string

Включить или отключить автоматическую установку последней версии прошивки при авторизации.

Варианты:

  • "enable"
  • "disable"

https_image_push

string

Включить или отключить отправку образов на FortiSwitch по HTTPS.

Варианты:

  • "enable"
  • "disable"

log_mac_limit_violations

string

Включить или отключить ведение журнала о нарушениях ограничения обучения.

Варианты:

  • "enable"
  • "disable"

mac_aging_interval

integer

Время до удаления неактивного MAC-адреса (10–1000000 с).

mac_event_logging

string

Включить или отключить ведение журнала событий MAC-адресов.

Варианты:

  • "enable"
  • "disable"

mac_retention_period

integer

Время в часах, по истечении которого неактивный MAC-адрес удаляется из базы данных клиентов (0 = удаление по истечении интервала mac-aging-interval).

mac_violation_timer

integer

Задать время ожидания при нарушении ограничения обучения (0 = отключено).

quarantine_mode

string

Режим карантина.

Варианты:

  • "by-vlan"
  • "by-redirect"

sn_dns_resolution

string

Включить или отключить разрешение DNS IP-адреса устройства FortiSwitch по его имени.

Варианты:

  • "enable"
  • "disable"

switch_on_deauth

string

Выполнить сброс или восстановление заводских настроек управляемого FortiSwitch при отмене авторизации.

Варианты:

  • "no-op"
  • "factory-reset"

update_user_device

list / elements=string

Управление источниками, обновляющими список пользователей устройства.

Варианты:

  • "mac-cache"
  • "lldp"
  • "dhcp-snooping"
  • "l2-db"
  • "l3-db"

vlan_all_mode

string

Режим настройки VLAN: user-defined-vlans или all-possible-vlans.

Варианты:

  • "all"
  • "defined"

vlan_identity

string

Идентификатор VLAN. Обычно используется для RADIUS Tunnel-Private-Group-Id.

Варианты:

  • "description"
  • "name"

vlan_optimization

string

Оптимизация VLAN FortiLink.

Варианты:

  • "prune"
  • "configured"
  • "none"
  • "enable"
  • "disable"

vdom

string

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

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

Примечания

Примечание

  • Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков рекомендуется использовать httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure FortiSwitch global settings.
  fortinet.fortios.fortios_switch_controller_global:
      vdom: "{{ vdom }}"
      switch_controller_global:
          allow_multiple_interfaces: "enable"
          bounce_quarantined_link: "disable"
          custom_command:
              -
                  command_entry: "<your_own_value>"
                  command_name: "<your_own_value> (source switch-controller.custom-command.command-name)"
          default_virtual_switch_vlan: "<your_own_value> (source system.interface.name)"
          dhcp_option82_circuit_id: "intfname"
          dhcp_option82_format: "ascii"
          dhcp_option82_remote_id: "mac"
          dhcp_server_access_list: "enable"
          dhcp_snoop_client_db_exp: "86400"
          dhcp_snoop_client_req: "drop-untrusted"
          dhcp_snoop_db_per_port_learn_limit: "64"
          disable_discovery:
              -
                  name: "default_name_17"
          fips_enforce: "disable"
          firewall_auth_user_hold_period: "5"
          firmware_provision_on_authorization: "enable"
          https_image_push: "enable"
          log_mac_limit_violations: "enable"
          mac_aging_interval: "300"
          mac_event_logging: "enable"
          mac_retention_period: "24"
          mac_violation_timer: "0"
          quarantine_mode: "by-vlan"
          sn_dns_resolution: "enable"
          switch_on_deauth: "no-op"
          update_user_device: "mac-cache"
          vlan_all_mode: "all"
          vlan_identity: "description"
          vlan_optimization: "prune"

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

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

Ключ

Описание

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_switch_controller_global_module.html

Spec-Zone.ru

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