Spec-Zone.ru › Ansible 2.11

fortinet.fortios.fortios_switch_controller_managed_switch – Настройка устройств FortiSwitch, управляемых этим FortiGate, в FortiOS и FortiGate Fortinet.

Примечание

Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).

Для его установки используйте: ansible-galaxy collection install fortinet.fortios.

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

Новое в версии 2.8: of fortinet.fortios

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

Обзор

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

Требования

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

  • ansible>=2.9.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_token
строка
Аутентификация на основе токена. Сгенерировано в GUI Fortigate.
state
строка
добавлен в 2.9 fortinet.fortios
    Варианты:
  • present
  • absent
Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущих версиях на более глубоком уровне. Он был перемещён на этот внешний уровень.
switch_controller_managed_switch
словарь
Настройка устройств FortiSwitch, управляемых этим FortiGate.
connected
целое число
Подключение CAPWAP.
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
строка
    Варианты:
  • discovered
  • disable
  • enable
Статус администрирования FortiSwitch WAN1; включить, чтобы разрешить FortiSwitch как управляемый коммутатор.
fsw_wan1_peer
строка
Порт peer Fortiswitch WAN1.
fsw_wan2_admin
строка
    Варианты:
  • discovered
  • disable
  • enable
Статус администрирования FortiSwitch WAN2; включить, чтобы разрешить FortiSwitch как управляемый коммутатор.
fsw_wan2_peer
строка
Порт peer FortiSwitch WAN2.
igmp_snooping
словарь
Настройка глобальных настроек IGMP snooping FortiSwitch.
aging_time
целое число
Максимальное время сохранения записи snooping для мультикаста, для которой не наблюдались пакеты (15 - 3600 сек).
flood_unknown_multicast
строка
    Варианты:
  • enable
  • disable
Включить/выключить рассылку неизвестных мультикастов.
local_override
строка
    Варианты:
  • enable
  • disable
Включить/выключить переопределение глобальной конфигурации IGMP snooping.
max_allowed_trunk_members
целое число
Максимальное разрешённое количество членов trunk FortiSwitch.
mirror
список / элементы=строка
Метод конфигурации для редактирования зеркалирования пакетов FortiSwitch.
dst
строка
Порт назначения.
name
строка / обязательно
Имя зеркалирования.
src_egress
список / элементы=строка
Интерфейсы источника egress.
name
строка / обязательно
Имя интерфейса.
src_ingress
список / элементы=строка
Интерфейсы источника ingress.
name
строка / обязательно
Имя интерфейса.
status
строка
    Варианты:
  • active
  • inactive
Активная/неактивная конфигурация зеркалирования.
switching_packet
строка
    Варианты:
  • enable
  • disable
Включить/выключить функциональность коммутации при зеркалировании.
name
строка
Имя управляемого коммутатора.
owner_vdom
строка
VDOM, к которому принадлежит порт.
poe_pre_standard_detection
строка
    Варианты:
  • enable
  • disable
Включить/выключить предварительное обнаружение стандарта PoE.
ports
список / элементы=строка
Список портов управляемого коммутатора.
allowed_vlans
список / элементы=строка
Настройка портов коммутатора с тэгированными VLAN.
vlan_name
строка
Имя VLAN. Источник system.interface.name.
allowed_vlans_all
строка
    Варианты:
  • enable
  • disable
Включить/выключить все определённые VLAN на этом порту.
arp_inspection_trust
строка
    Варианты:
  • untrusted
  • trusted
Доверенный или недоверенный динамический ARP-инспекции.
bundle
строка
    Варианты:
  • enable
  • disable
Включить/выключить объединение Link Aggregation Group (LAG) для интерфейсов, не являющихся FortiLink.
description
строка
Описание порта.
dhcp_snoop_option82_trust
строка
    Варианты:
  • enable
  • disable
Включить/выключить разрешение DHCP с опцией-82 на недоверенном интерфейсе.
dhcp_snooping
строка
    Варианты:
  • untrusted
  • trusted
Доверенный или недоверенный интерфейс DHCP-snooping.
discard_mode
строка
    Варианты:
  • none
  • all-untagged
  • all-tagged
Настройка режима отбрасывания для порта.
edge_port
строка
    Варианты:
  • enable
  • disable
