Модуль fortinet.fortimanager.fmgr_switchcontroller_dynamicportpolicy_policy — Политики портов с критериями сопоставления и действиями.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation логический	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
dynamic-port-policy строка	Устарело; используйте “dynamic_port_policy”.
dynamic_port_policy строка	Параметр (dynamic-port-policy) в запрошенном URL.
enable_log логический	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method строка	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, переопределяющий условия неудачного выполнения.
rc_succeeded список / элементы=целое число	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note строка	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state строка / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
switchcontroller_dynamicportpolicy_policy словарь	Набор параметров верхнего уровня.
802_1x псевдонимы: 802-1x строка
bounce_port_duration псевдонимы: bounce-port-duration целое число	Длительность отключения и повторного включения порта коммутатора, к которому применяется эта политика, в секундах.
bounce_port_link псевдонимы: bounce-port-link строка	Включить/отключить отключение и повторное включение соединения. Варианты: `"disable"` `"enable"`
category строка	Категория динамической политики портов. Варианты: `"device"` `"interface-tag"`
description строка	Описание политики.
family строка	Сопоставление политики по семейству.
host строка	Сопоставление политики по узлу.
hw_vendor псевдонимы: hw-vendor строка	Сопоставление политики по производителю оборудования.
interface_tags псевдонимы: interface-tags любое значение	(список) Сопоставление политики по тегам объекта интерфейса FortiSwitch.
lldp_profile псевдонимы: lldp-profile строка	Профиль LLDP, применяемый при использовании этой политики.
mac строка	Сопоставление политики по MAC-адресу.
match_period псевдонимы: match-period целое число	Количество дней, в течение которых будут сохраняться сопоставленные устройства.
match_remove псевдонимы: match-remove строка	Параметры удаления сопоставленных устройств, для которых заданы переопределения. Варианты: `"link-down"` `"default"`
match_type псевдонимы: match-type строка	Сопоставление и сохранение устройств по типу. Варианты: `"dynamic"` `"override"`
name строка / обязательный	Имя политики.
poe_reset псевдонимы: poe-reset строка	Включить/отключить сброс питания PoE порта коммутатора, к которому применяется эта политика. Варианты: `"disable"` `"enable"`
qos_policy псевдонимы: qos-policy строка	Политика QoS, применяемая при использовании этой политики.
status строка	Включить/отключить политику. Варианты: `"disable"` `"enable"`
type строка	Сопоставление политики по типу.
vlan_policy псевдонимы: vlan-policy строка	Политика VLAN, применяемая при использовании этой политики.
workspace_locking_adom строка	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout целое число	Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах. По умолчанию: `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: Port policies with matching criteria and actions.
      fortinet.fortimanager.fmgr_switchcontroller_dynamicportpolicy_policy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        dynamic_port_policy: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_dynamicportpolicy_policy:
          name: "your value" # Required variable, string
          # 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>
          # 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]>

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный запрошенный URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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_policy_module.html