Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_pkg_firewall_securitypolicy — настройка политик приложений NGFW IPv4/IPv6.

Примечание

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

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

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

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

Добавлено в 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

forticloud_access_token

string

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

pkg

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

Параметр (pkg) в запрашиваемом URL.

pkg_firewall_securitypolicy

dictionary

Параметры верхнего уровня.

_policy_block

integer

Назначенный блок политик.

action

string

Действие политики

Варианты:

  • "deny"
  • "accept"

app_category

aliases: app-category

any

(список или строка) Список идентификаторов категорий приложений.

app_group

aliases: app-group

any

(список или строка) Имена групп приложений.

application

any

(список) Список идентификаторов приложений.

application_list

aliases: application-list

string

Имя существующего списка приложений.

av_profile

aliases: av-profile

string

Имя существующего антивирусного профиля.

casb_profile

aliases: casb-profile

string

Имя существующего профиля CASB.

cifs_profile

aliases: cifs-profile

string

Имя существующего профиля CIFS.

comments

string

Комментарий.

diameter_filter_profile

aliases: diameter-filter-profile

string

Имя существующего профиля фильтрации Diameter.

dlp_profile

aliases: dlp-profile

string

Имя существующего профиля DLP.

dlp_sensor

aliases: dlp-sensor

string

Имя существующего датчика DLP.

dnsfilter_profile

aliases: dnsfilter-profile

string

Имя существующего профиля фильтрации DNS.

dstaddr

any

(список или строка) Имя IPv4-адреса назначения и имена групп адресов.

dstaddr4

any

(список или строка) Имя IPv4-адреса назначения и имена групп адресов.

dstaddr6

any

(список или строка) Имя IPv6-адреса назначения и имена групп адресов.

dstaddr6_negate

aliases: dstaddr6-negate

string

Если параметр включен, dstaddr6 указывает, каким НЕ должен быть адрес назначения.

Варианты:

  • "disable"
  • "enable"

dstaddr_negate

aliases: dstaddr-negate

string

Если параметр включен, dstaddr/dstaddr6 указывает, каким НЕ должен быть адрес назначения.

Варианты:

  • "disable"
  • "enable"

dstintf

any

(список или строка) Исходящий интерфейс

emailfilter_profile

aliases: emailfilter-profile

string

Имя существующего профиля фильтрации электронной почты.

enforce_default_app_port

aliases: enforce-default-app-port

string

Включить/отключить принудительное использование портов приложений по умолчанию для разрешенных приложений.

Варианты:

  • "disable"
  • "enable"

file_filter_profile

aliases: file-filter-profile

string

Имя существующего профиля фильтрации файлов.

fsso_groups

aliases: fsso-groups

any

(список или строка) Имена групп FSSO.

global_label

aliases: global-label

string

Метка политики, отображаемая в графическом интерфейсе в режиме глобального представления.

groups

any

(список или строка) Имена групп пользователей, которые могут проходить аутентификацию с помощью этой политики.

icap_profile

aliases: icap-profile

string

Имя существующего профиля ICAP.

internet_service

aliases: internet-service

string

Включить/отключить использование интернет-служб для этой политики.

Варианты:

  • "disable"
  • "enable"

internet_service6

aliases: internet-service6

string

Включить/отключить использование интернет-служб IPv6 для этой политики.

Варианты:

  • "disable"
  • "enable"

internet_service6_custom

aliases: internet-service6-custom

any

(список) Имя пользовательской интернет-службы IPv6.

internet_service6_custom_group

aliases: internet-service6-custom-group

any

(список) Имя группы пользовательских интернет-служб IPv6.

internet_service6_fortiguard

aliases: internet-service6-fortiguard

any

(список) Интернет-служба IPv6 FortiGuard.

internet_service6_group

aliases: internet-service6-group

any

(список) Имя группы интернет-служб.

internet_service6_name

aliases: internet-service6-name

any

(список) Имя интернет-службы IPv6.

