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

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.1.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_gtp_policyv2 словарь	Установленные параметры верхнего уровня.
action строка	Действие. Варианты: `"deny"` `"allow"`
apn_sel_mode список / элементы=строка	Устарело, пожалуйста, переименуйте его в apn_sel_mode. Режим выбора APN. Варианты: `"ms"` `"net"` `"vrf"`
apnmember любой	(список или строка) Член APN.
id целое число / обязательно	ID.
imsi_prefix строка	Устарело, пожалуйста, переименуйте его в imsi_prefix. Префикс IMSI.
max_apn_restriction строка	Устарело, пожалуйста, переименуйте его в max_apn_restriction. Максимальное ограничение APN. Варианты: `"all"` `"public-1"` `"public-2"` `"private-1"` `"private-2"`
mei строка	Шаблон MEI.
messages список / элементы=строка	Сообщения GTP. Варианты: `"create-ses-req"` `"create-ses-res"` `"modify-bearer-req"` `"modify-bearer-res"`
msisdn_prefix строка	Устарело, пожалуйста, переименуйте его в msisdn_prefix. Префикс MSISDN.
rat_type список / элементы=строка	Устарело, пожалуйста, переименуйте его в rat_type. Тип RAT. Варианты: `"any"` `"utran"` `"geran"` `"wlan"` `"gan"` `"hspa"` `"eutran"` `"virtual"` `"nbiot"` `"ltem"` `"nr"`
uli любой	(список) Шаблоны GTPv2 ULI
forticloud_access_token строка	Авторизация Ansible-клиента с токеном доступа к forticloud API.
gtp строка / обязательно	Параметр (gtp) в запрошенном URL.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия отказа будут переопределены.

END_OF_DOCUMENT_MARKER

rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия успешного выполнения.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая root.
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 помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код 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: Apply allow or deny action to each GTPv2-c packet.
      fortinet.fortimanager.fmgr_firewall_gtp_policyv2:
        # 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: present # <value in [present, absent]>
        firewall_gtp_policyv2:
          action: <value in [deny, allow]>
          apn_sel_mode:
            - ms
            - net
            - vrf
          apnmember: <list or string>
          id: <integer>
          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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_policyv2_module.html