Модуль fortinet.fortios.fortios_gtp_apn_shaper — глобальный шейпер для каждого APN в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_gtp_apn_shaper.

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
gtp_apn_shaper dictionary	Глобальный шейпер для каждого APN.
action string	Действие. Варианты: `"drop"` `"reject"`
apn list / элементы=dictionary	Имена APN для сопоставления. Оставьте пустым, чтобы сопоставить с ЛЮБЫМ. Источник: gtp.apn.name.
name string / обязательный	Имя APN. Источники: gtp.apn.name, gtp.apngrp.name.
back_off_time integer	Время ожидания в секундах (10–360).
id integer / обязательный	Идентификатор шейпера. См. <a href=’#notes’>Примечания</a>.
rate_limit integer	Ограничение скорости в пакетах/с (0–1000000; 0 означает отсутствие ограничений).
member_path string	Путь к атрибуту элемента, для которого выполняется операция. Если атрибутов несколько, разделяйте их символом косой черты. Параметр с указанием member_path можно использовать для выполнения операции с элементом.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state string / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Настоятельно рекомендуем использовать собственное значение в качестве id вместо 0. Значение «0» — это специальный заполнитель, позволяющий серверной части назначить объекту последний доступный номер, однако у него есть ограничения. Подробнее см. в разделе «Вопросы и ответы».
Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков рекомендуется использовать httpapi.
Модуль поддерживает check_mode.

Примеры

- name: Global per-APN shaper.
  fortinet.fortios.fortios_gtp_apn_shaper:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      gtp_apn_shaper:
          action: "drop"
          apn:
              -
                  name: "default_name_5 (source gtp.apn.name gtp.apngrp.name)"
          back_off_time: "0"
          id: "7"
          rate_limit: "0"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи данных в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate после выполнения последней операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (id), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Ссылки на коллекцию

© 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/fortios/fortios_gtp_apn_shaper_module.html