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

Примечание

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

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

Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_switchcontroller_managedswitch.

Новое в версии 2.10: of fortinet.fortimanager

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

Обзор

Этот модуль может настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить перед использованием.

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL
bypass_validation логическое значение			Варианты: нет ← да	устанавливается только в случае расхождений между схемой модуля и структурой API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка				список кодов rc, при которых будут игнорироваться условия для отказа
rc_succeeded список / элементы=строка				список кодов rc, при которых будут игнорироваться условия для успеха
state строка / обязательно			Варианты: present absent	указание на создание, обновление или удаление объекта
switchcontroller_managedswitch словарь				установленные параметры верхнего уровня
	_platform строка			без описания
	description строка			Описание.
	name строка			Имя управляемого коммутатора.
	ports список / элементы=строка			без описания
		allowed-vlans строка		Настройка VLAN с метками на портах коммутатора
		allowed-vlans-all строка	Варианты: disable enable	Включение/выключение всех определённых VLAN на данном порту.
		arp-inspection-trust строка	Варианты: untrusted trusted	Доверенная или недоверенная динамическая проверка ARP.
		bundle строка	Варианты: disable enable	Включение/выключение агрегирования каналов связи (LAG) для интерфейсов, не относящихся к FortiLink.
		description строка		Описание порта.
		dhcp-snoop-option82-trust строка	Варианты: disable enable	Включение/выключение разрешения DHCP с опцией 82 на недоверенном интерфейсе.
		dhcp-snooping строка	Варианты: trusted untrusted	Доверенный или недоверенный интерфейс DHCP-snooping.
		discard-mode строка	Варианты: none all-untagged all-tagged	Настройка режима отбрасывания для порта.
		edge-port строка	Варианты: disable enable	Включение/выключение этого интерфейса как граничного порта, обеспечивающего подключение между рабочими станциями и/или компьютерами.
		igmp-snooping строка	Варианты: disable enable	Установление режима IGMP-snooping для физического интерфейса порта.
		igmps-flood-reports строка	Варианты: disable enable	Включение/выключение потока IGMP-сообщений на этот интерфейс при включённом igmp-snooping.
		igmps-flood-traffic строка	Варианты: disable enable	Включение/выключение потока IGMP-snooping-трафика на этот интерфейс.
		lacp-speed строка	Варианты: slow fast	Отправка сообщений Link Aggregation Control Protocol (LACP) каждые 30 секунд (медленный) или каждую секунду (быстрый).
		learning-limit целое число		Ограничение количества динамических MAC-адресов на этом порту (1-128, 0 = без ограничения, по умолчанию).
		lldp-profile строка		Профиль TLV порта LLDP.
		lldp-status строка	Варианты: disable rx-only tx-only tx-rx	Статус передачи и приёма LLDP.
		loop-guard строка	Варианты: disabled enabled	Включение/выключение защиты от петель на этом интерфейсе (STP оптимизация, предотвращающая петли в сети).
		loop-guard-timeout целое число		Таймаут защиты от петель (0-120 мин, по умолчанию = 45).
		max-bundle целое число		Максимальный размер агрегированной группы каналов (1-24, по умолчанию = 24)
		mclag строка	Варианты: disable enable	Включение/выключение многомашинного агрегирования каналов (MCLAG).
		member-withdrawal-behavior строка	Варианты: forward block	Поведение порта после отсоединения из-за потери управляющих пакетов.
		members строка		без описания
		min-bundle целое число		Минимальный размер агрегированной группы каналов (1-24, по умолчанию = 1)
		mode строка	Варианты: static lacp-passive lacp-active	Режим LACP: игнорирование и не отправка управляющих сообщений, или пассивная или активная обработка агрегирования 802.3ad.
		poe-pre-standard-detection строка	Варианты: disable enable	Включение/выключение обнаружения PoE пред-стандарта.
		poe-status строка	Варианты: disable enable	Включение/выключение статуса PoE.
		port-name строка		Имя порта коммутатора.
		port-owner строка		Имя порта коммутатора.
		port-security-policy строка		Политика аутентификации контроллера коммутатора, применяемая к этому управляемому коммутатору из доступных вариантов.
		port-selection-criteria строка	Варианты: src-mac dst-mac src-dst-mac src-ip dst-ip src-dst-ip	Алгоритм выбора агрегированного порта.
		qos-policy строка		Политика QoS контроллера коммутатора из доступных вариантов.
		sample-direction строка	Варианты: rx tx both	Направление выборки sFlow.
		sflow-counter-interval целое число		Интервал опроса счётчика sFlow-самплера (1-255 сек).

		sflow-sample-rate integer		Скорость выборки образцов sFlow (0 – 99999 образцов/сек).
		sflow-sampler string	Варианты: disabled enabled	Включить/отключить протокол sFlow на данном интерфейсе.
		stp-bpdu-guard string	Варианты: disabled enabled	Включить/отключить защиту STP BPDU guard на этом интерфейсе.
		stp-bpdu-guard-timeout integer		Отключение защиты BPDU Guard (0 – 120 мин).
		stp-root-guard string	Варианты: disabled enabled	Включить/отключить защиту STP root guard на этом интерфейсе.
		stp-state string	Варианты: disabled enabled	Включить/отключить протокол Spanning Tree Protocol (STP) на этом интерфейсе.
		type string	Варианты: physical trunk	Тип интерфейса: физический или trunk-порт.
		untagged-vlans string		Настройка немаркированных VLAN на порту коммутатора.
		vlan string		Назначение портов коммутатора VLAN.
	switch-id string			Идентификатор управляемого коммутатора.