internet_service6_negate

aliases: internet-service6-negate

string

Если параметр включен, internet-service6 указывает, какой НЕ должна быть служба.

Варианты:

  • "disable"
  • "enable"

internet_service6_src

aliases: internet-service6-src

string

Включить/отключить использование интернет-служб IPv6 в качестве источника для этой политики.

Варианты:

  • "disable"
  • "enable"

internet_service6_src_custom

aliases: internet-service6-src-custom

any

(список) Имя пользовательской интернет-службы IPv6 в качестве источника.

internet_service6_src_custom_group

aliases: internet-service6-src-custom-group

any

(список) Имя группы пользовательских интернет-служб IPv6 в качестве источника.

internet_service6_src_fortiguard

aliases: internet-service6-src-fortiguard

any

(список) Интернет-служба IPv6 FortiGuard в качестве источника.

internet_service6_src_group

aliases: internet-service6-src-group

any

(список) Имя группы интернет-служб IPv6 в качестве источника.

internet_service6_src_name

aliases: internet-service6-src-name

any

(список) Имя интернет-службы IPv6 в качестве источника.

internet_service6_src_negate

aliases: internet-service6-src-negate

string

Если параметр включен, internet-service6-src указывает, какой НЕ должна быть служба.

Варианты:

  • "disable"
  • "enable"

internet_service_custom

aliases: internet-service-custom

any

(список или строка) Имя пользовательской интернет-службы.

internet_service_custom_group

aliases: internet-service-custom-group

any

(список или строка) Имя группы пользовательских интернет-служб.

internet_service_fortiguard

aliases: internet-service-fortiguard

any

(список) Интернет-служба FortiGuard.

internet_service_group

aliases: internet-service-group

any

(list or str) Имя группы интернет-сервисов.

internet_service_id

aliases: internet-service-id

any

(list or str) Идентификатор интернет-сервиса.

internet_service_name

aliases: internet-service-name

any

(list or str) Имя интернет-сервиса.

internet_service_negate

aliases: internet-service-negate

string

Если параметр включён, internet-service указывает, чем сервис НЕ должен быть.

Варианты:

  • "disable"
  • "enable"

internet_service_src

aliases: internet-service-src

string

Включение/отключение использования интернет-сервисов в качестве источника для этой политики.

Варианты:

  • "disable"
  • "enable"

internet_service_src_custom

aliases: internet-service-src-custom

any

(list or str) Имя пользовательского источника интернет-сервиса.

internet_service_src_custom_group

aliases: internet-service-src-custom-group

any

(list or str) Имя пользовательской группы источников интернет-сервисов.

internet_service_src_fortiguard

aliases: internet-service-src-fortiguard

any

(list) Источник интернет-сервиса FortiGuard.

internet_service_src_group

aliases: internet-service-src-group

any

(list or str) Имя группы источников интернет-сервисов.

internet_service_src_id

aliases: internet-service-src-id

any

(list or str) Идентификатор источника интернет-сервиса.

internet_service_src_name

aliases: internet-service-src-name

any

(list or str) Имя источника интернет-сервиса.

internet_service_src_negate

aliases: internet-service-src-negate

string

Если параметр включён, internet-service-src указывает, чем сервис НЕ должен быть.

Варианты:

  • "disable"
  • "enable"

ips_sensor

aliases: ips-sensor

string

Имя существующего датчика IPS.

ips_voip_filter

aliases: ips-voip-filter

string

Имя существующего профиля VoIP

learning_mode

aliases: learning-mode

string

Включите этот режим, чтобы разрешить всё, но регистрировать все значимые данные для сбора информации о безопасности.

Варианты:

  • "disable"
  • "enable"

logtraffic

string

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

Варианты:

  • "disable"
  • "all"
  • "utm"

logtraffic_start

aliases: logtraffic-start

string

Записывать журналы при начале сеанса.

Варианты:

  • "disable"
  • "enable"

mms_profile

