Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_pkg_firewall_responseshapingpolicy – политика формирования ответного трафика межсетевого экрана пакета политик

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.12.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_responseshapingpolicy

dictionary

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

class_id

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

integer

Идентификатор класса.

class_id_reverse

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

integer

Обратный идентификатор класса.

comment

string

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

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

list / элементы=string

Адрес назначения.

dstaddr6

list / элементы=string

Адрес назначения IPv6.

id

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

Идентификатор.

ip_version

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

string

Версия IP.

Варианты:

  • "6"
  • "4"

matched_shaping_policies

псевдонимы: matched-shaping-policies

list / элементы=string

Совпавшие политики формирования трафика.

name

string

Имя.

per_ip_shaper

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

list / элементы=string

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

schedule

list / элементы=string

Расписание.

srcaddr

list / элементы=string

Адрес источника.

status

string

Состояние.

Варианты:

  • "disable"
  • "enable"

traffic_shaper

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

list / элементы=string

Формирователь трафика.

traffic_shaper_reverse

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

list / элементы=string

Обратный формирователь трафика.

uuid

string

UUID.

proposed_method

string

Переопределяемый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / элементы=integer

Список кодов rc, для которых условия сбоя будут переопределены.

rc_succeeded

list / элементы=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: Policy package firewall response shaping policy
      fortinet.fortimanager.fmgr_pkg_firewall_responseshapingpolicy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_firewall_responseshapingpolicy:
          id: 0 # Required variable, integer
          # class_id: <integer>
          # class_id_reverse: <integer>
          # comment: <string>
          # dstaddr: <list or string>
          # dstaddr6: <list or string>
          # ip_version: <value in [6, 4]>
          # name: <string>
          # per_ip_shaper: <list or string>
          # schedule: <list or string>
          # srcaddr: <list or string>
          # status: <value in [disable, enable]>
          # traffic_shaper: <list or string>
          # traffic_shaper_reverse: <list or string>
          # uuid: <string>
          # diffserv_forward: <value in [disable, enable]>
          # diffserv_reverse: <value in [disable, enable]>
          # diffservcode_forward: <string>
          # diffservcode_rev: <string>
          # matched_shaping_policies: <list or string>

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / элементы=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / элементы=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_responseshapingpolicy_module.html

Spec-Zone.ru

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