fortinet.fortimanager.fmgr_firewall_gtp_perapnshaper – Формировщик поделяний APN.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач, укажите: fortinet.fortimanager.fmgr_firewall_gtp_perapnshaper.
Новый в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое |
| устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| firewall_gtp_perapnshaper словарь | установленные параметры верхнего уровня | ||
| apn строка | Имя APN. | ||
| id целое число | Идентификатор. | ||
| rate-limit целое число | Предел скорости (пакетов/с) для запроса создания контекста PDP. | ||
| version целое число | Номер версии GTP: 0 или 1. | ||
| gtp строка / обязательный | параметр (gtp) в запрошенном URL | ||
| rc_failed список / элементы=строка | список кодов rc, при которых будут нарушены условия для завершения с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых будут переопределены условия для успешного завершения | ||
| state строка / обязательный |
| директива для создания, обновления или удаления объекта | |
| workspace_locking_adom строка | adom для блокировки FortiManager, работающего в режиме рабочей области, значение может быть global и другими, включая root | ||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочей области | |
Примечания
Примечание
- Работа в режиме блокировки рабочей области поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно, выполнение одного модуля может завершиться неудачей при возвращении ненулевого rc. Вы также можете переопределить условия для завершения с ошибкой или успешно с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Per APN shaper.
fmgr_firewall_gtp_perapnshaper:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
gtp: <your own value>
state: <value in [present, absent]>
firewall_gtp_perapnshaper:
apn: <value of string>
id: <value of integer>
rate-limit: <value of integer>
version: <value of integer>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрошенный URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_firewall_gtp_perapnshaper_module.html
