fortios_switch_controller_managed_switch – Настройка устройств FortiSwitch, управляемых этим FortiGate, в Fortinet FortiOS и FortiGate
Новая в версии 2.8.
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию switch_controller и категорию managed_switch. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.5
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| host строка | IP-адрес FortiOS или FortiGate. | ||||
| https булево |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | |||
| password строка | Значение по умолчанию: "" | Пароль FortiOS или FortiGate. | |||
| ssl_verify булево добавлен в 2.9 |
| Обеспечивает проверку сертификата FortiGate надлежащим центром сертификации. | |||
| state строка добавлен в 2.9 |
| Указывает, нужно ли создать или удалить объект. Этот атрибут присутствовал и в предыдущих версиях на более глубоком уровне. Он был вынесен на этот внешний уровень. | |||
| switch_controller_managed_switch словарь | Значение по умолчанию: null | Настройка устройств FortiSwitch, управляемых этим FortiGate. | |||
| 802_1X_settings словарь | Метод конфигурации для изменения глобальных настроек 802.1X FortiSwitch. | ||||
| link_down_auth строка |
| Состояние аутентификации при отключенном соединении. | |||
| local_override строка |
| Включить для переопределения глобальных настроек 802.1X на отдельных FortiSwitch. | |||
| max_reauth_attempt целое число | Максимальное количество попыток аутентификации (0 - 15). | ||||
| reauth_period целое число | Интервал времени повторной аутентификации (1 - 1440 мин). | ||||
| custom_command список | Метод конфигурации для изменения команд FortiSwitch, которые будут переданы этому устройству FortiSwitch при перезагрузке контроллера коммутатора FortiGate или FortiSwitch. | ||||
| command_entry строка | Список команд FortiSwitch. | ||||
| command_name строка | Имена команд, которые будут переданы этому устройству FortiSwitch, как настроено в config switch-controller custom-command. Исходный switch-controller.custom-command.command-name. | ||||
| delayed_restart_trigger целое число | Задержка перезагрузки, запущенная для этого FortiSwitch. | ||||
| description строка | Описание. | ||||
| directly_connected целое число | Подключенный напрямую FortiSwitch. | ||||
| dynamic_capability целое число | Список поддерживаемых этим FortiSwitch функций (не настраиваемых), который передаётся устройству FortiGate для последующей конфигурации, инициированной устройством FortiGate. | ||||
| dynamically_discovered целое число | Динамически обнаруженный FortiSwitch. | ||||
| fsw_wan1_admin строка |
| Статус управления WAN1 FortiSwitch; включение для авторизации FortiSwitch как управляемого коммутатора. | |||
| fsw_wan1_peer строка | Порт peer WAN1 Fortiswitch. | ||||
| fsw_wan2_admin строка |
| Статус управления WAN2 FortiSwitch; включение для авторизации FortiSwitch как управляемого коммутатора. | |||
| fsw_wan2_peer строка | Порт peer WAN2 FortiSwitch. | ||||
| igmp_snooping словарь | Настройка глобальных настроек IGMP snooping FortiSwitch. | ||||
| aging_time целое число | Максимальное время удержания записи IGMP snooping, для которой не наблюдались пакеты (15 - 3600 сек). | ||||
| flood_unknown_multicast строка |
| Включить/выключить рассылку неизвестных мультикастов. | |||
| local_override строка |
| Включить/выключить переопределение глобальной конфигурации IGMP snooping. | |||
| max_allowed_trunk_members целое число | Максимальное количество членов trunk FortiSwitch. | ||||
| mirror список | Метод конфигурации для изменения отражения пакетов FortiSwitch. | ||||
| dst строка | Порт назначения. | ||||
| name строка / обязательно | Имя отражения. | ||||
| src_egress список | Источники исходящих интерфейсов. | ||||
| name строка / обязательно | Имя интерфейса. | ||||
| src_ingress список | Источники входящих интерфейсов. | ||||
| name строка / обязательно | Имя интерфейса. | ||||
| status строка |
| Активная/неактивная конфигурация отражения. | |||
| switching_packet строка |
| Включить/выключить функциональность коммутации при отражении. | |||
| имя строка | Имя управляемого коммутатора. | ||||
| owner_vdom строка | VDOM, которому принадлежит порт. | ||||
| poe_detection_type целое число | Тип обнаружения PoE для FortiSwitch. | ||||
| poe_pre_standard_detection строка |
| Включить/выключить обнаружение PoE предварительного стандарта. | |||
| ports список | Список портов управляемого коммутатора. | ||||
| allowed_vlans список | Настройка тегированных VLAN портов коммутатора | ||||
| vlan_name строка | Имя VLAN. Источник system.interface.name. | ||||
| allowed_vlans_all строка |
| Включить/выключить все определенные VLAN на этом порту. | |||
| arp_inspection_trust строка |
| Доверенный или недоверенный динамический ARP-инспекции. | |||
| bundle строка |
| Включить/выключить объединение каналов связи (LAG) для интерфейсов, не являющихся FortiLink. | |||
| description строка | Описание порта. | ||||
| dhcp_snoop_option82_trust строка |
| Включить/выключить разрешение DHCP с опцией 82 на недоверенном интерфейсе. | |||
| dhcp_snooping строка |
| Доверенный или недоверенный интерфейс DHCP-snooping. | |||
| discard_mode строка |
| Настройка режима отбрасывания для порта. | |||
| edge_port строка |
| Включить/выключить этот интерфейс как граничный порт, соединяющий рабочие станции и/или компьютеры. | |||
| export_tags список | Имя тега экспорта контроллера коммутатора. | ||||
| tag_name строка | Имя тега коммутатора. Источник switch-controller.switch-interface-tag.name. | ||||
| export_to строка | Экспорт порта управляемого коммутатора в VDOM арендатора. Источник system.vdom.name. | ||||
| export_to_pool строка | Экспорт порта контроллера коммутатора в список пулов. Источник switch-controller.virtual-port-pool.name. | ||||
| export_to_pool_flag целое число | Экспорт порта контроллера коммутатора в список пулов. | ||||
| fgt_peer_device_name строка | Имя устройства-партнера FGT. | ||||
| fgt_peer_port_name строка | Имя порта-партнера FGT. | ||||
| fiber_port целое число | Порт оптоволокна. | ||||
| flags целое число | Флаги свойств порта. | ||||
| fortilink_port целое число | Порт FortiLink. | ||||
| igmp_snooping строка |
| Установить режим IGMP snooping для физического интерфейса порта. | |||
| igmps_flood_reports строка |
| Включить/выключить рассылку отчетов IGMP на этот интерфейс, когда включен igmp-snooping. | |||
| igmps_flood_traffic строка |
| Включить/выключить рассылку трафика IGMP snooping на этот интерфейс. | |||
| isl_local_trunk_name строка | Имя локального ствола ISL. | ||||
| isl_peer_device_name строка | Имя устройства-партнера ISL. | ||||
| isl_peer_port_name строка | Имя порта-партнера ISL. | ||||
| lacp_speed строка |
| Отправлять сообщения Link Aggregation Control Protocol (LACP) каждые 30 секунд (медленно) или каждую секунду (быстро). | |||
| learning_limit целое число | Ограничить количество динамических MAC-адресов на этом порту (1-128, 0 = без ограничения, по умолчанию). | ||||
| lldp_profile строка | Профиль TLV порта LLDP. Источник switch-controller.lldp-profile.name. | ||||
| lldp_status строка |
| Статус передачи и приема LLDP. | |||
| loop_guard строка |
| Включить/выключить функцию предотвращения петель на этом интерфейсе (STP optimization). | |||
| loop_guard_timeout целое число | Таймаут для предотвращения петель (0-120 мин). | ||||
| max_bundle integer | Максимальный размер LAG-сборки (1 - 24) | ||||
| mclag string |
| Включение/выключение агрегирования ссылок с несколькими платформами (MCLAG). | |||
| member_withdrawal_behavior string |
| Поведение порта после его выхода из-за потери управляющих пакетов. | |||
| members list | Агрегированные интерфейсы LAG-сборки. | ||||
| member_name string | Имя интерфейса из доступных вариантов. | ||||
| min_bundle integer | Минимальный размер LAG-сборки (1 - 24) | ||||
| mode string |
| Режим LACP: игнорировать и не отправлять управляющие сообщения или согласовывать агрегирование 802.3ad пассивно или активно. | |||
| poe_capable integer | Поддержка PoE. | ||||
| poe_pre_standard_detection string |
| Включение/выключение обнаружения PoE до стандарта. | |||
| poe_status string |
| Включение/выключение состояния PoE. | |||
| port_name string | Имя порта коммутатора. | ||||
| port_number integer | Номер порта. | ||||
| port_owner string | Имя порта коммутатора. | ||||
| port_prefix_type integer | Тип префикса порта. | ||||
| port_security_policy string | Политика аутентификации контроллера коммутатора для применения к этому управляемому коммутатору из доступных вариантов. Источник switch-controller.security-policy.802-1X.name switch-controller.security-policy.captive-portal.name. | ||||
| port_selection_criteria string |
| Алгоритм выбора агрегированного порта. | |||
| qos_policy string | Политика QoS контроллера коммутатора из доступных вариантов. Источник switch-controller.qos.qos-policy.name. | ||||
| sample_direction string |
| Направление выборки sFlow. | |||
| sflow_counter_interval integer | Интервал опроса счётчика sFlow-сэмплера (1 - 255 сек). | ||||
| sflow_sample_rate integer | Частота выборки sFlow-сэмплера (0 - 99999 p/сек). | ||||
| sflow_sampler string |
| Включение/выключение протокола sFlow на этом интерфейсе. | |||
| speed string |
| Скорость порта коммутатора; значения по умолчанию и доступные настройки зависят от аппаратного обеспечения. | |||
| speed_mask integer | Маска скорости порта коммутатора. | ||||
| stacking_port integer | Порт стека. | ||||
| status string |
| Административное состояние порта коммутатора: включено или выключено. | |||
| stp_bpdu_guard string |
| Включение/выключение STP BPDU-защиты на этом интерфейсе. | |||
| stp_bpdu_guard_timeout integer | Отключение защиты BPDU-охранника (0 - 120 мин). | ||||
| stp_root_guard string |
| Включение/выключение защиты корневого узла STP на этом интерфейсе. | |||
| stp_state string |
| Включение/выключение протокола Spanning Tree Protocol (STP) на этом интерфейсе. | |||
| switch_id string | Идентификатор коммутатора. | ||||
| type string |
| Тип интерфейса: физический или магистральный порт. | |||
| untagged_vlans list | Настройка немаркированных VLAN на порту коммутатора | ||||
| vlan_name string | Имя VLAN. Источник system.interface.name. | ||||
| virtual_port integer | Виртуализированный порт коммутатора. | ||||
| vlan string | Назначение портов коммутатора VLAN. Источник system.interface.name. | ||||
| pre_provisioned integer | Предварительно запрограммированный управляемый коммутатор. | ||||
| staged_image_version string | Версия загруженного образа FortiSwitch. | ||||
| state string |
| Устаревшее Начиная с Ansible 2.9, рекомендуется использовать параметр «state» на верхнем уровне. Указывает, нужно ли создать или удалить объект. | |||
| storm_control dictionary | Метод конфигурации для редактирования управления штормами FortiSwitch для измерения активности трафика с использованием скоростей данных, чтобы предотвратить сбои трафика. | ||||
| broadcast string |
| Включить/выключить управление штормами для пропускания широковещательного трафика. | |||
| local_override string |
| Включить для переопределения глобальных настроек управления штормами FortiSwitch для данного FortiSwitch. | |||
| rate integer | Скорость в пакетах в секунду, с которой контролируется штормовой трафик (1 - 10000000). Управление штормами отбрасывает избыточные скорости данных трафика, превышающие этот порог. | ||||
| unknown_multicast string |
| Включить/выключить управление штормами для пропускания неизвестного многоадресного трафика. | |||
| unknown_unicast string |
| Включить/выключить управление штормами для пропускания неизвестного одноадресного трафика. | |||
| stp_settings dictionary | Метод конфигурации для редактирования настроек протокола Spanning Tree Protocol (STP), используемых для предотвращения петель мостов. | ||||
| forward_time integer | Период времени, в течение которого порт находится в состоянии прослушивания и обучения (4 - 30 сек). | ||||
| hello_time integer | Период времени между последовательными отправленными на порту кадрами протокола моста BPDUs (1 - 10 сек). | ||||
| local_override string |
| Включить для настройки локальных параметров STP, которые переопределяют глобальные параметры STP. | |||
| max_age integer | Максимальное время до того, как мост сохранит информацию о конфигурации BPDU (6 - 40 сек). | ||||
| max_hops integer | Максимальное количество хопов между корневым мостом и самым удалённым мостом (1- 40). | ||||
| name string | Имя локальной конфигурации настроек STP. | ||||
| pending_timer integer | Время ожидания (1 - 15 сек). | ||||
| revision integer | Номер версии STP (0 - 65535). | ||||
| status string |
| Включить/выключить STP. | |||
| switch_device_tag string | Пользовательский определяемый метка/тег. | ||||
| switch_id string | Идентификатор управляемого коммутатора. | ||||
| switch_log dictionary | Метод конфигурации для редактирования настроек ведения журнала FortiSwitch (журналы передаются и вставляются в журнал событий FortiGate). | ||||
| local_override string |
| Включить для настройки локальных настроек ведения журнала, которые переопределяют глобальные настройки ведения журнала. | |||
| severity string |
| Уровень серьезности журналов FortiSwitch, которые добавляются в журнал событий FortiGate. | |||
| status string |
| Включить/выключить добавление журналов FortiSwitch в журнал событий FortiGate. | |||
| switch_profile string | Профиль FortiSwitch. Источник switch-controller.switch-profile.name. | ||||
| switch_stp_settings dictionary | Настройка протокола Spanning Tree Protocol (STP). | ||||
| status string |
| Включить/выключить STP. | |||
| type string |
| Указание типа коммутатора, физического или виртуального. | |||
| version integer | Версия FortiSwitch. | ||||
| username string | Имя пользователя FortiOS или FortiGate. | ||||
| vdom string | По умолчанию: "root" | Виртуальная область, среди ранее определённых. Vdom — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный модуль. | |||
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная Fortinet
- Выполняется как локальное действие в вашем плане.
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
ssl_verify: "False"
tasks:
- name: Configure FortiSwitch devices that are managed by this FortiGate.
fortios_switch_controller_managed_switch:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
state: "present"
switch_controller_managed_switch:
802_1X_settings:
link_down_auth: "set-unauth"
local_override: "enable"
max_reauth_attempt: "6"
reauth_period: "7"
custom_command:
-
command_entry: "<your_own_value>"
command_name: "<your_own_value> (source switch-controller.custom-command.command-name)"
delayed_restart_trigger: "11"
description: "<your_own_value>"
directly_connected: "13"
dynamic_capability: "14"
dynamically_discovered: "15"
fsw_wan1_admin: "discovered"
fsw_wan1_peer: "<your_own_value>"
fsw_wan2_admin: "discovered"
fsw_wan2_peer: "<your_own_value>"
igmp_snooping:
aging_time: "21"
flood_unknown_multicast: "enable"
local_override: "enable"
max_allowed_trunk_members: "24"
mirror:
-
dst: "<your_own_value>"
name: "default_name_27"
src_egress:
-
name: "default_name_29"
src_ingress:
-
name: "default_name_31"
status: "active"
switching_packet: "enable"
name: "default_name_34"
owner_vdom: "<your_own_value>"
poe_detection_type: "36"
poe_pre_standard_detection: "enable"
ports:
-
allowed_vlans:
-
vlan_name: "<your_own_value> (source system.interface.name)"
allowed_vlans_all: "enable"
arp_inspection_trust: "untrusted"
bundle: "enable"
description: "<your_own_value>"
dhcp_snoop_option82_trust: "enable"
dhcp_snooping: "untrusted"
discard_mode: "none"
edge_port: "enable"
export_tags:
-
tag_name: "<your_own_value> (source switch-controller.switch-interface-tag.name)"
export_to: "<your_own_value> (source system.vdom.name)"
export_to_pool: "<your_own_value> (source switch-controller.virtual-port-pool.name)"
export_to_pool_flag: "53"
fgt_peer_device_name: "<your_own_value>"
fgt_peer_port_name: "<your_own_value>"
fiber_port: "56"
flags: "57"
fortilink_port: "58"
igmp_snooping: "enable"
igmps_flood_reports: "enable"
igmps_flood_traffic: "enable"
isl_local_trunk_name: "<your_own_value>"
isl_peer_device_name: "<your_own_value>"
isl_peer_port_name: "<your_own_value>"
lacp_speed: "slow"
learning_limit: "66"
lldp_profile: "<your_own_value> (source switch-controller.lldp-profile.name)"
lldp_status: "disable"
loop_guard: "enabled"
loop_guard_timeout: "70"
max_bundle: "71"
mclag: "enable"
member_withdrawal_behavior: "forward"
members:
-
member_name: "<your_own_value>"
min_bundle: "76"
mode: "static"
poe_capable: "78"
poe_pre_standard_detection: "enable"
poe_status: "enable"
port_name: "<your_own_value>"
port_number: "82"
port_owner: "<your_own_value>"
port_prefix_type: "84"
port_security_policy: "<your_own_value> (source switch-controller.security-policy.802-1X.name switch-controller.security-policy.captive-portal
.name)"
port_selection_criteria: "src-mac"
qos_policy: "<your_own_value> (source switch-controller.qos.qos-policy.name)"
sample_direction: "tx"
sflow_counter_interval: "89"
sflow_sample_rate: "90"
sflow_sampler: "enabled"
speed: "10half"
speed_mask: "93"
stacking_port: "94"
status: "up"
stp_bpdu_guard: "enabled"
stp_bpdu_guard_timeout: "97"
stp_root_guard: "enabled"
stp_state: "enabled"
switch_id: "<your_own_value>"
type: "physical"
untagged_vlans:
-
vlan_name: "<your_own_value> (source system.interface.name)"
virtual_port: "104"
vlan: "<your_own_value> (source system.interface.name)"
pre_provisioned: "106"
staged_image_version: "<your_own_value>"
storm_control:
broadcast: "enable"
local_override: "enable"
rate: "111"
unknown_multicast: "enable"
unknown_unicast: "enable"
stp_settings:
forward_time: "115"
hello_time: "116"
local_override: "enable"
max_age: "118"
max_hops: "119"
name: "default_name_120"
pending_timer: "121"
revision: "122"
status: "enable"
switch_device_tag: "<your_own_value>"
switch_id: "<your_own_value>"
switch_log:
local_override: "enable"
severity: "emergency"
status: "enable"
switch_profile: "<your_own_value> (source switch-controller.switch-profile.name)"
switch_stp_settings:
status: "enable"
type: "virtual"
version: "134"
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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 строка | всегда | Указание результата операции Пример: успех |
| vdom строка | всегда | Используемый виртуальный домен Пример: root |
| version строка | всегда | Версия FortiGate Пример: v5.6.3 |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [предварительная версия]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/fortios_switch_controller_managed_switch_module.html