Включить/выключить этот интерфейс как edge-порт, обеспечивающий подключение между рабочими станциями и/или компьютерами.
export_tags
список / элементы=строка
Имя тега экспорта контроллера коммутатора.
имя_тега
строка
Имя тега коммутатора. Источник switch-controller.switch-interface-tag.name.
экспорт_в
строка
Экспорт порта управляемого коммутатора в домен VDOM клиента. Источник system.vdom.name.
экспорт_в_пул
строка
Экспорт порта контроллера коммутатора в список пулов. Источник switch-controller.virtual-port-pool.name.
флаг_экспорта_в_пул
целое число
Экспорт порта контроллера коммутатора в список пулов.
имя_устройства_fgt_партера
строка
Имя устройства FGT партера.
имя_порта_fgt_партера
строка
Имя порта устройства FGT партера.
порт_волокна
целое число
Порт волокна.
флаги
целое число
Флаги свойств порта.
порт_fortilink
целое число
Порт подключения FortiLink.
igmp_snooping
строка
    Варианты:
  • включить
  • выключить
Установить режим IGMP snooping для физического интерфейса порта.
igmps_flood_reports
строка
    Варианты:
  • включить
  • выключить
Включить/выключить отправку IGMP отчетов на этот интерфейс, когда igmp-snooping включен.
igmps_flood_traffic
строка
    Варианты:
  • включить
  • выключить
Включить/выключить отправку трафика IGMP snooping на этот интерфейс.
имя_локального_ISL_трэнка
строка
Имя локального ISL трэнка.
имя_устройства_ISL_партера
строка
Имя устройства ISL партера.
имя_порта_ISL_партера
строка
Имя порта устройства ISL партера.
скорость_lacp
строка
    Варианты:
  • медленная
  • быстрая
Отправлять сообщения Link Aggregation Control Protocol (LACP) каждые 30 секунд (медленно) или каждую секунду (быстро).
предел_обучения
целое число
Ограничение количества динамических MAC-адресов на этом порту (1-128, 0 = без ограничения, по умолчанию).
профиль_lldp
строка
Профиль TLV порта LLDP. Источник switch-controller.lldp-profile.name.
статус_lldp
строка
    Варианты:
  • выключить
  • только приём
  • только передача
  • передача-приём
Статус передачи и приема LLDP.
защита_от_петель
строка
    Варианты:
  • включено
  • выключено
Включить/выключить защиту от петель на этом интерфейсе, оптимизация STP для предотвращения петель в сети.
таймаут_защиты_от_петель
целое число
Таймаут защиты от петель (0-120 мин).
максимальный_пучок
целое число
Максимальный размер пучка LAG (1-24)
mclag
строка
    Варианты:
  • включить
  • выключить
Включить/выключить агрегацию каналов в нескольких коммутаторах (MCLAG).
поведение_при_выводе_члена
строка
    Варианты:
  • передавать
  • блокировать
Поведение порта после выхода из-за потери управляющих пакетов.
члены
список / элементы=строка
Агрегированные интерфейсы пучка LAG.
имя_члена
строка
Имя интерфейса из доступных вариантов.
минимальный_пучок
целое число
Минимальный размер пучка LAG (1-24)
режим
строка
    Варианты:
  • статический
  • lacp-пассивный
  • lacp-активный
Режим LACP: игнорировать и не отправлять управляющие сообщения, или согласовать агрегацию 802.3ad пассивно или активно.
poe_возможность
целое число
PoE-совместимость.
poe_обнаружение_до_стандарта
строка
    Варианты:
  • включить
  • выключить
Включить/выключить обнаружение PoE до стандарта.
статус_poe
строка
    Варианты:
  • включить
  • выключить
Включить/выключить статус PoE.
имя_порта
строка
Имя порта коммутатора.
номер_порта
целое число
Номер порта.
владелец_порта
строка
Имя порта коммутатора.
тип_префикса_порта
целое число
Тип префикса порта.
политика_безопасности_порта
строка
Политика аутентификации контроллера коммутатора, применяемая к этому управляемому коммутатору из доступных вариантов. Источник switch-controller .security-policy.802-1X.name switch-controller.security-policy.captive-portal.name.
критерии_выбора_порта
строка
    Варианты:
  • src-mac
  • dst-mac
  • src-dst-mac
  • src-ip
  • dst-ip
  • src-dst-ip
