fortinet.fortimanager.fmgr_firewall_gtp_policy модуль — Политика.

Примечание

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

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

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

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

Новое в fortinet.fortimanager 2.0.0

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

Обзор

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_gtp_policy словарь	Параметры верхнего уровня, установленные.
action строка	Действие. Варианты: `"allow"` `"deny"`
apn строка	Суффикс APN.
apn-sel-mode список / элементы=строка	Устарело, пожалуйста, переименуйте его в apn_sel_mode. Режим выбора APN. Варианты: `"ms"` `"net"` `"vrf"`
apnmember любой	(список или строка) Член APN.
id целое число / обязательно	Идентификатор.
imei строка	IMEI
imsi строка	Префикс IMSI.
imsi-prefix строка	Устарело, пожалуйста, переименуйте его в imsi_prefix. Префикс IMSI.
max-apn-restriction строка	Устарело, пожалуйста, переименуйте его в max_apn_restriction. Максимальное ограничение APN. Варианты: `"all"` `"public-1"` `"public-2"` `"private-1"` `"private-2"`
messages список / элементы=строка	Сообщения GTP. Варианты: `"create-req"` `"create-res"` `"update-req"` `"update-res"`
msisdn строка	Префикс MSISDN.
msisdn-prefix строка	Устарело, пожалуйста, переименуйте его в msisdn_prefix. Префикс MSISDN.
rai строка	Шаблон RAI.
rat-type список / элементы=строка	Устарело, пожалуйста, переименуйте его в rat_type. Тип RAT. Варианты: `"any"` `"utran"` `"geran"` `"wlan"` `"gan"` `"hspa"` `"eutran"` `"virtual"` `"nbiot"`
uli строка	Шаблон ULI.
forticloud_access_token строка	Авторизовать Ansible-клиента с помощью токена доступа к API forticloud.
gtp строка / обязательно	Параметр (gtp) в запрошенном URL.

END_OF_DOCUMENT_MARKER

proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, при которых условия будут нарушены.
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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Policy.
      fortinet.fortimanager.fmgr_firewall_gtp_policy:
        bypass_validation: false
        adom: FortiCarrier # This is FOC-only object, need a FortiCarrier adom
        gtp: "ansible-test" # name
        state: present
        firewall_gtp_policy:
          action: allow # <value in [allow, deny]>
          apn-sel-mode:
            - ms
            - net
            - vrf
          id: 1
          max-apn-restriction: public-1 # <value in [all, public-1, public-2, ...]>
          messages:
            - create-req
            - create-res
            - update-req
            - update-res
          rat-type:
            - any
            - utran
            - geran
            - wlan
            - gan
            - hspa
            - eutran
            - virtual
            - nbiot

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the policies in the GTP
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_gtp_policy"
          params:
            adom: "FortiCarrier" # This is FOC-only object, need a FortiCarrier adom
            gtp: "ansible-test" # name
            policy: "your_value"

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

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

Ключ	Описание
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_policy_module.html