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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
switchcontroller_dynamicportpolicy_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 любой тип	(список) Устарело, переименуйте в interface_tags. Сопоставление политики на основе тегов объекта интерфейса FortiSwitch.
lldp_profile строка	Устарело, переименуйте в lldp_profile. Профиль LLDP, который применяется при использовании этой политики.

END_OF_DOCUMENT_MARKER

mac строка	Сопоставление политики на основе MAC-адреса.
match-period целое число	Устарело, пожалуйста, переименуйте на match_period. Количество дней, в течение которого сопоставленные устройства будут сохраняться
match-type строка	Устарело, пожалуйста, переименуйте на match_type. Сопоставление и сохранение устройств на основе типа. Варианты: `"dynamic"` `"override"`
name строка / обязательно	Имя политики.
qos-policy строка	Устарело, пожалуйста, переименуйте на qos_policy. Политика QoS, которая должна применяться при использовании этой политики.
status строка	Включить/выключить политику. Варианты: `"disable"` `"enable"`
type строка	Сопоставление политики на основе типа.
vlan-policy строка	Устарело, пожалуйста, переименуйте на vlan_policy. Политика VLAN, которая должна применяться при использовании этой политики.
workspace_locking_adom строка	ADOM для блокировки при работе в режиме рабочего пространства FortiManager, значение может быть глобальным и другими, включая 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 помогают в этом.
Для создания или обновления объекта используйте директиву 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: Port policies with matching criteria and actions.
      fortinet.fortimanager.fmgr_switchcontroller_dynamicportpolicy_policy:
        # 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>
        dynamic_port_policy: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_dynamicportpolicy_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]>

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

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

Ключ	Описание
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_policy_module.html