Модуль fortinet.fortimanager.fmgr_switchcontroller_managedswitch_ports – Список портов управляемого коммутатора.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включение/выключение ведения журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
managed-switch строка | Устарело, используйте «managed_switch» |
managed_switch строка | Параметр (managed-switch) в запрошенном URL. |
proposed_method строка | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое | Список rc-кодов, с которыми будут переопределены условия для завершения неудачно. |
rc_succeeded список / элементы=целое | Список rc-кодов, с которыми будут переопределены условия для успешного завершения. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
switchcontroller_managedswitch_ports словарь | Параметры верхнего уровня. |
|
access_mode строка |
Устарело, переименуйте на access_mode. Режим доступа порта. Варианты:
|
|
acl_group любой |
(список) Устарело, переименуйте на acl_group. Группы ACL на этом порту. |
|
aggregator_mode строка |
Устарело, переименуйте на aggregator_mode. Режим выбора членов LACP. Варианты:
|
|
allow_arp_monitor строка |
Устарело, переименуйте на allow_arp_monitor. Включение/выключение мониторинга ARP. Варианты:
|
|
allowed_vlans любой |
(список или строка) Устарело, переименуйте на allowed_vlans. Настройка помеченных VLAN на порту коммутатора. |
|
allowed_vlans_all строка |
Устарело, переименуйте на allowed_vlans_all. Включение/выключение всех определённых VLAN на этом порту. Варианты:
|
|
arp_inspection_trust строка |
Устарело, переименуйте на arp_inspection_trust. Доверенный или недоверенный динамический контроль ARP. Варианты:
|
|
authenticated-port integer |
Устарело, переименуйте в authenticated_port. Аутентифицированный порт. |
|
bundle string |
Включить/отключить группу агрегации каналов Варианты:
|
|
description string |
Описание порта. |
|
dhcp-snoop-option82-override list / elements=dictionary |
Устарело, переименуйте в dhcp_snoop_option82_override. Переопределение параметра DHCP snoop option82. |
|
circuit-id string |
Устарело, переименуйте в circuit_id. Строка идентификатора канала. |
|
remote-id string |
Устарело, переименуйте в remote_id. Строка удаленного идентификатора. |
|
vlan-name string |
Устарело, переименуйте в vlan_name. VLAN для DHCP snooping option 82. |
|
dhcp-snoop-option82-trust string |
Устарело, переименуйте в dhcp_snoop_option82_trust. Включить/отключить разрешение DHCP с option-82 на ненадежных… Варианты:
|
|
dhcp-snooping string |
Устарело, переименуйте в dhcp_snooping. Доверенный или недоверенный интерфейс DHCP-snooping. Варианты:
|
|
discard-mode string |
Устарело, переименуйте в discard_mode. Настроить режим отбрасывания для порта. Варианты:
|
|
dot1x-enable string |
Устарело, переименуйте в dot1x_enable. Включение Dot1x. Варианты:
|
|
dsl-profile string |
Устарело, переименуйте в dsl_profile. Конфигурация политики DSL. |
|
edge-port string |
Устарело, переименуйте в edge_port. Включить/отключить этот интерфейс как граничный порт, соединяющий… Варианты:
|
|
encrypted-port integer |
Устарело, переименуйте в encrypted_port. Зашифрованный порт. |
|
export-tags any |
(список) Устарело, переименуйте в export_tags. Настроить экспортный тег |
|
export-to any |
(список) Устарело, переименуйте в export_to. Экспорт управляемого порта коммутатора в виртуальный домен арендатора. |
|
export-to-pool any |
(список) Устарело, переименуйте в export_to_pool. Экспорт порта контроллера коммутатора в список пулов. |
|
export-to-pool-flag integer |
Устарело, переименуйте в export_to_pool_flag. Экспорт порта контроллера коммутатора в список пулов. |
|
fallback-port string |
Устарело, переименуйте в fallback_port. Резервный порт LACP. |
|
fec-capable integer |
Устарело, переименуйте в fec_capable. Поддержка FEC. |
|
fec-state string |
Устарело, переименуйте в fec_state. Состояние коррекции ошибок вперёд. Choices:
|
|
fgt-peer-device-name string |
Устарело, переименуйте в fgt_peer_device_name. Имя устройства-партнёра Fgt. |
|
fgt-peer-port-name string |
Устарело, переименуйте в fgt_peer_port_name. Имя порта-партнёра Fgt. |
|
fiber-port integer |
Устарело, переименуйте в fiber_port. Оптоволоконный порт. |
|
flags integer |
Флаги. |
|
flap-duration integer |
Устарело, переименуйте в flap_duration. Период, за который вычисляются события отключения/подключения. |
|
flap-rate integer |
Устарело, переименуйте в flap_rate. Количество событий изменения состояния, необходимых в течение flap-duration. |
|
flap-timeout integer |
Устарело, переименуйте в flap_timeout. Защита от отключения/подключения Flap Guard. |
|
flapguard string |
Включить/отключить Flap Guard. Choices:
|
|
flow-control string |
Устарело, переименуйте в flow_control. Направление контроля потока. Choices:
|
|
fortilink-port integer |
Устарело, переименуйте в fortilink_port. Порт Fortilink. |
|
fortiswitch-acls any |
(список) Устарело, переименуйте в fortiswitch_acls. ACL на этом порту. |
|
igmp-snooping string |
Устарело, переименуйте в igmp_snooping. Установите режим IGMP snooping для физического интерфейса порта. Choices:
|
|
igmp-snooping-flood-reports string |
Устарело, переименуйте в igmp_snooping_flood_reports. Включить/отключить заливку отчётов IGMP на этот интерфейс… Choices:
|
|
igmps-flood-reports string |
Устарело, переименуйте в igmps_flood_reports. Включить/отключить заливку отчётов IGMP на этот интерфейс, когда igmp-s… Choices:
|
|
igmps-flood-traffic string |
Устарело, переименуйте в igmps_flood_traffic. Включить/отключить заливку трафика IGMP snooping на этот интерфейс. Choices:
|
|
interface-tags any |
(список или строка) Устарело, переименуйте в interface_tags. Тег |
|
ip-source-guard string |
Устарело, переименуйте в ip_source_guard. Включить/отключить защиту источника IP. Choices:
|
|
isl-local-trunk-name string |
Устарело, переименуйте в isl_local_trunk_name. Имя локального магистрального порта Isl. |
|
isl-peer-device-name string |
Устаревшее, пожалуйста, переименуйте на isl_peer_device_name. Имя устройства peer isl. |
|
isl-peer-device-sn string |
Устаревшее, пожалуйста, переименуйте на isl_peer_device_sn. Серийный номер устройства peer isl. |
|
isl-peer-port-name string |
Устаревшее, пожалуйста, переименуйте на isl_peer_port_name. Имя порта peer isl. |
|
lacp-speed string |
Устаревшее, пожалуйста, переименуйте на lacp_speed. Конец протокола агрегирования каналов Link Aggregation Control Protocol Варианты:
|
|
learning-limit integer |
Устаревшее, пожалуйста, переименуйте на learning_limit. Ограничение количества динамических MAC-адресов на этом порту |
|
link-status string |
Устаревшее, пожалуйста, переименуйте на link_status. Статус канала. Варианты:
|
|
lldp-profile string |
Устаревшее, пожалуйста, переименуйте на lldp_profile. Профиль TLV порта LLDP. |
|
lldp-status string |
Устаревшее, пожалуйста, переименуйте на lldp_status. Статус передачи и приема LLDP. Варианты:
|
|
log-mac-event string |
Устаревшее, пожалуйста, переименуйте на log_mac_event. Включить/выключить протоколирование событий динамических MAC-адресов. Варианты:
|
|
loop-guard string |
Устаревшее, пожалуйста, переименуйте на loop_guard. Включить/выключить loop-guard на этом интерфейсе, оптимизация STP, используемая для предотвращ... Варианты:
|
|
loop-guard-timeout integer |
Устаревшее, пожалуйста, переименуйте на loop_guard_timeout. Тайм-аут loop-guard |
|
mac-addr string |
Устаревшее, пожалуйста, переименуйте на mac_addr. MAC-адрес порта/трафика. |
|
matched-dpp-intf-tags string |
Устаревшее, пожалуйста, переименуйте на matched_dpp_intf_tags. Сопоставленные теги интерфейса в динамической политике порта. |
|
matched-dpp-policy string |
Устаревшее, пожалуйста, переименуйте на matched_dpp_policy. Сопоставленная дочерняя политика в динамической политике порта. |
|
max-bundle integer |
Устаревшее, пожалуйста, переименуйте на max_bundle. Максимальный размер группы LAG. |
|
max-miss-heartbeats integer |
Устаревшее, пожалуйста, переименуйте на max_miss_heartbeats. Максимальное допустимое количество пропущенных сердечных ударов. |
|
mcast-snooping-flood-traffic string |
Устаревшее, пожалуйста, переименуйте на mcast_snooping_flood_traffic. Включить/выключить рассылку трафика IGMP snooping на этот инт… Варианты:
|
|
mclag string |
Включить/выключить агрегирование каналов многомачтовой связи Варианты:
|
|
mclag-icl-port integer |
Устаревшее, пожалуйста, переименуйте на mclag_icl_port. Mclag icl порт. |
|
media-type string |
Устарело, переименуйте в media_type. Тип носителя. |
|
member-withdrawal-behavior string |
Устарело, переименуйте в member_withdrawal_behavior. Поведение порта после его отключения из-за потери контроля… Choices:
|
|
members any |
(list) Агрегированные интерфейсы LAG-связки. |
|
min-bundle integer |
Устарело, переименуйте в min_bundle. Минимальный размер LAG-связки |
|
mode string |
Режим LACP Choices:
|
|
p2p-port integer |
Устарело, переименуйте в p2p_port. P2p-порт. |
|
packet-sample-rate integer |
Устарело, переименуйте в packet_sample_rate. Скорость выборочного анализа пакетов |
|
packet-sampler string |
Устарело, переименуйте в packet_sampler. Включить/отключить выборочный анализ пакетов на этом интерфейсе. Choices:
|
|
pause-meter integer |
Устарело, переименуйте в pause_meter. Настроить скорость измерения паузы на входе, в кбит/с |
|
pause-meter-resume string |
Устарело, переименуйте в pause_meter_resume. Пороговое значение возобновления трафика на входном порту. Choices:
|
|
pd-capable integer |
Устарело, переименуйте в pd_capable. Возможность питания устройства. |
|
poe-capable integer |
Устарело, переименуйте в poe_capable. Поддержка PoE. |
|
poe-max-power string |
Устарело, переименуйте в poe_max_power. Максимальная мощность PoE. |
|
poe-mode-bt-cabable integer |
Устарело, переименуйте в poe_mode_bt_cabable. Режим PoE IEEE 802. |
|
poe-port-mode string |
Устарело, переименуйте в poe_port_mode. Настроить режим порта PoE. Choices:
|
|
poe-port-power string |
Устарело, переименуйте в poe_port_power. Настроить мощность порта PoE. Choices:
|
|
poe-port-priority string |
Устарело, переименуйте в poe_port_priority. Настроить приоритет порта PoE. Choices:
|
|
poe-pre-standard-detection string |
Устарело, переименуйте в poe_pre_standard_detection. Включить/отключить обнаружение PoE до стандарта. Choices:
|
|
poe-standard string |
Устарело, переименуйте в poe_standard. Стандарт PoE. |
|
poe-status string |
Устарело, переименуйте в poe_status. Включить/выключить PoE. Choices:
|
|
port-name string / required |
Устарело, переименуйте в port_name. Имя порта коммутатора. |
|
port-number integer |
Устарело, переименуйте в port_number. Номер порта. |
|
port-owner string |
Устарело, переименуйте в port_owner. Имя порта коммутатора. |
|
port-policy string |
Устарело, переименуйте в port_policy. Динамическая политика порта контроллера коммутатора из доступных вариантов. |
|
port-prefix-type integer |
Устарело, переименуйте в port_prefix_type. Тип префикса порта. |
|
port-security-policy string |
Устарело, переименуйте в port_security_policy. Политика аутентификации контроллера коммутатора для применения к этому управляемому swi… |
|
port-selection-criteria string |
Устарело, переименуйте в port_selection_criteria. Алгоритм выбора агрегированного порта. Choices:
|
|
ptp-policy any |
(list) Устарело, переименуйте в ptp_policy. Конфигурация политики PTP. |
|
ptp-status string |
Устарело, переименуйте в ptp_status. Включить/выключить политику PTP на этом порту FortiSwitch. Choices:
|
|
qnq any |
(list) ‘802.’ |
|
qos-policy string |
Устарело, переименуйте в qos_policy. Политика QoS контроллера коммутатора из доступных вариантов. |
|
restricted-auth-port integer |
Устарело, переименуйте в restricted_auth_port. Порт с ограниченной аутентификацией. |
|
rpvst-port string |
Устарело, переименуйте в rpvst_port. Включить/выключить взаимодействие с rapid PVST на этом интерфейсе. Choices:
|
|
sample-direction string |
Устарело, переименуйте в sample_direction. Направление выборки SFlow. Choices:
|
|
sflow-counter-interval integer |
Устарело, переименуйте в sflow_counter_interval. Интервал опроса счетчика семплера SFlow |
|
sflow-sample-rate integer |
Устарело, переименуйте в sflow_sample_rate. Частота выборки семплера SFlow |
|
sflow-sampler string |
Устарело, переименуйте в sflow_sampler. Включить/выключить протокол sFlow на этом интерфейсе. Choices:
|
|
speed string |
Скорость порта коммутатора; значения по умолчанию и доступные настройки зависят от оборудования. Choices:
|
|
speed-mask integer |
Устарело, переименуйте в speed_mask. Маска скорости порта коммутатора. |
|
stacking-port integer |
Устарело, переименуйте в stacking_port. Порт стекирования. |
|
status string |
Административный статус порта коммутатора Choices:
|
|
sticky-mac string |
Устарело, переименуйте в sticky_mac. Включить или отключить sticky-mac на интерфейсе. Choices:
|
|
storm-control-policy string |
Устарело, переименуйте в storm_control_policy. Политика контроля шторма контроллера коммутатора из доступных вариантов. |
|
stp-bpdu-guard string |
Устарело, переименуйте в stp_bpdu_guard. Включить/отключить защиту STP BPDU на этом интерфейсе. Choices:
|
|
stp-bpdu-guard-timeout integer |
Устарело, переименуйте в stp_bpdu_guard_timeout. Защита от отключения BPDU Guard |
|
stp-root-guard string |
Устарело, переименуйте в stp_root_guard. Включить/отключить защиту корня STP на этом интерфейсе. Choices:
|
|
stp-state string |
Устарело, переименуйте в stp_state. Включить/отключить протокол Spanning Tree Protocol Choices:
|
|
switch-id string |
Устарело, переименуйте в switch_id. ID коммутатора. |
|
trunk-member integer |
Устарело, переименуйте в trunk_member. Участник магистрали. |
|
type string |
Тип интерфейса Choices:
|
|
untagged-vlans any |
(список или строка) Устарело, переименуйте в untagged_vlans. Настройка не помеченных VLAN портов коммутатора |
|
virtual-port integer |
Устарело, переименуйте в virtual_port. Виртуализованный порт коммутатора. |
|
vlan string |
Назначить порты коммутатора VLAN. |
workspace_locking_adom string | ADOM для блокировки для FortiManager, работающего в режиме рабочей области, значение может быть global и другими, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочей области. Default: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы имеют имя в стиле snake_case. Пожалуйста, измените аргументы, такие как «var-name», на «var_name». Старые имена аргументов все еще доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области. Параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой rc. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Managed-switch port list.
fortinet.fortimanager.fmgr_switchcontroller_managedswitch_ports:
# 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>
managed_switch: <your own value>
state: present # <value in [present, absent]>
switchcontroller_managedswitch_ports:
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_name: <string>
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 словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус API запроса. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_switchcontroller_managedswitch_ports_module.html