модуль fortinet.fortimanager.fmgr_firewall_pfcp — настройка PFCP.

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_pfcp dictionary	Набор параметров верхнего уровня.
denied_log псевдонимы: denied-log string	Включить или отключить регистрацию запрещённых пакетов PFCP. Варианты: `"disable"` `"enable"`
forwarded_log псевдонимы: forwarded-log string	Включить или отключить регистрацию перенаправленных пакетов PFCP. Варианты: `"disable"` `"enable"`
invalid_reserved_field псевдонимы: invalid-reserved-field string	Разрешить или запретить некорректное зарезервированное поле в заголовках пакетов PFCP. Варианты: `"deny"` `"allow"`
log_freq псевдонимы: log-freq integer	Частота регистрации пакетов PFCP.
max_message_length псевдонимы: max-message-length integer	Максимальная длина сообщения.
message_filter псевдонимы: message-filter list / элементы=string	Фильтр сообщений PFCP.
min_message_length псевдонимы: min-message-length integer	Минимальная длина сообщения.
monitor_mode псевдонимы: monitor-mode string	Режим мониторинга PFCP. Варианты: `"disable"` `"enable"` `"vdom"`
name string / обязательный	Имя профиля PFCP.
pfcp_timeout псевдонимы: pfcp-timeout integer	Задать время ожидания PFCP.
traffic_count_log псевдонимы: traffic-count-log string	Включить или отключить регистрацию счётчика трафика сеанса. Варианты: `"disable"` `"enable"`
unknown_version псевдонимы: unknown-version string	Разрешить или запретить пакеты неизвестной версии. Варианты: `"deny"` `"allow"`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
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: Configure PFCP.
      fortinet.fortimanager.fmgr_firewall_pfcp:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        firewall_pfcp:
          name: "your value" # Required variable, string
          # denied_log: <value in [disable, enable]>
          # forwarded_log: <value in [disable, enable]>
          # invalid_reserved_field: <value in [deny, allow]>
          # log_freq: <integer>
          # max_message_length: <integer>
          # message_filter: <list or string>
          # min_message_length: <integer>
          # monitor_mode: <value in [disable, enable, vdom]>
          # pfcp_timeout: <integer>
          # traffic_count_log: <value in [disable, enable]>
          # unknown_version: <value in [deny, allow]>

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

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

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