Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_firewall_gtp_policyv2 — применение действия разрешения или запрета к каждому пакету GTPv2-c.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager: модуль продолжит работу без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

firewall_gtp_policyv2

dictionary

Набор параметров верхнего уровня.

action

string

Действие.

Варианты:

  • "deny"
  • "allow"

apn_sel_mode

псевдонимы: apn-sel-mode

list / элементы=string

Режим выбора APN.

Варианты:

  • "ms"
  • "net"
  • "vrf"

apnmember

any

(список или строка) Элемент APN.

id

integer / обязательный

Идентификатор.

imsi_prefix

псевдонимы: imsi-prefix

string

Префикс IMSI.

max_apn_restriction

псевдонимы: max-apn-restriction

string

Максимальное значение ограничения APN.

Варианты:

  • "all"
  • "public-1"
  • "public-2"
  • "private-1"
  • "private-2"

mei

string

Шаблон MEI.

messages

list / элементы=string

Сообщения GTP.

Варианты:

  • "create-ses-req"
  • "create-ses-res"
  • "modify-bearer-req"
  • "modify-bearer-res"

msisdn_prefix

псевдонимы: msisdn-prefix

string

Префикс MSISDN.

rat_type

псевдонимы: rat-type

list / элементы=string

Тип RAT.

Варианты:

  • "any"
  • "utran"
  • "geran"
  • "wlan"
  • "gan"
  • "hspa"
  • "eutran"
  • "virtual"
  • "nbiot"
  • "ltem"
  • "nr"

uli

any

(список) Шаблоны ULI для GTPv2

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

gtp

string / обязательный

Параметр (gtp) в запрошенном URL.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / элементы=integer

Список кодов rc, переопределяющий условия возникновения ошибки.

rc_succeeded

list / элементы=integer

Список кодов rc, переопределяющий условия успешного выполнения.

revision_note

string

Примечание об изменении, указываемое при создании или обновлении объекта.

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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Apply allow or deny action to each GTPv2-c packet.
      fortinet.fortimanager.fmgr_firewall_gtp_policyv2:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        gtp: <your own value>
        state: present # <value in [present, absent]>
        firewall_gtp_policyv2:
          id: 0 # Required variable, integer
          # action: <value in [deny, allow]>
          # apn_sel_mode: ["ms", "net", "vrf"]
          # apnmember: <list or string>
          # imsi_prefix: <string>
          # max_apn_restriction: <value in [all, public-1, public-2, ...]>
          # mei: <string>
          # messages: ["create-ses-req", "create-ses-res", "modify-bearer-req",
          #            "modify-bearer-res"]
          # msisdn_prefix: <string>
          # rat_type: ["any", "utran", "geran", "wlan", "gan", "hspa", "eutran", "virtual",
          #            "nbiot", "ltem", "nr"]
          # uli: <list or string>

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

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

Ключ

Описание

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_gtp_policyv2_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API