Алгоритм для выбора агрегированного порта.
qos_политика
строка
QoS-политика контроллера коммутатора из доступных вариантов. Источник switch-controller.qos.qos-policy.name.
направление_выборки
строка
    Варианты:
  • tx
  • rx
  • оба
Направление выборки sFlow.
интервал_счётчика_sflow
целое число
Интервал опроса счётчика sFlow-образца (1-255 сек).
скорость_выборки_sflow
целое число
Скорость выборки sFlow-образца (0-99999 p/сек).
sflow_образцы
строка
    Варианты:
  • включить
  • выключить
Включить/выключить протокол sFlow на этом интерфейсе.
скорость
строка
    Варианты:
  • 10half
  • 10full
  • 100half
  • 100full
  • 1000auto
  • 1000fiber
  • 1000full
  • 10000
  • 40000
  • auto
  • auto-module
  • 100FX-half
  • 100FX-full
  • 100000full
  • 2500full
  • 25000full
  • 50000full
Скорость порта коммутатора; значения по умолчанию и доступные параметры зависят от оборудования.
speed_mask
integer
Маска скорости порта коммутатора.
stacking_port
integer
Порт стекинга.
status
string
    Choices:
  • up
  • down
Административный статус порта коммутатора: up или down.
stp_bpdu_guard
string
    Choices:
  • enabled
  • disabled
Включить/выключить STP BPDU guard на этом интерфейсе.
stp_bpdu_guard_timeout
integer
Отключение защиты BPDU Guard (0 - 120 мин).
stp_root_guard
string
    Choices:
  • enabled
  • disabled
Включить/выключить STP root guard на этом интерфейсе.
stp_state
string
    Choices:
  • enabled
  • disabled
Включить/выключить протокол Spanning Tree (STP) на этом интерфейсе.
switch_id
string
ID коммутатора.
type
string
    Choices:
  • physical
  • trunk
Тип интерфейса: физический или trunk порт.
untagged_vlans
list / elements=string
Настройка неуточненных VLAN на порту коммутатора
vlan_name
string
Имя VLAN. Имя интерфейса источника системы.
virtual_port
integer
Виртуальный порт коммутатора.
vlan
string
Назначение портов коммутатора VLAN. Имя интерфейса источника системы.
pre_provisioned
integer
Предварительно настроенный управляемый коммутатор.
settings_802_1X
dictionary
Метод конфигурации для редактирования глобальных настроек FortiSwitch 802.1X.
link_down_auth
string
    Choices:
  • set-unauth
  • no-action
Состояние аутентификации при отключении канала.
local_override
string
    Choices:
  • enable
  • disable
Включить, чтобы переопределить глобальные настройки 802.1X для отдельных FortiSwitch.
max_reauth_attempt
integer
Максимальное количество попыток аутентификации (0 - 15).
reauth_period
integer
Интервал времени повторной аутентификации (1 - 1440 мин).
staged_image_version
string
Версия запущенной образов для FortiSwitch.
state
string
    Choices:
  • present
  • absent
Устарело
Начиная с Ansible 2.9 рекомендуется использовать параметр «state» на верхнем уровне.
Указывает, нужно ли создать или удалить объект.
storm_control
dictionary
Метод конфигурации для редактирования функции контроля шторма FortiSwitch для измерения активности трафика с использованием скоростей данных для предотвращения перегрузки трафика.
broadcast
string
    Choices:
  • enable
  • disable
Включить/выключить контроль шторма для отбрасывания широковещательного трафика.
local_override
string
    Choices:
  • enable
  • disable
Включить, чтобы переопределить глобальные настройки контроля шторма FortiSwitch для этого FortiSwitch.
rate
integer
Скорость в пакетах в секунду, с которой контролируется трафик шторма (1 - 10000000). Контроль шторма отбрасывает избыточный трафик со скоростями данных сверх этого порога.
unknown_multicast
string
    Choices:
  • enable
  • disable
Включить/выключить контроль шторма для отбрасывания неизвестного многоадресного трафика.
unknown_unicast
string
    Choices:
  • enable
  • disable