workspace_locking_adom string				Область домена (adom), которая будет заблокирована для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout integer			По умолчанию: 300	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем.

Примечания

Примечание

Работа в режиме блокировки рабочего пространства поддерживается в данном модуле FortiManager. Параметры workspace_locking_adom и workspace_locking_timeout позволяют выполнить эту работу.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, запуск одного модуля может завершиться ошибкой при возвращении ненулевого значения rc. Вы также можете переопределить условия для завершения ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure FortiSwitch devices that are managed by this FortiGate.
     fmgr_switchcontroller_managedswitch:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        switchcontroller_managedswitch:
           _platform: <value of string>
           description: <value of string>
           name: <value of string>
           ports:
             -
                 allowed-vlans: <value of string>
                 allowed-vlans-all: <value in [disable, enable]>
                 arp-inspection-trust: <value in [untrusted, trusted]>
                 bundle: <value in [disable, enable]>
                 description: <value of string>
                 dhcp-snoop-option82-trust: <value in [disable, enable]>
                 dhcp-snooping: <value in [trusted, untrusted]>
                 discard-mode: <value in [none, all-untagged, all-tagged]>
                 edge-port: <value in [disable, enable]>
                 igmp-snooping: <value in [disable, enable]>
                 igmps-flood-reports: <value in [disable, enable]>
                 igmps-flood-traffic: <value in [disable, enable]>
                 lacp-speed: <value in [slow, fast]>
                 learning-limit: <value of integer>
                 lldp-profile: <value of string>
                 lldp-status: <value in [disable, rx-only, tx-only, ...]>
                 loop-guard: <value in [disabled, enabled]>
                 loop-guard-timeout: <value of integer>
                 max-bundle: <value of integer>
                 mclag: <value in [disable, enable]>
                 member-withdrawal-behavior: <value in [forward, block]>
                 members: <value of string>
                 min-bundle: <value of integer>
                 mode: <value in [static, lacp-passive, lacp-active]>
                 poe-pre-standard-detection: <value in [disable, enable]>
                 poe-status: <value in [disable, enable]>
                 port-name: <value of string>
                 port-owner: <value of string>
                 port-security-policy: <value of string>
                 port-selection-criteria: <value in [src-mac, dst-mac, src-dst-mac, ...]>
                 qos-policy: <value of string>
                 sample-direction: <value in [rx, tx, both]>
                 sflow-counter-interval: <value of integer>
                 sflow-sample-rate: <value of integer>
                 sflow-sampler: <value in [disabled, enabled]>
                 stp-bpdu-guard: <value in [disabled, enabled]>
                 stp-bpdu-guard-timeout: <value of integer>
                 stp-root-guard: <value in [disabled, enabled]>
                 stp-state: <value in [disabled, enabled]>
                 type: <value in [physical, trunk]>
                 untagged-vlans: <value of string>
                 vlan: <value of string>
           switch-id: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный запрашиваемый URL. Пример: /sys/login/user
response_code integer	всегда	Статус запроса API.
response_message string	всегда	Дескриптивное сообщение ответа API. Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 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/fortimanager/fmgr_switchcontroller_managedswitch_module.html