Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

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.

pkg

string / обязательный

Параметр (pkg) в запрошенном URL.

pkg_firewall_shapingpolicy

dictionary

Набор параметров верхнего уровня.

app_category

псевдонимы: app-category

any

(список или строка) Идентификаторы одной или нескольких категорий приложений, для трафика которых эта политика управления полосой пропускания применяет управление трафиком приложений.

app_group

псевдонимы: app-group

any

(список или строка) Одно или несколько имен групп приложений.

application

any

(список) Идентификаторы одного или нескольких приложений, для трафика которых эта политика управления полосой пропускания применяет управление трафиком приложений.

class_id

псевдонимы: class-id

any

(целое число или строка) Идентификатор класса трафика.

class_id_reverse

псевдонимы: class-id-reverse

integer

Идентификатор класса для обратного направления.

comment

string

Комментарии.

cos

string

Битовая маска CoS VLAN.

cos_mask

псевдонимы: cos-mask

string

Биты CoS VLAN, используемые для проверки.

diffserv_forward

псевдонимы: diffserv-forward

string

Включить изменение значений DiffServ пакетов на указанное значение diffservcode-forward.

Варианты:

  • "disable"
  • "enable"

diffserv_reverse

псевдонимы: diffserv-reverse

string

Включить изменение параметров обратного трафика пакетов

Варианты:

  • "disable"
  • "enable"

diffservcode_forward

псевдонимы: diffservcode-forward

string

Изменить значение DiffServ пакетов на это значение.

diffservcode_rev

псевдонимы: diffservcode-rev

string

Изменить параметры обратного трафика пакетов

dstaddr

any

(список или строка) Адрес IPv4 назначения и имена групп адресов.

dstaddr6

any

(список или строка) Адрес IPv6 назначения и имена групп адресов.

dstintf

any

(список или строка) Один или несколько исходящих

groups

any

(список или строка) Применить эту политику управления трафиком к группам пользователей, прошедших аутентификацию на FortiGate.

http_response_match

псевдонимы: http-response-match

string

Сопоставление HTTP-ответа.

Варианты:

  • "disable"
  • "enable"

id

integer / обязательный

Идентификатор политики управления полосой пропускания.

internet_service

псевдонимы: internet-service

string

Включить или отключить использование интернет-сервисов для этой политики.

Варианты:

  • "disable"
  • "enable"

internet_service_custom

псевдонимы: internet-service-custom

any

(список или строка) Имя пользовательского интернет-сервиса.

internet_service_custom_group

псевдонимы: internet-service-custom-group

any

(список или строка) Имя пользовательской группы интернет-сервисов.

internet_service_fortiguard

псевдонимы: internet-service-fortiguard

any

(список) Имя интернет-сервиса FortiGuard.

internet_service_group

псевдонимы: internet-service-group

any

(список или строка) Имя группы интернет-сервисов.

internet_service_id

псевдонимы: internet-service-id

any

(список или строка) Идентификатор интернет-сервиса.

internet_service_name

псевдонимы: internet-service-name

any

(список или строка) Идентификатор интернет-сервиса.

internet_service_src

псевдонимы: internet-service-src

string

Включить или отключить использование интернет-сервисов в качестве источника для этой политики.

Варианты:

  • "disable"
  • "enable"

internet_service_src_custom

псевдонимы: internet-service-src-custom

any

(список или строка) Имя пользовательского интернет-сервиса источника.

internet_service_src_custom_group

псевдонимы: internet-service-src-custom-group

any

(список или строка) Имя пользовательской группы интернет-сервисов источника.

internet_service_src_fortiguard

псевдонимы: internet-service-src-fortiguard

any

(список) Имя интернет-сервиса FortiGuard — источника.

internet_service_src_group

псевдонимы: internet-service-src-group

any

(список или строка) Имя группы интернет-сервисов источника.

internet_service_src_id

псевдонимы: internet-service-src-id

any

(список или строка) Идентификатор интернет-сервиса источника.

internet_service_src_name

псевдонимы: internet-service-src-name

any

(список или строка) Имя интернет-сервиса источника.

ip_version

псевдонимы: ip-version

string

Применить эту политику управления трафиком к трафику IPv4 или IPv6.

Варианты:

  • "4"
  • "6"

name

string

Имя политики управления полосой пропускания.

per_ip_shaper

псевдонимы: per-ip-shaper

string

Управление полосой пропускания для каждого IP-адреса, применяемое этой политикой.

schedule

string

Имя расписания.

service

any

(список или строка) Имена сервисов и групп сервисов.

service_type

псевдонимы: service-type

string

Выберите тип сервиса

Варианты:

  • "service"
  • "internet-service"

srcaddr

any

(список или строка) Адрес IPv4 источника и имена групп адресов.

srcaddr6

any

(список или строка) Адрес IPv6 источника и имена групп адресов.

srcintf

any

(список или строка) Один или несколько входящих

status

string

Включить или отключить эту политику управления трафиком.

Варианты:

  • "disable"
  • "enable"

tos

string

ToS

tos_mask

псевдонимы: tos-mask

string

Ненулевые позиции битов используются для сравнения, а нулевые позиции игнорируются.

tos_negate

псевдонимы: tos-negate

string

Включить инвертированное сопоставление TOS.

Варианты:

  • "disable"
  • "enable"

traffic_shaper

псевдонимы: traffic-shaper

string

Средство управления полосой пропускания для трафика, пересылаемого политикой межсетевого экрана.

traffic_shaper_reverse

псевдонимы: traffic-shaper-reverse

string

Средство управления полосой пропускания для ответного трафика, получаемого политикой межсетевого экрана.

traffic_type

псевдонимы: traffic-type

string

Тип трафика.

Варианты:

  • "forwarding"
  • "local-in"
  • "local-out"

url_category

псевдонимы: url-category

any

(список или строка) Идентификаторы одной или нескольких категорий веб-фильтрации FortiGuard, для которых этот формировщик применяет формирование трафика.

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, для которых будут переопределены условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

string / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global или другой ADOM, включая 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
  hosts: fortimanagers
  gather_facts: false
  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

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_pkg_firewall_shapingpolicy_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API