Модуль fortinet.fortimanager.fmgr_firewall_gtp_messageratelimitv0 – Ограничение скорости сообщений для GTP версии 0.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в True только при несовпадении схемы модуля со структурой API FortiManager. Модуль продолжает выполняться без проверки параметров. Возможные значения: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Возможные значения: `false` ← (по умолчанию) `true`
firewall_gtp_messageratelimitv0 словарь	Настройка параметров верхнего уровня.
create_pdp_request целое число	Ограничение скорости.
delete_pdp_request целое число	Ограничение скорости.
echo_request целое число	Ограничение скорости.
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
gtp строка / обязательно	Параметр (gtp) в запрошенном URL.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Возможные значения: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых выполнение будет прекращено.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых выполнение будет завершено успешно.
workspace_locking_adom строка	Область, которую следует заблокировать для FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая корневой.
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 помогают в этом.
Обычно, выполнение модуля может завершиться ошибкой, если возвращён код rc отличным от нуля. Вы также можете переопределить условия завершения с ошибкой или успешно с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Message rate limiting for GTP version 0.
      fortinet.fortimanager.fmgr_firewall_gtp_messageratelimitv0:
        # 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_messageratelimitv0:
          create_pdp_request: <integer>
          delete_pdp_request: <integer>
          echo_request: <integer>

Значения возврата

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

Ключ	Описание
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 список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_gtp_messageratelimitv0_module.html