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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью маркера доступа к API forticloud.
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
switchcontroller_dynamicportpolicy словарь	Настроены параметры верхнего уровня.
description строка	Описание политики динамического порта.
fortilink любой	(список) Интерфейс FortiLink, к которому относится эта политика динамического порта.
name строка / обязательно	Имя политики динамического порта.
policy список / элементы=словарь	Политика.
802_1x строка	Устарело, пожалуйста, переименуйте его на 802_1x. ‘802.’
bounce_port_link строка	Устарело, пожалуйста, переименуйте его на bounce_port_link. Включить/выключить переотражение Варианты: `"disable"` `"enable"`
category строка	Категория политики динамического порта. Варианты: `"device"` `"interface-tag"`
description строка	Описание политики.
family строка	Соответствие политике на основе семейства.
host строка	Соответствие политике на основе хоста.
hw_vendor строка	Устарело, пожалуйста, переименуйте его на hw_vendor. Соответствие политике на основе производителя оборудования.

interface-tags any	(list) Устарело, пожалуйста, переименуйте на interface_tags. Сопоставление политики на основе тегов интерфейсов FortiSwitch.
lldp-profile string	Устарело, пожалуйста, переименуйте на lldp_profile. Профиль LLDP, который необходимо применить при использовании этой политики.
mac string	Сопоставление политики на основе MAC-адреса.
match-period integer	Устарело, пожалуйста, переименуйте на match_period. Количество дней, в течение которых сопоставленные устройства будут храниться.
match-type string	Устарело, пожалуйста, переименуйте на match_type. Сопоставление и сохранение устройств на основе типа. Варианты: `"dynamic"` `"override"`
name string	Имя политики.
qos-policy string	Устарело, пожалуйста, переименуйте на qos_policy. Политика QoS, которая должна быть применена при использовании этой политики.
status string	Включение/выключение политики. Варианты: `"disable"` `"enable"`
type string	Сопоставление политики по типу.
vlan-policy string	Устарело, пожалуйста, переименуйте на vlan_policy. Политика VLAN, которая должна быть применена при использовании этой политики.
workspace_locking_adom string	Область, которую необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая 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 помогают выполнить работу.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код возврата. Вы также можете переопределить условия для завершения работы с ошибкой или успехом с помощью параметров 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: Configure Dynamic port policy to be applied on the managed FortiSwitch ports through DPP device.
      fortinet.fortimanager.fmgr_switchcontroller_dynamicportpolicy:
        # 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: present # <value in [present, absent]>
        switchcontroller_dynamicportpolicy:
          description: <string>
          name: <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]>
          fortilink: <list or string>

Значения возврата

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

Ключ	Описание
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_switchcontroller_dynamicportpolicy_module.html