Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

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_header_shapingpolicy

dictionary

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

app_category

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

any

(list or str) Категория приложения.

app_group

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

any

(list or str) Группа приложений.

application

any

(list) Приложение.

class_id

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

any

(int or str) Идентификатор класса.

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.

Варианты:

  • "disable"
  • "enable"

diffserv_reverse

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

string

Обратная обработка Diffserv.

Варианты:

  • "disable"
  • "enable"

diffservcode_forward

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

string

Код Diffserv для пересылки.

diffservcode_rev

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

string

Обратный код Diffserv.

dstaddr

any

(list or str) Адрес назначения.

dstaddr6

any

(list or str) Адрес назначения IPv6.

dstintf

any

(list or str) Интерфейс назначения.

groups

any

(list or str) Группы.

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

(list or str) Пользовательский интернет-сервис.

internet_service_custom_group

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

any

(list or str) Группа пользовательских интернет-сервисов.

internet_service_fortiguard

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

any

(list) Название интернет-сервиса FortiGuard.

internet_service_group

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

any

(list or str) Группа интернет-сервисов.

internet_service_id

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

any

(list or str) Идентификатор интернет-сервиса.

internet_service_name

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

any

(list or str) Название интернет-сервиса.

internet_service_src

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

string

Источник интернет-сервиса.

Варианты:

  • "disable"
  • "enable"

internet_service_src_custom

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

any

(list or str) Пользовательский источник интернет-сервиса.

internet_service_src_custom_group

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

any

(list or str) Группа пользовательских источников интернет-сервиса.

internet_service_src_fortiguard

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

any

(list) Название источника интернет-сервиса FortiGuard.

internet_service_src_group

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

any

(list or str) Группа источников интернет-сервиса.

internet_service_src_id

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

any

(list or str) Идентификатор источника интернет-сервиса.

internet_service_src_name

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

any

(list or str) Название источника интернет-сервиса.

ip_version

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

string

Версия IP.

Варианты:

  • "4"
  • "6"

per_ip_shaper

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

string

Формирователь трафика для каждого IP-адреса.

schedule

string

Расписание.

service

any

(list or str) Служба.

service_type

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

string

Тип службы.

Варианты:

  • "service"
  • "internet-service"

srcaddr

any

(list or str) Адрес источника.

srcaddr6

any

(list or str) Адрес источника IPv6.

srcintf

any

(list or str) Интерфейс источника.

status

string

Статус.

Варианты:

  • "disable"
  • "enable"

tos

string

ToS.

tos_mask

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

string

Маска ToS.

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

(list or str) Категория URL.

users

any

(list or str) Пользователи.

uuid

string

UUID.

uuid_idx

псевдонимы: uuid-idx

integer

Индекс UUID.

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 и другие варианты, включая 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure shaping policies.
      fortinet.fortimanager.fmgr_pkg_header_shapingpolicy:
        # workspace_locking_adom: <global or your adom name>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_header_shapingpolicy:
          id: 0 # Required variable, integer
          # app_category: <list or string>
          # app_group: <list or string>
          # application: <list or integer>
          # class_id: <integer or string>
          # comment: <string>
          # diffserv_forward: <value in [disable, enable]>
          # diffserv_reverse: <value in [disable, enable]>
          # diffservcode_forward: <string>
          # diffservcode_rev: <string>
          # dstaddr: <list or string>
          # dstaddr6: <list or string>
          # dstintf: <list or string>
          # groups: <list or string>
          # internet_service: <value in [disable, enable]>
          # internet_service_custom: <list or string>
          # internet_service_custom_group: <list or string>
          # internet_service_group: <list or string>
          # internet_service_id: <list or string>
          # internet_service_src: <value in [disable, enable]>
          # internet_service_src_custom: <list or string>
          # internet_service_src_custom_group: <list or string>
          # internet_service_src_group: <list or string>
          # internet_service_src_id: <list or string>
          # ip_version: <value in [4, 6]>
          # per_ip_shaper: <string>
          # schedule: <string>
          # service: <list or string>
          # srcaddr: <list or string>
          # srcaddr6: <list or string>
          # srcintf: <list or string>
          # status: <value in [disable, enable]>
          # tos: <string>
          # tos_mask: <string>
          # tos_negate: <value in [disable, enable]>
          # traffic_shaper: <string>
          # traffic_shaper_reverse: <string>
          # url_category: <list or string>
          # users: <list or string>
          # uuid: <string>
          # internet_service_name: <list or string>
          # internet_service_src_name: <list or string>
          # class_id_reverse: <integer>
          # service_type: <value in [service, internet-service]>
          # uuid_idx: <integer>
          # cos: <string>
          # cos_mask: <string>
          # traffic_type: <value in [forwarding, local-in, local-out]>
          # http_response_match: <value in [disable, enable]>
          # internet_service_fortiguard: <list or string>
          # internet_service_src_fortiguard: <list or string>

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

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

Ключ

Описание

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

Предупреждение о том, что параметры, используемые в playbook, не поддерживаются текущей версией 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_header_shapingpolicy_module.html

Spec-Zone.ru

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