fortinet.fortimanager.fmgr_firewall_gtp_messageratelimit – Ограничение скорости сообщений.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_gtp_messageratelimit.

Новое в версии 2.10: of fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation логическое		Варианты: нет ← да	устанавливается в True только при различиях в схеме модуля и структуре API FortiManager, модуль продолжает выполнение без проверки параметров
firewall_gtp_messageratelimit словарь			устанавливаются параметры верхнего уровня
	create-aa-pdp-request целое число		Предел скорости для запроса создания контекста AA PDP (пакеты в секунду).
	create-aa-pdp-response целое число		Предел скорости для ответа на запрос создания контекста AA PDP (пакеты в секунду).
	create-mbms-request целое число		Предел скорости для запроса создания контекста MBMS (пакеты в секунду).
	create-mbms-response целое число		Предел скорости для ответа на запрос создания контекста MBMS (пакеты в секунду).
	create-pdp-request целое число		Предел скорости для запроса создания контекста PDP (пакеты в секунду).
	create-pdp-response целое число		Предел скорости для ответа на запрос создания контекста PDP (пакеты в секунду).
	delete-aa-pdp-request целое число		Предел скорости для запроса удаления контекста AA PDP (пакеты в секунду).
	delete-aa-pdp-response целое число		Предел скорости для ответа на запрос удаления контекста AA PDP (пакеты в секунду).
	delete-mbms-request целое число		Предел скорости для запроса удаления контекста MBMS (пакеты в секунду).
	delete-mbms-response целое число		Предел скорости для ответа на запрос удаления контекста MBMS (пакеты в секунду).
	delete-pdp-request целое число		Предел скорости для запроса удаления контекста PDP (пакеты в секунду).
	delete-pdp-response целое число		Предел скорости для ответа на запрос удаления контекста PDP (пакеты в секунду).
	echo-reponse целое число		Предел скорости для ответа эхо (пакеты в секунду).
	echo-request целое число		Предел скорости для запросов эхо (пакеты в секунду).
	error-indication целое число		Предел скорости для указания ошибки (пакеты в секунду).
	failure-report-request целое число		Предел скорости для запроса отчета об ошибке (пакеты в секунду).
	failure-report-response целое число		Предел скорости для ответа на запрос отчета об ошибке (пакеты в секунду).
	fwd-reloc-complete-ack целое число		Предел скорости для подтверждения завершения перенаправления (пакеты в секунду).
	fwd-relocation-complete целое число		Предел скорости для завершения перенаправления (пакеты в секунду).
	fwd-relocation-request целое число		Предел скорости для запроса перенаправления (пакеты в секунду).
	fwd-relocation-response целое число		Предел скорости для ответа на запрос перенаправления (пакеты в секунду).
	fwd-srns-context целое число		Предел скорости для контекста SRNS перенаправления (пакеты в секунду).
	fwd-srns-context-ack целое число		Предел скорости для подтверждения контекста SRNS перенаправления (пакеты в секунду).
	g-pdu целое число		Предел скорости для G-PDU (пакеты в секунду).
	identification-request целое число		Предел скорости для запроса идентификации (пакеты в секунду).
	identification-response целое число		Предел скорости для ответа на запрос идентификации (пакеты в секунду).
	mbms-de-reg-request целое число		Предел скорости для запроса отмены регистрации MBMS (пакеты в секунду).
	mbms-de-reg-response целое число		Предел скорости для ответа на запрос отмены регистрации MBMS (пакеты в секунду).
	mbms-notify-rej-request целое число		Предел скорости для запроса отклонения уведомления MBMS (пакеты в секунду).
	mbms-notify-rej-response целое число		Предел скорости для ответа на запрос отклонения уведомления MBMS (пакеты в секунду).
	mbms-notify-request целое число		Предел скорости для запроса уведомления MBMS (пакеты в секунду).
	mbms-notify-response целое число		Предел скорости для ответа на запрос уведомления MBMS (пакеты в секунду).
	mbms-reg-request целое число		Предел скорости для запроса регистрации MBMS (пакеты в секунду).
	mbms-reg-response целое число		Предел скорости для ответа на запрос регистрации MBMS (пакеты в секунду).
	mbms-ses-start-request целое число		Предел скорости для запроса начала сессии MBMS (пакеты в секунду).
	mbms-ses-start-response целое число		Предел скорости для ответа на запрос начала сессии MBMS (пакеты в секунду).
	mbms-ses-stop-request целое число		Предел скорости для запроса остановки сессии MBMS (пакеты в секунду).
	mbms-ses-stop-response целое число		Предел скорости для ответа на запрос остановки сессии MBMS (пакеты в секунду).
	note-ms-request целое число		Предел скорости для запроса о наличии MS GPRS (пакеты в секунду).
	note-ms-response целое число		Предел скорости для ответа о наличии MS GPRS (пакеты в секунду).
	pdu-notify-rej-request целое число		Предел скорости для запроса отклонения уведомления PDU (пакеты в секунду).
	pdu-notify-rej-response целое число		Предел скорости для ответа на запрос отклонения уведомления PDU (пакеты в секунду).
	pdu-notify-request целое число		Предел скорости для запроса уведомления PDU (пакеты в секунду).
	pdu-notify-response целое число		Предел скорости для ответа на запрос уведомления PDU (пакеты в секунду).
	ran-info целое число		Предел скорости для передачи информации RAN (пакеты в секунду).
	relocation-cancel-request целое число		Предел скорости для запроса отмены перенаправления (пакеты в секунду).
	relocation-cancel-response целое число		Предел скорости для ответа на запрос отмены перенаправления (пакеты в секунду).
	send-route-request целое число		Предел скорости для запроса отправки маршрутной информации для GPRS (пакеты в секунду).

	send-route-response integer		Предельная скорость отправки маршрутной информации для ответа GPRS (пакетов в секунду).
	sgsn-context-ack integer		Предельная скорость подтверждения контекста SGSN (пакетов в секунду).
	sgsn-context-request integer		Предельная скорость запроса контекста SGSN (пакетов в секунду).
	sgsn-context-response integer		Предельная скорость ответа на запрос контекста SGSN (пакетов в секунду).
	support-ext-hdr-notify integer		Предельная скорость уведомлений о заголовках расширения поддержки (пакетов в секунду).
	update-mbms-request integer		Предельная скорость запроса обновления контекста MBMS (пакетов в секунду).
	update-mbms-response integer		Предельная скорость ответа на запрос обновления контекста MBMS (пакетов в секунду).
	update-pdp-request integer		Предельная скорость запроса обновления контекста PDP (пакетов в секунду).
	update-pdp-response integer		Предельная скорость ответа на запрос обновления контекста PDP (пакетов в секунду).
	version-not-support integer		Предельная скорость для случаев, когда версия не поддерживается (пакетов в секунду).