aliases: mms-profile

string

Имя существующего профиля MMS.

name

string

Имя политики.

nat46

string

Включение/отключение NAT46.

Варианты:

  • "disable"
  • "enable"

nat64

string

Включение/отключение NAT64.

Варианты:

  • "disable"
  • "enable"

policyid

integer / required

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

profile_group

aliases: profile-group

string

Имя группы профилей.

profile_protocol_options

aliases: profile-protocol-options

string

Имя существующего профиля параметров протокола.

profile_type

aliases: profile-type

string

Определяет, разрешает ли политика брандмауэра группы профилей безопасности или только отдельные профили.

Варианты:

  • "single"
  • "group"

schedule

string

Имя расписания.

sctp_filter_profile

aliases: sctp-filter-profile

string

Имя существующего профиля фильтра SCTP.

send_deny_packet

aliases: send-deny-packet

string

Включите отправку ответа, когда сеанс отклонён или заблокирован политикой брандмауэра.

Варианты:

  • "disable"
  • "enable"

service

any

(list or str) Имена служб и групп служб.

service_negate

aliases: service-negate

string

Если параметр включён, service указывает, чем служба НЕ должна быть.

Варианты:

  • "disable"
  • "enable"

srcaddr

any

(list or str) Имя исходного IPv4-адреса и имена групп адресов.

srcaddr4

any

(list or str) Имя исходного IPv4-адреса и имена групп адресов.

srcaddr6

any

(list or str) Имя исходного IPv6-адреса и имена групп адресов.

srcaddr6_negate

aliases: srcaddr6-negate

string

Если параметр включён, srcaddr6 указывает, каким НЕ должен быть исходный адрес.

Варианты:

  • "disable"
  • "enable"

srcaddr_negate

aliases: srcaddr-negate

string

Если параметр включён, srcaddr/srcaddr6 указывает, каким НЕ должен быть исходный адрес.

Варианты:

  • "disable"
  • "enable"

srcintf

any

(list or str) Входящий интерфейс

ssh_filter_profile

aliases: ssh-filter-profile

string

Имя существующего профиля фильтра SSH.

ssl_ssh_profile

aliases: ssl-ssh-profile

string

Имя существующего профиля SSL SSH.

status

string

Включение или отключение этой политики.

Варианты:

  • "disable"
  • "enable"

telemetry_profile

aliases: telemetry-profile

any

(list) Имя существующего профиля телеметрии.

url_category

aliases: url-category

any

(list or str) Список идентификаторов категорий URL.

users

any

(list or str) Имена отдельных пользователей, которые могут проходить аутентификацию с помощью этой политики.

utm_status

aliases: utm-status

string

Включение профилей безопасности.

Варианты:

  • "disable"
  • "enable"

uuid

string

Универсальный уникальный идентификатор

videofilter_profile

aliases: videofilter-profile

string

Имя существующего профиля VideoFilter.

virtual_patch_profile

aliases: virtual-patch-profile

string

Имя существующего профиля виртуальных исправлений.

voip_profile

aliases: voip-profile

string

Имя существующего профиля VoIP.

webfilter_profile

aliases: webfilter-profile

string

Имя существующего профиля веб-фильтрации.

proposed_method

string

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

Варианты:

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

rc_failed

list / elements=integer

Список кодов rc, для которых будут переопределены условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, для которых будут переопределены условия успешного выполнения.

revision_note

string

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

