fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy модуль — Настройка политик формирования трафика.

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy.

Новая функция в fortinet.fortimanager 2.0.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.
pkg строка / обязательно	Параметр (pkg) в запрошенном URL.
pkg_firewall_shapingpolicy словарь	Настройка верхнего уровня параметров.
app_category любой	(список или строка) Устарело, переименуйте на app_category. Идентификаторы одной или нескольких категорий приложений, к которым…
app_group любой	(список или строка) Устарело, переименуйте на app_group. Одно или несколько имён групп приложений.
application любой	(список) Идентификаторы одного или нескольких приложений, к которым этот формировщик применяет формирование трафика для управления приложениями.
class_id любой	(целое или строка) Устарело, переименуйте на class_id. Идентификатор класса трафика.
comment строка	Комментарии.
cos строка	Шаблон битов VLAN CoS.
cos_mask строка	Устарело, переименуйте на cos_mask. Оцениваемые биты VLAN CoS.
diffserv_forward строка	Устарело, переименуйте на diffserv_forward. Включить изменение значений DiffServ пакетов до указанного diffservcode-f… Варианты: `"disable"` `"enable"`
diffserv_reverse строка	Устарело, переименуйте на diffserv_reverse. Включить изменение значений DiffServ пакетов обратной стороны Варианты: `"disable"` `"enable"`
diffservcode_forward строка	Устарело, переименуйте на diffservcode_forward. Изменить DiffServ пакетов на это значение.
diffservcode_rev строка	Устарело, переименуйте на diffservcode_rev. Изменить пакеты обратной стороны
dstaddr любой	(список или строка) IPv4 адрес назначения и имена групп адресов.
dstaddr6 любой	(список или строка) IPv6 адрес назначения и имена групп адресов.
dstintf любой	(список или строка) Один или несколько исходящих
groups любой	(список или строка) Применить эту политику формирования трафика к группам пользователей, которые авторизовались на FortiGate.

id integer / required	Идентификатор политики формирования трафика.
internet-service string	Устарело, переименуйте в internet_service. Включить/отключить использование интернет-сервисов для этой политики. Choices: `"disable"` `"enable"`
internet-service-custom any	(list or str) Устарело, переименуйте в internet_service_custom. Название пользовательского интернет-сервиса.
internet-service-custom-group any	(list or str) Устарело, переименуйте в internet_service_custom_group. Название группы пользовательских интернет-сервисов.
internet-service-group any	(list or str) Устарело, переименуйте в internet_service_group. Название группы интернет-сервисов.
internet-service-id any	(list or str) Устарело, переименуйте в internet_service_id. Идентификатор интернет-сервиса.
internet-service-name any	(list or str) Устарело, переименуйте в internet_service_name. Идентификатор интернет-сервиса.
internet-service-src string	Устарело, переименуйте в internet_service_src. Включить/отключить использование интернет-сервисов в источнике для этой политики. Choices: `"disable"` `"enable"`
internet-service-src-custom any	(list or str) Устарело, переименуйте в internet_service_src_custom. Название пользовательского интернет-сервиса источника.
internet-service-src-custom-group any	(list or str) Устарело, переименуйте в internet_service_src_custom_group. Название группы пользовательских интернет-сервисов источника.
internet-service-src-group any	(list or str) Устарело, переименуйте в internet_service_src_group. Название группы интернет-сервисов источника.
internet-service-src-id any	(list or str) Устарело, переименуйте в internet_service_src_id. Идентификатор интернет-сервиса источника.
internet-service-src-name any	(list or str) Устарело, переименуйте в internet_service_src_name. Название интернет-сервиса источника.
ip-version string	Устарело, переименуйте в ip_version. Применить эту политику формирования трафика к трафику IPv4 или IPv6. Choices: `"4"` `"6"`
name string	Имя политики формирования трафика.
per-ip-shaper string	Устарело, переименуйте в per_ip_shaper. Формирователь трафика на основе IP-адресов для применения с этой политикой.
schedule string	Имя расписания.
service any	(list or str) Имена сервисов и групп сервисов.
srcaddr any	(list or str) Имена исходных IPv4-адресов и групп адресов.
srcaddr6 any	(list or str) Имена исходных IPv6-адресов и групп адресов.
srcintf any	(list or str) Один или более входящих

status string	Включить/выключить эту политику формирования трафика. Варианты: `"disable"` `"enable"`
tos string	ToS
tos-mask string	Устарело, пожалуйста, переименуйте на tos_mask. Не нулевые биты используются для сравнения, а нулевые игнорируются.
tos-negate string	Устарело, пожалуйста, переименуйте на tos_negate. Включить соответствие с отрицанием ToS. Варианты: `"disable"` `"enable"`
traffic-shaper string	Устарело, пожалуйста, переименуйте на traffic_shaper. Политика формирования трафика, применяемая к трафику, передаваемому через политику брандмауэра.
traffic-shaper-reverse string	Устарело, пожалуйста, переименуйте на traffic_shaper_reverse. Политика формирования трафика, применяемая к ответному трафику, полученному брандмауэром…
traffic-type string	Устарело, пожалуйста, переименуйте на traffic_type. Тип трафика. Варианты: `"forwarding"` `"local-in"` `"local-out"`
url-category any	(список или строка) Устарело, пожалуйста, переименуйте на url_category. Идентификаторы одной или нескольких категорий FortiGuard Web Filtering, к…
users any	(список или строка) Применить эту политику формирования трафика к отдельным пользователям, которые авторизовались на FortiGate.
uuid string	Универсальный уникальный идентификатор
proposed_method string	Переопределённый метод для запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с которыми условия будут игнорироваться для завершения с ошибкой.
rc_succeeded list / elements=integer	Список кодов rc, с которыми условия будут игнорироваться для успешного завершения.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	Область, которую необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень.
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 отличный от нуля. Вы также можете переопределить условия для завершения с ошибкой или успешного завершения с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure shaping policies.
      fortinet.fortimanager.fmgr_pkg_firewall_shapingpolicy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_shapingpolicy:
          dstaddr: all
          dstintf: any
          id: 1
          ip-version: 4 # <value in [4, 6]>
          schedule: always
          service: ALL
          srcaddr: all
          status: disable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the shaping policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_shapingpolicy"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            shaping-policy: "your_value"

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

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

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