Spec-Zone.ru › Ansible 2.9

fortios_firewall_shaping_profile – Настройка профилей формирования трафика в Fortinet FortiOS и FortiGate

Новая версия с 2.8.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

  • Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять параметры категорий функций брандмауэра и shaping_profile. Примеры включают все параметры и значения, которые нужно скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.5

Требования

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

  • fortiosapi>=0.9.8

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
firewall_shaping_profile
словарь
Значение по умолчанию:
null
Настройка профилей формирования трафика.
comment
строка
Комментарий.
default_class_id
целое число
Идентификатор по умолчанию для обработки пакетов без классификации (включая весь локальный трафик).
profile_name
строка
Имя профиля формирования трафика.
shaping_entries
список
Определение записей формирования трафика для этого профиля.
class_id
целое число
Идентификатор класса.
guaranteed_bandwidth_percentage
целое число
Гарантированная пропускная способность в процентах.
id
целое число / обязательно
Идентификационный номер.
maximum_bandwidth_percentage
целое число
Максимальная пропускная способность в процентах.
priority
строка
    Варианты:
  • высокий
  • средний
  • низкий
Приоритет.
state
строка
    Варианты:
  • present
  • absent
Устарело
Начиная с Ansible 2.9, рекомендуется использовать параметр 'state' на верхнем уровне.
Указывает, нужно ли создать или удалить объект.
host
строка
IP-адрес FortiOS или FortiGate.
https
логическое значение
    Варианты:
  • нет
  • да ←
Указывает, следует ли использовать протокол HTTPS для запросов к FortiGate.
password
строка
Значение по умолчанию:
""
Пароль FortiOS или FortiGate.
ssl_verify
логическое значение
добавлено в 2.9
    Варианты:
  • нет
  • да ←
Обеспечивает проверку сертификата FortiGate надёжным центром сертификации.
state
строка
добавлено в 2.9
    Варианты:
  • present
  • absent
Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущих версиях на более глубоком уровне. Он был перемещён на внешний уровень.
username
строка
Имя пользователя FortiOS или FortiGate.
vdom
строка
Значение по умолчанию:
"root"
Виртуальная область, среди тех, которые определены ранее. VDOM — это виртуальный экземпляр FortiGate, который может быть настроен и использован как отдельное устройство.

Примечания

Примечание

  • Требуется библиотека fortiosapi, разработанная Fortinet
  • Выполнять как local_action в вашем playbook

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure shaping profiles.
    fortios_firewall_shaping_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      firewall_shaping_profile:
        comment: "Comment."
        default_class_id: "4"
        profile_name: "<your_own_value>"
        shaping_entries:
         -
            class_id: "7"
            guaranteed_bandwidth_percentage: "8"
            id:  "9"
            maximum_bandwidth_percentage: "10"
            priority: "high"

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

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

Ключ Возвращённое значение Описание
build
строка
всегда
Номер сборки изображения fortigate

Пример:
1547
http_method
строка
всегда
Последний метод, используемый для предоставления содержимого в FortiGate

Пример:
PUT
http_status
строка
всегда
Последний результат, предоставленный FortiGate при последней операции

Пример:
200
mkey
строка
успех
Главный ключ (id), использованный в последнем вызове FortiGate

Пример:
id
name
строка
всегда
Имя таблицы, использованной для выполнения запроса

Пример:
urlfilter
path
строка
всегда
Путь таблицы, использованной для выполнения запроса

Пример:
webfilter
revision
строка
всегда
Внутренний номер версии

Пример:
17.0.2.10658
serial
строка
всегда
Серийный номер устройства

Пример:
FGVMEVYYQT3AB5352
status
строка
всегда
Указание результата операции

Пример:
успех
vdom
строка
всегда
Использованная виртуальная область

Пример:
root
version
строка
всегда
Версия FortiGate

Пример:
v5.6.3


Статус

  • Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Данный модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_firewall_shaping_profile_module.html

Spec-Zone.ru

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