fortinet.fortimanager.fmgr_switchcontroller_managedswitch_ports module – Список портов управляемого коммутатора.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_switchcontroller_managedswitch_ports.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
managed-switch string | Устарел, используйте «managed_switch» |
managed_switch string | Параметр (managed-switch) в запрошенном URL. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия сбоя. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
switchcontroller_managedswitch_ports dictionary | Набор параметров верхнего уровня. |
|
access_mode псевдонимы: access-mode string |
Режим доступа порта. Варианты:
|
|
acl_group псевдонимы: acl-group any |
(список) Группы ACL на этом порту. |
|
aggregator_mode псевдонимы: aggregator-mode string |
Режим выбора участника LACP. Варианты:
|
|
allow_arp_monitor псевдонимы: allow-arp-monitor string |
Включить/выключить разрешение мониторинга ARP. Варианты:
|
|
allowed_vlans псевдонимы: allowed-vlans any |
(список или строка) Настройка VLAN с тегами для порта коммутатора |
|
allowed_vlans_all псевдонимы: allowed-vlans-all string |
Включить/выключить все определённые VLAN на этом порту. Варианты:
|
|
arp_inspection_trust псевдонимы: arp-inspection-trust string |
Доверенный или недоверенный интерфейс динамической проверки ARP. Варианты:
|
|
authenticated_port псевдонимы: authenticated-port integer |
Аутентифицированный порт. |
|
bundle string |
Включить/выключить группу агрегации каналов Варианты:
|
|
description string |
Описание порта. |
|
dhcp_snoop_option82_override псевдонимы: dhcp-snoop-option82-override list / элементы=dictionary |
Переопределение параметра 82 для DHCP snooping. |
|
circuit_id псевдонимы: circuit-id string |
Строка идентификатора канала. |
|
remote_id псевдонимы: remote-id string |
Строка удалённого идентификатора. |
|
vlan_name псевдонимы: vlan-name string |
VLAN параметра 82 DHCP snooping. |
|
dhcp_snoop_option82_trust псевдонимы: dhcp-snoop-option82-trust string |
Включить/выключить разрешение DHCP с параметром 82 на недоверенном интерфейсе. Варианты:
|
|
dhcp_snooping псевдонимы: dhcp-snooping string |
Доверенный или недоверенный интерфейс DHCP snooping. Варианты:
|
|
discard_mode псевдонимы: discard-mode string |
Настройка режима отбрасывания для порта. Варианты:
|
|
dot1x_enable псевдонимы: dot1x-enable string |
Включение Dot1x. Варианты:
|
|
dsl_profile псевдонимы: dsl-profile string |
Конфигурация политики DSL. |
|
edge_port псевдонимы: edge-port string |
Включить/выключить этот интерфейс в качестве граничного порта для соединения рабочих станций и/или компьютеров. Варианты:
|
|
encrypted_port псевдонимы: encrypted-port integer |
Зашифрованный порт. |
|
export_tags псевдонимы: export-tags any |
(список) Настройка тегов экспорта |
|
export_to псевдонимы: export-to any |
(список) Экспорт порта управляемого коммутатора в VDOM арендатора. |
|
export_to_pool псевдонимы: export-to-pool any |
(список) Экспорт порта контроллера коммутатора в список пулов. |
|
export_to_pool_flag псевдонимы: export-to-pool-flag integer |
Экспорт порта контроллера коммутатора в список пулов. |
|
fallback_port псевдонимы: fallback-port string |
Резервный порт LACP. |
|
fec_capable псевдонимы: fec-capable integer |
Поддержка FEC. |
|
fec_state псевдонимы: fec-state string |
Состояние коррекции ошибок при передаче. Варианты:
|
|
fgt_peer_device_name псевдонимы: fgt-peer-device-name string |
Имя устройства-узла FGT. |
|
fgt_peer_port_name псевдонимы: fgt-peer-port-name string |
Имя порта узла FGT. |
|
fiber_port псевдонимы: fiber-port integer |
Оптоволоконный порт. |
|
flags integer |
Флаги. |
|
flap_duration псевдонимы: flap-duration integer |
Период, за который рассчитываются события переключения состояния. |
|
flap_rate псевдонимы: flap-rate integer |
Количество событий смены состояния, необходимое в течение периода flap-duration. |
|
flap_timeout псевдонимы: flap-timeout integer |
Отключение защиты Flap Guard. |
|
flapguard string |
Включить/выключить защиту от частых переключений состояния. Варианты:
|
|
flow_control псевдонимы: flow-control string |
Направление управления потоком. Варианты:
|
|
fortilink_port aliases: fortilink-port integer |
Порт Fortilink. |
|
fortiswitch_acls aliases: fortiswitch-acls any |
(список) Списки контроля доступа на этом порту. |
|
igmp_snooping aliases: igmp-snooping string |
Задаёт режим отслеживания IGMP для физического интерфейса порта. Варианты:
|
|
igmp_snooping_flood_reports aliases: igmp-snooping-flood-reports string |
Включает или отключает рассылку отчётов IGMP на этот интерфейс при включённом отслеживании IGMP. Варианты:
|
|
igmps_flood_reports aliases: igmps-flood-reports string |
Включает или отключает рассылку отчётов IGMP на этот интерфейс при включённом отслеживании IGMP. Варианты:
|
|
igmps_flood_traffic aliases: igmps-flood-traffic string |
Включает или отключает рассылку трафика отслеживания IGMP на этот интерфейс. Варианты:
|
|
interface_tags aliases: interface-tags any |
(список или строка) Метка |
|
ip_source_guard aliases: ip-source-guard string |
Включает или отключает защиту источника IP-адреса. Варианты:
|
|
isl_local_trunk_name aliases: isl-local-trunk-name string |
Имя локального транка ISL. |
|
isl_peer_device_name aliases: isl-peer-device-name string |
Имя однорангового устройства ISL. |
|
isl_peer_device_sn aliases: isl-peer-device-sn string |
Серийный номер однорангового устройства ISL. |
|
isl_peer_port_name aliases: isl-peer-port-name string |
Имя порта однорангового устройства ISL. |
|
lacp_speed aliases: lacp-speed string |
Интервал Link Aggregation Control Protocol Варианты:
|
|
learning_limit aliases: learning-limit integer |
Ограничивает количество динамических MAC-адресов на этом порту |
|
link_status aliases: link-status string |
Состояние соединения. Варианты:
|
|
lldp_profile aliases: lldp-profile string |
Профиль TLV порта LLDP. |
|
lldp_status aliases: lldp-status string |
Состояние передачи и приёма LLDP. Варианты:
|
|
log_mac_event aliases: log-mac-event string |
Включает или отключает ведение журнала событий динамических MAC-адресов. Варианты:
|
|
loop_guard aliases: loop-guard string |
Включает или отключает защиту от петель на этом интерфейсе — оптимизацию STP для предотвращения сетевых петель. Варианты:
|
|
loop_guard_timeout aliases: loop-guard-timeout integer |
Тайм-аут защиты от петель |
|
mac_addr aliases: mac-addr string |
MAC-адрес порта/транка. |
|
matched_dpp_intf_tags aliases: matched-dpp-intf-tags string |
Совпавшие метки интерфейса в динамической политике портов. |
|
matched_dpp_policy aliases: matched-dpp-policy string |
Совпавшая дочерняя политика в динамической политике портов. |
|
max_bundle aliases: max-bundle integer |
Максимальный размер агрегированного канала LAG |
|
max_miss_heartbeats aliases: max-miss-heartbeats integer |
Максимальное допустимое количество пропущенных сигналов проверки связи. |
|
mcast_snooping_flood_traffic aliases: mcast-snooping-flood-traffic string |
Включает или отключает рассылку трафика отслеживания IGMP на этот интерфейс. Варианты:
|
|
mclag string |
Включает или отключает агрегирование каналов между несколькими шасси Варианты:
|
|
mclag_icl_port aliases: mclag-icl-port integer |
Порт ICL для MCLAG. |
|
media_type aliases: media-type string |
Тип среды передачи. |
|
member_withdrawal_behavior aliases: member-withdrawal-behavior string |
Поведение порта после его исключения из-за потери управляющих пакетов. Варианты:
|
|
members any |
(список) Интерфейсы агрегированного канала LAG. |
|
min_bundle aliases: min-bundle integer |
Минимальный размер агрегированного канала LAG |
|
mode string |
Режим LACP Варианты:
|
|
p2p_port aliases: p2p-port integer |
Порт P2P. |
|
packet_sample_rate aliases: packet-sample-rate integer |
Частота выборки пакетов |
|
packet_sampler aliases: packet-sampler string |
Включает или отключает выборку пакетов на этом интерфейсе. Варианты:
|
|
pause_meter aliases: pause-meter integer |
Задаёт скорость измерения входящих кадров паузы в кбит/с |
|
pause_meter_resume aliases: pause-meter-resume string |
Порог возобновления передачи трафика на входящем порту. Варианты:
|
|
pd_capable aliases: pd-capable integer |
Поддерживает подключение питаемого устройства. |
|
poe_capable aliases: poe-capable integer |
Поддерживает PoE. |
|
poe_max_power aliases: poe-max-power string |
Максимальная мощность PoE. |
|
poe_mode_bt_cabable aliases: poe-mode-bt-cabable integer |
Режим PoE IEEE 802. |
|
poe_port_mode aliases: poe-port-mode string |
Настраивает режим порта PoE. Варианты:
|
|
poe_port_power aliases: poe-port-power string |
Настраивает питание порта PoE. Варианты:
|
|
poe_port_priority aliases: poe-port-priority string |
Настраивает приоритет порта PoE. Варианты:
|
|
poe_pre_standard_detection aliases: poe-pre-standard-detection string |
Включает или отключает обнаружение PoE до стандарта. Варианты:
|
|
poe_standard aliases: poe-standard string |
Стандарт PoE. |
|
poe_status псевдонимы: poe-status string |
Включение/отключение PoE. Варианты:
|
|
port_name псевдонимы: port-name string / обязательный |
Имя порта коммутатора. |
|
port_number псевдонимы: port-number integer |
Номер порта. |
|
port_owner псевдонимы: port-owner string |
Имя порта коммутатора. |
|
port_policy псевдонимы: port-policy string |
Динамическая политика портов контроллера коммутатора из доступных вариантов. |
|
port_prefix_type псевдонимы: port-prefix-type integer |
Тип префикса порта. |
|
port_security_policy псевдонимы: port-security-policy string |
Политика аутентификации контроллера коммутатора, применяемая к этому управляемому коммутатору; выбирается из доступных вариантов. |
|
port_selection_criteria псевдонимы: port-selection-criteria string |
Алгоритм выбора агрегированных портов. Варианты:
|
|
ptp_policy псевдонимы: ptp-policy any |
(список) Конфигурация политики PTP. |
|
ptp_status псевдонимы: ptp-status string |
Включение/отключение политики PTP на этом порту FortiSwitch. Варианты:
|
|
qnq any |
(список) «802.» |
|
qos_policy псевдонимы: qos-policy string |
Политика QoS контроллера коммутатора из доступных вариантов. |
|
restricted_auth_port псевдонимы: restricted-auth-port integer |
Порт с ограниченной аутентификацией. |
|
rpvst_port псевдонимы: rpvst-port string |
Включение/отключение взаимодействия с Rapid PVST на этом интерфейсе. Варианты:
|
|
sample_direction псевдонимы: sample-direction string |
Направление выборки SFlow. Варианты:
|
|
sflow_counter_interval псевдонимы: sflow-counter-interval integer |
Интервал опроса счётчиков пробоотборника SFlow |
|
sflow_sample_rate псевдонимы: sflow-sample-rate integer |
Частота выборки пробоотборника SFlow |
|
sflow_sampler псевдонимы: sflow-sampler string |
Включение/отключение протокола sFlow на этом интерфейсе. Варианты:
|
|
speed string |
Скорость порта коммутатора; значение по умолчанию и доступные параметры зависят от оборудования. Варианты:
|
|
speed_mask псевдонимы: speed-mask integer |
Маска скорости порта коммутатора. |
|
stacking_port псевдонимы: stacking-port integer |
Порт стекирования. |
|
status string |
Административное состояние порта коммутатора Варианты:
|
|
sticky_mac псевдонимы: sticky-mac string |
Включение или отключение sticky MAC на интерфейсе. Варианты:
|
|
storm_control_policy псевдонимы: storm-control-policy string |
Политика контроля штормового трафика контроллера коммутатора из доступных вариантов. |
|
stp_bpdu_guard псевдонимы: stp-bpdu-guard string |
Включение/отключение защиты BPDU STP на этом интерфейсе. Варианты:
|
|
stp_bpdu_guard_timeout псевдонимы: stp-bpdu-guard-timeout integer |
Отключение защиты BPDU Guard |
|
stp_root_guard псевдонимы: stp-root-guard string |
Включение/отключение защиты корневого моста STP на этом интерфейсе. Варианты:
|
|
stp_state псевдонимы: stp-state string |
Включение/отключение протокола связующего дерева Варианты:
|
|
switch_id псевдонимы: switch-id string |
Идентификатор коммутатора. |
|
trunk_member псевдонимы: trunk-member integer |
Участник транкового соединения. |
|
type string |
Тип интерфейса Варианты:
|
|
untagged_vlans псевдонимы: untagged-vlans any |
(список или строка) Настройка VLAN без тегов для порта коммутатора |
|
virtual_port псевдонимы: virtual-port integer |
Виртуализированный порт коммутатора. |
|
vlan string |
Назначение портов коммутатора виртуальной локальной сети (VLAN). |
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; значение может быть global или другим, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, имена всех входных аргументов соответствуют соглашению об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании выводятся предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
- В этом модуле FortiManager поддерживается работа в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого кода rc. Условия завершения с ошибкой или успехом также можно переопределить с помощью параметров rc_failed и rc_succeeded.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Managed-switch port list.
fortinet.fortimanager.fmgr_switchcontroller_managedswitch_ports:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
managed_switch: <your own value>
state: present # <value in [present, absent]>
switchcontroller_managedswitch_ports:
port_name: "your value" # Required variable, string
# allowed_vlans: <list or string>
# allowed_vlans_all: <value in [disable, enable]>
# arp_inspection_trust: <value in [untrusted, trusted]>
# bundle: <value in [disable, enable]>
# description: <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: <integer>
# lldp_profile: <string>
# lldp_status: <value in [disable, rx-only, tx-only, ...]>
# loop_guard: <value in [disabled, enabled]>
# loop_guard_timeout: <integer>
# max_bundle: <integer>
# mclag: <value in [disable, enable]>
# member_withdrawal_behavior: <value in [forward, block]>
# members: <list or string>
# min_bundle: <integer>
# mode: <value in [static, lacp-passive, lacp-active]>
# poe_pre_standard_detection: <value in [disable, enable]>
# poe_status: <value in [disable, enable]>
# port_owner: <string>
# port_security_policy: <string>
# port_selection_criteria: <value in [src-mac, dst-mac, src-dst-mac, ...]>
# qos_policy: <string>
# sample_direction: <value in [rx, tx, both]>
# sflow_counter_interval: <integer>
# sflow_sample_rate: <integer>
# sflow_sampler: <value in [disabled, enabled]>
# stp_bpdu_guard: <value in [disabled, enabled]>
# stp_bpdu_guard_timeout: <integer>
# stp_root_guard: <value in [disabled, enabled]>
# stp_state: <value in [disabled, enabled]>
# type: <value in [physical, trunk]>
# untagged_vlans: <list or string>
# vlan: <string>
# export_to_pool_flag: <integer>
# mac_addr: <string>
# packet_sample_rate: <integer>
# packet_sampler: <value in [disabled, enabled]>
# sticky_mac: <value in [disable, enable]>
# storm_control_policy: <string>
# dot1x_enable: <value in [disable, enable]>
# max_miss_heartbeats: <integer>
# access_mode: <value in [normal, nac, dynamic, ...]>
# ip_source_guard: <value in [disable, enable]>
# mclag_icl_port: <integer>
# p2p_port: <integer>
# aggregator_mode: <value in [bandwidth, count]>
# rpvst_port: <value in [disabled, enabled]>
# flow_control: <value in [disable, tx, rx, ...]>
# media_type: <string>
# pause_meter: <integer>
# pause_meter_resume: <value in [25%, 50%, 75%]>
# trunk_member: <integer>
# fec_capable: <integer>
# fec_state: <value in [disabled, cl74, cl91, ...]>
# matched_dpp_intf_tags: <string>
# matched_dpp_policy: <string>
# port_policy: <string>
# status: <value in [down, up]>
# dsl_profile: <string>
# flap_duration: <integer>
# flap_rate: <integer>
# flap_timeout: <integer>
# flapguard: <value in [disable, enable]>
# interface_tags: <list or string>
# poe_max_power: <string>
# poe_standard: <string>
# igmp_snooping_flood_reports: <value in [disable, enable]>
# mcast_snooping_flood_traffic: <value in [disable, enable]>
# link_status: <value in [down, up]>
# poe_mode_bt_cabable: <integer>
# poe_port_mode: <value in [ieee802-3af, ieee802-3at, ieee802-3bt]>
# poe_port_power: <value in [normal, perpetual, perpetual-fast]>
# poe_port_priority: <value in [critical-priority, high-priority, low-priority, ...]>
# acl_group: <list or string>
# dhcp_snoop_option82_override:
# - circuit_id: <string>
# remote_id: <string>
# vlan_name: <string>
# fortiswitch_acls: <list or integer>
# isl_peer_device_sn: <string>
# authenticated_port: <integer>
# encrypted_port: <integer>
# ptp_status: <value in [disable, enable]>
# restricted_auth_port: <integer>
# allow_arp_monitor: <value in [disable, enable]>
# export_to: <list or string>
# export_to_pool: <list or string>
# fallback_port: <string>
# fgt_peer_device_name: <string>
# fgt_peer_port_name: <string>
# fiber_port: <integer>
# flags: <integer>
# fortilink_port: <integer>
# isl_local_trunk_name: <string>
# isl_peer_device_name: <string>
# isl_peer_port_name: <string>
# poe_capable: <integer>
# port_number: <integer>
# port_prefix_type: <integer>
# ptp_policy: <list or string>
# speed: <value in [auto, 10full, 10half, ...]>
# speed_mask: <integer>
# stacking_port: <integer>
# switch_id: <string>
# virtual_port: <integer>
# export_tags: <list or string>
# log_mac_event: <value in [disable, enable]>
# pd_capable: <integer>
# qnq: <list or string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что текущая версия FortiManager не поддерживает параметры, используемые в плейбуке. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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/fortimanager/fmgr_switchcontroller_managedswitch_ports_module.html