Включить/выключить контроль шторма для отбрасывания неизвестного одноадресного трафика.
stp_settings
dictionary
Метод конфигурации для редактирования настроек протокола Spanning Tree (STP), используемых для предотвращения петель моста.
forward_time
integer
Период времени, в течение которого порт находится в состоянии прослушивания и обучения (4 - 30 сек).
hello_time
integer
Период времени между последовательными отправленными кадрами STP Bridge Protocol Data Units (BPDUs) на порту (1 - 10 сек).
local_override
string
    Choices:
  • enable
  • disable
Включить, чтобы настроить локальные настройки 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
    Choices:
  • enable
  • disable
Включить/выключить STP.
switch_device_tag
string
Определяемая пользователем метка/тег.
switch_id
string
Идентификатор управляемого коммутатора.
switch_log
dictionary
Метод конфигурации для редактирования настроек ведения журнала FortiSwitch (журналы передаются и вставляются в журнал событий FortiGate).
local_override
string
    Choices:
  • enable
  • disable
Включить, чтобы настроить локальные настройки ведения журнала, которые переопределяют глобальные настройки ведения журнала.
severity
string
    Choices:
  • emergency
  • alert
  • critical
  • error
  • warning
  • notification
  • information
  • debug
Уровень серьезности журналов FortiSwitch, которые добавляются в журнал событий FortiGate.
status
string
    Choices:
  • enable
  • disable
Включить/выключить добавление журналов FortiSwitch в журнал событий FortiGate.
switch_profile
string
Профиль FortiSwitch. Источник switch-controller.switch-profile.name.
switch_stp_settings
dictionary
Настройка протокола spanning tree (STP).
status
string
    Choices:
  • enable
  • disable
Включение/выключение STP.
type
string
    Choices:
  • virtual
  • physical
Указание типа коммутатора, физический или виртуальный.
version
integer
Версия FortiSwitch.
vdom
string
По умолчанию:
"root"
Виртуальная область, среди тех, которые определены ранее. VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство.

Примечания

Примечание

  • Устаревший fortiosapi устарел, httpapi является предпочтительным способом запуска playbooks

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure FortiSwitch devices that are managed by this FortiGate.
    fortios_switch_controller_managed_switch:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_managed_switch:
        settings_802_1X:
            link_down_auth: "set-unauth"
            local_override: "enable"
            max_reauth_attempt: "6"
            reauth_period: "7"
        connected: "8"
        custom_command:
         -
            command_entry: "<your_own_value>"
            command_name: "<your_own_value> (source switch-controller.custom-command.command-name)"
        delayed_restart_trigger: "12"
        description: "<your_own_value>"
        directly_connected: "14"
        dynamic_capability: "15"
        dynamically_discovered: "16"
        fsw_wan1_admin: "discovered"
        fsw_wan1_peer: "<your_own_value>"
        fsw_wan2_admin: "discovered"
        fsw_wan2_peer: "<your_own_value>"
        igmp_snooping:
            aging_time: "22"
            flood_unknown_multicast: "enable"
            local_override: "enable"
        max_allowed_trunk_members: "25"
        mirror:
         -
            dst: "<your_own_value>"
            name: "default_name_28"
            src_egress:
             -
                name: "default_name_30"
            src_ingress:
             -
                name: "default_name_32"
            status: "active"
            switching_packet: "enable"
        name: "default_name_35"
        owner_vdom: "<your_own_value>"
        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
string
всегда
Номер сборки образа fortigate

Пример:
1547
http_method
string
всегда
Последний метод, используемый для предоставления содержимого в FortiGate

Пример:
PUT
http_status
string
всегда
Последний результат, предоставленный FortiGate при последнем примененном действии

Пример:
200
mkey
string
успех
Главный ключ (id), используемый в последнем вызове FortiGate

Пример:
id
name
string
всегда
Имя таблицы, используемой для выполнения запроса

Пример:
urlfilter
path
string
всегда
Путь таблицы, используемой для выполнения запроса

Пример:
webfilter
revision
string
всегда
Внутренний номер версии

Пример:
17.0.2.10658
serial
string
всегда
Серийный номер устройства

Пример:
FGVMEVYYQT3AB5352
status
string
всегда
Указание результата операции

Пример:
успех
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_switch_controller_managed_switch_module.html

Spec-Zone.ru

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