gtp string / required			параметр (gtp) в запрошенном URL
rc_failed list / elements=string			список кодов rc, при которых условия будут считаться условиями неудачи
rc_succeeded list / elements=string			список кодов rc, при которых условия будут считаться условиями успеха
state string / required		Выбор: present absent	директива для создания, обновления или удаления объекта
workspace_locking_adom string			область (adom), которую нужно заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корневое
workspace_locking_timeout integer		По умолчанию: 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: Message rate limiting.
     fmgr_firewall_gtp_messageratelimit:
        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>
        firewall_gtp_messageratelimit:
           create-aa-pdp-request: <value of integer>
           create-aa-pdp-response: <value of integer>
           create-mbms-request: <value of integer>
           create-mbms-response: <value of integer>
           create-pdp-request: <value of integer>
           create-pdp-response: <value of integer>
           delete-aa-pdp-request: <value of integer>
           delete-aa-pdp-response: <value of integer>
           delete-mbms-request: <value of integer>
           delete-mbms-response: <value of integer>
           delete-pdp-request: <value of integer>
           delete-pdp-response: <value of integer>
           echo-reponse: <value of integer>
           echo-request: <value of integer>
           error-indication: <value of integer>
           failure-report-request: <value of integer>
           failure-report-response: <value of integer>
           fwd-reloc-complete-ack: <value of integer>
           fwd-relocation-complete: <value of integer>
           fwd-relocation-request: <value of integer>
           fwd-relocation-response: <value of integer>
           fwd-srns-context: <value of integer>
           fwd-srns-context-ack: <value of integer>
           g-pdu: <value of integer>
           identification-request: <value of integer>
           identification-response: <value of integer>
           mbms-de-reg-request: <value of integer>
           mbms-de-reg-response: <value of integer>
           mbms-notify-rej-request: <value of integer>
           mbms-notify-rej-response: <value of integer>
           mbms-notify-request: <value of integer>
           mbms-notify-response: <value of integer>
           mbms-reg-request: <value of integer>
           mbms-reg-response: <value of integer>
           mbms-ses-start-request: <value of integer>
           mbms-ses-start-response: <value of integer>
           mbms-ses-stop-request: <value of integer>
           mbms-ses-stop-response: <value of integer>
           note-ms-request: <value of integer>
           note-ms-response: <value of integer>
           pdu-notify-rej-request: <value of integer>
           pdu-notify-rej-response: <value of integer>
           pdu-notify-request: <value of integer>
           pdu-notify-response: <value of integer>
           ran-info: <value of integer>
           relocation-cancel-request: <value of integer>
           relocation-cancel-response: <value of integer>
           send-route-request: <value of integer>
           send-route-response: <value of integer>
           sgsn-context-ack: <value of integer>
           sgsn-context-request: <value of integer>
           sgsn-context-response: <value of integer>
           support-ext-hdr-notify: <value of integer>
           update-mbms-request: <value of integer>
           update-mbms-response: <value of integer>
           update-pdp-request: <value of integer>
           update-pdp-response: <value of integer>
           version-not-support: <value of integer>

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

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

Ключ	Возвращаемое	Описание
request_url string	всегда	Полный запрошенный URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Описание ответа 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_messageratelimit_module.html