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

Примечание

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

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

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

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

Новая функция в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/отключить логирование для задачи. Варианты: `false` ← (default) `true`
firewall_shapingprofile dictionary	Набор параметров верхнего уровня.
comment string	Комментарий.
default-class-id any	(int или str) Устарело, переименуйте в default_class_id. Идентификатор класса по умолчанию для обработки неклассифицированных пакетов
npu-offloading string	Устарело, переименуйте в npu_offloading. Включить/отключить разгрузку NPU. Варианты: `"disable"` `"enable"`
profile-name string / required	Устарело, переименуйте в profile_name. Имя профиля формирования.
shaping-entries list / elements=dictionary	Устарело, переименуйте в shaping_entries. Записи формирования.
burst-in-msec integer	Устарело, переименуйте в burst_in_msec. Количество байтов, которые могут быть переданы с максимальной скоростью.
cburst-in-msec integer	Устарело, переименуйте в cburst_in_msec. Количество байтов, которые могут быть переданы так же быстро, как интерфейс может…
class-id any	(int или str) Устарело, переименуйте в class_id. Идентификатор класса.
guaranteed-bandwidth-percentage integer	Устарело, переименуйте в guaranteed_bandwidth_percentage. Гарантированная пропускная способность в процентах.
id integer	Идентификационный номер.
limit integer	Жёсткий лимит на реальный размер очереди в пакетах.
max integer	Средний размер очереди в пакетах, при котором вероятность отбрасывания RED максимальна.
maximum-bandwidth-percentage integer	Устарело, переименуйте в maximum_bandwidth_percentage. Максимальная пропускная способность в процентах.
min integer	Средний размер очереди в пакетах, при котором становится возможным отбрасывание RED.
priority string	Приоритет. Варианты: `"low"` `"medium"` `"high"` `"critical"` `"top"`
red-probability integer	Устарело, переименуйте в red_probability. Максимальная вероятность

тип строка	Выбор типа профиля формирования трафика Выбор: `"policing"` `"queuing"`
forticloud_access_token строка	Авторизация клиента Ansible с помощью маркера доступа к API forticloud.
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Выбор: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены на ошибку.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут переопределены на успешное завершение.
состояние строка / обязательно	Директива для создания, обновления или удаления объекта. Выбор: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: `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 profiles.
      fortinet.fortimanager.fmgr_firewall_shapingprofile:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_shapingprofile:
          comment: "ansible-comment"
          profile-name: "ansible-test"

- 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 profiles
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_shapingprofile"
          params:
            adom: "ansible"
            shaping-profile: "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_firewall_shapingprofile_module.html