Модуль fortinet.fortimanager.fmgr_switchcontroller_dynamicportpolicy — настройка динамической политики портов для применения к управляемым портам FortiSwitch через устройство DPP.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

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

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

Добавлено в fortinet.fortimanager 2.2.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True, только если схема модуля отличается от структуры API FortiManager: модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, для которых будут переопределены условия сбоя.
rc_succeeded list / elements=integer	Список кодов rc, для которых будут переопределены условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Инструкция для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
switchcontroller_dynamicportpolicy dictionary	Набор параметров верхнего уровня.
description string	Описание динамической политики портов.
fortilink any	(список) Интерфейс FortiLink, к которому относится эта динамическая политика портов.
name string / обязательный	Имя динамической политики портов.
policy list / elements=dictionary	Политика.
802_1x псевдонимы: 802-1x string
bounce_port_duration псевдонимы: bounce-port-duration integer	Длительность перезапуска порта коммутатора в секундах, если к нему применяется эта политика.
bounce_port_link псевдонимы: bounce-port-link string	Включить или отключить перезапуск соединения Варианты: `"disable"` `"enable"`
category string	Категория динамической политики портов. Варианты: `"device"` `"interface-tag"`
description string	Описание политики.
family string	Сопоставление политики по семейству устройств.
host string	Сопоставление политики по узлу.
hw_vendor псевдонимы: hw-vendor string	Сопоставление политики по производителю оборудования.
interface_tags псевдонимы: interface-tags any	(список) Сопоставление политики по тегам объекта интерфейса FortiSwitch.
lldp_profile псевдонимы: lldp-profile string	Профиль LLDP, применяемый при использовании этой политики.
mac string	Сопоставление политики по MAC-адресу.
match_period псевдонимы: match-period integer	Количество дней хранения сопоставленных устройств
match_remove псевдонимы: match-remove string	Параметры удаления сопоставленных устройств с переопределениями. Варианты: `"link-down"` `"default"`
match_type псевдонимы: match-type string	Сопоставление и сохранение устройств по типу. Варианты: `"dynamic"` `"override"`
name string	Имя политики.
poe_reset псевдонимы: poe-reset string	Включить или отключить сброс POE порта коммутатора, к которому применяется эта политика. Варианты: `"disable"` `"enable"`
qos_policy псевдонимы: qos-policy string	Политика QoS, применяемая при использовании этой политики.
status string	Включить или отключить политику. Варианты: `"disable"` `"enable"`
type string	Сопоставление политики по типу.
vlan_policy псевдонимы: vlan-policy string	Политика VLAN, применяемая при использовании этой политики.
workspace_locking_adom string	ADOM для блокировки в FortiManager, работающем в режиме рабочей области; значение может быть global или другим, включая root.
workspace_locking_timeout integer	Максимальное время ожидания (в секундах) освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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: Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device.
      fortinet.fortimanager.fmgr_switchcontroller_dynamicportpolicy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_dynamicportpolicy:
          name: "your value" # Required variable, string
          # description: <string>
          # policy:
          #   - 802_1x: <string>
          #     bounce_port_link: <value in [disable, enable]>
          #     category: <value in [device, interface-tag]>
          #     description: <string>
          #     family: <string>
          #     host: <string>
          #     hw_vendor: <string>
          #     interface_tags: <list or string>
          #     lldp_profile: <string>
          #     mac: <string>
          #     name: <string>
          #     qos_policy: <string>
          #     status: <value in [disable, enable]>
          #     type: <string>
          #     vlan_policy: <string>
          #     match_period: <integer>
          #     match_type: <value in [dynamic, override]>
          #     bounce_port_duration: <integer>
          #     poe_reset: <value in [disable, enable]>
          #     match_remove: <value in [link-down, default]>
          # fortilink: <list or string>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при наличии условий

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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_dynamicportpolicy_module.html