state

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

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM для блокировки в FortiManager, работающем в режиме workspace. Значением может быть global или другие варианты, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку workspace.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0, все входные аргументы именуются с использованием соглашения об именовании через подчёркивание (snake_case). Замените такие аргументы, как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут появляться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
  • Этот модуль FortiManager поддерживает работу в режиме блокировки workspace; параметры верхнего уровня 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 NGFW IPv4/IPv6 application policies.
      fortinet.fortimanager.fmgr_pkg_firewall_securitypolicy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_firewall_securitypolicy:
          policyid: 0 # Required variable, integer
          # action: <value in [deny, accept]>
          # app_category: <list or string>
          # app_group: <list or string>
          # application: <list or integer>
          # application_list: <string>
          # av_profile: <string>
          # cifs_profile: <string>
          # comments: <string>
          # dlp_sensor: <string>
          # dnsfilter_profile: <string>
          # dstaddr4: <list or string>
          # dstaddr6: <list or string>
          # dstintf: <list or string>
          # emailfilter_profile: <string>
          # enforce_default_app_port: <value in [disable, enable]>
          # groups: <list or string>
          # icap_profile: <string>
          # internet_service: <value in [disable, enable]>
          # internet_service_custom: <list or string>
          # internet_service_custom_group: <list or string>
          # internet_service_group: <list or string>
          # internet_service_id: <list or string>
          # internet_service_negate: <value in [disable, enable]>
          # internet_service_src: <value in [disable, enable]>
          # internet_service_src_custom: <list or string>
          # internet_service_src_custom_group: <list or string>
          # internet_service_src_group: <list or string>
          # internet_service_src_id: <list or string>
          # internet_service_src_negate: <value in [disable, enable]>
          # ips_sensor: <string>
          # logtraffic: <value in [disable, all, utm]>
          # logtraffic_start: <value in [disable, enable]>
          # mms_profile: <string>
          # name: <string>
          # profile_group: <string>
          # profile_protocol_options: <string>
          # profile_type: <value in [single, group]>
          # schedule: <string>
          # service: <list or string>
          # service_negate: <value in [disable, enable]>
          # srcaddr4: <list or string>
          # srcaddr6: <list or string>
          # srcintf: <list or string>
          # ssh_filter_profile: <string>
          # ssl_ssh_profile: <string>
          # status: <value in [disable, enable]>
          # url_category: <list or string>
          # users: <list or string>
          # utm_status: <value in [disable, enable]>
          # uuid: <string>
          # voip_profile: <string>
          # webfilter_profile: <string>
          # fsso_groups: <list or string>
          # global_label: <string>
          # send_deny_packet: <value in [disable, enable]>
          # dstaddr: <list or string>
          # internet_service_name: <list or string>
          # internet_service_src_name: <list or string>
          # srcaddr: <list or string>
          # dstaddr_negate: <value in [disable, enable]>
          # file_filter_profile: <string>
          # srcaddr_negate: <value in [disable, enable]>
          # learning_mode: <value in [disable, enable]>
          # videofilter_profile: <string>
          # _policy_block: <integer>
          # dlp_profile: <string>
          # nat46: <value in [disable, enable]>
          # nat64: <value in [disable, enable]>
          # sctp_filter_profile: <string>
          # internet_service6: <value in [disable, enable]>
          # internet_service6_custom: <list or string>
          # internet_service6_custom_group: <list or string>
          # internet_service6_group: <list or string>
          # internet_service6_name: <list or string>
          # internet_service6_negate: <value in [disable, enable]>
          # internet_service6_src: <value in [disable, enable]>
          # internet_service6_src_custom: <list or string>
          # internet_service6_src_custom_group: <list or string>
          # internet_service6_src_group: <list or string>
          # internet_service6_src_name: <list or string>
          # internet_service6_src_negate: <value in [disable, enable]>
          # casb_profile: <string>
          # diameter_filter_profile: <string>
          # dstaddr6_negate: <value in [disable, enable]>
          # ips_voip_filter: <string>
          # srcaddr6_negate: <value in [disable, enable]>
          # virtual_patch_profile: <string>
          # telemetry_profile: <list or string>
          # internet_service_fortiguard: <list or string>
          # internet_service_src_fortiguard: <list or string>
          # internet_service6_fortiguard: <list or string>
          # internet_service6_src_fortiguard: <list or string>

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Сведения о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=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_pkg_firewall_securitypolicy_module.html

Spec-Zone.ru

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