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

Примечание

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

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

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

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

Добавлено в 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`
firewall_shapingprofile_shapingentries dictionary	Набор параметров верхнего уровня.
burst_in_msec псевдонимы: burst-in-msec integer	Количество байтов, которые можно передать всплеском с максимальной пропускной способностью.
cburst_in_msec псевдонимы: cburst-in-msec integer	Количество байтов, которые можно передать всплеском с максимально возможной для интерфейса скоростью.
class_id псевдонимы: class-id any	(int или str) Идентификатор класса.
guaranteed_bandwidth_percentage псевдонимы: guaranteed-bandwidth-percentage integer	Гарантированная пропускная способность в процентах.
id integer / обязательный	Номер идентификатора.
limit integer	Жесткий предел фактического размера очереди в пакетах.
max integer	Средний размер очереди в пакетах, при котором вероятность отбрасывания RED достигает максимума.
maximum_bandwidth_percentage псевдонимы: maximum-bandwidth-percentage integer	Максимальная пропускная способность в процентах.
min integer	Средний размер очереди в пакетах, при котором становится возможным отбрасывание RED.
priority string	Приоритет. Варианты: `"low"` `"medium"` `"high"` `"critical"` `"top"`
red_probability псевдонимы: red-probability integer	Максимальная вероятность
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, для которых переопределяются условия ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, для которых переопределяются условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
shaping-profile string	Устаревший параметр, используйте “shaping_profile”
shaping_profile string	Параметр (shaping-profile) в запрошенном URL.
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
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Define shaping entries of this shaping profile.
      fortinet.fortimanager.fmgr_firewall_shapingprofile_shapingentries:
        bypass_validation: false
        adom: ansible
        shaping_profile: "ansible-test" # profile-name
        state: present
        firewall_shapingprofile_shapingentries:
          guaranteed_bandwidth_percentage: 50
          id: 1
          maximum_bandwidth_percentage: 70
          priority: medium # <value in [low, medium, high]>

- 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 entries of this shaping profile
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_shapingprofile_shapingentries"
          params:
            adom: "ansible"
            shaping_profile: "ansible-test" # profile-name
            shaping_entries: "your_value"

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

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

Ключ	Описание
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_firewall_shapingprofile_shapingentries_module.html