Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy module – Настройка политик IPv4-интерфейсов.

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.0.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_interfacepolicy

dictionary

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

address_type

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

string

Тип адреса.

Варианты:

  • "ipv4"
  • "ipv6"

application_list

псевдонимы: application-list

string

Имя списка приложений.

application_list_status

псевдонимы: application-list-status

string

Включить/отключить контроль приложений.

Варианты:

  • "disable"
  • "enable"

av_profile

псевдонимы: av-profile

string

Профиль антивирусной защиты.

av_profile_status

псевдонимы: av-profile-status

string

Включить/отключить антивирусную защиту.

Варианты:

  • "disable"
  • "enable"

casb_profile

псевдонимы: casb-profile

any

(список) Профиль CASB.

casb_profile_status

псевдонимы: casb-profile-status

string

Включить/отключить CASB.

Варианты:

  • "disable"
  • "enable"

casi_profile

псевдонимы: casi-profile

string

Имя профиля CASI.

casi_profile_status

псевдонимы: casi-profile-status

string

Включить/отключить CASI.

Варианты:

  • "disable"
  • "enable"

comments

string

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

dlp_profile

псевдонимы: dlp-profile

string

Имя профиля DLP.

dlp_profile_status

псевдонимы: dlp-profile-status

string

Включить/отключить DLP.

Варианты:

  • "disable"
  • "enable"

dlp_sensor

псевдонимы: dlp-sensor

string

Имя датчика DLP.

dlp_sensor_status

псевдонимы: dlp-sensor-status

string

Включить/отключить DLP.

Варианты:

  • "disable"
  • "enable"

dsri

string

Включить/отключить DSRI.

Варианты:

  • "disable"
  • "enable"

dstaddr

any

(список или строка) Объект адреса, ограничивающий мониторинг трафика сетевым трафиком, отправляемым на указанный адрес или диапазон адресов.

emailfilter_profile

псевдонимы: emailfilter-profile

string

Профиль фильтрации электронной почты.

emailfilter_profile_status

псевдонимы: emailfilter-profile-status

string

Включить/отключить фильтрацию электронной почты.

Варианты:

  • "disable"
  • "enable"

interface

string

Имя контролируемого интерфейса из списка доступных интерфейсов.

ips_sensor

псевдонимы: ips-sensor

string

Имя датчика IPS.

ips_sensor_status

псевдонимы: ips-sensor-status

string

Включить/отключить IPS.

Варианты:

  • "disable"
  • "enable"

label

string

Метка.

logtraffic

string

Тип ведения журнала для этой политики

Варианты:

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

policyid

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

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

scan_botnet_connections

псевдонимы: scan-botnet-connections

string

Включить/отключить проверку соединений с серверами ботнетов.

Варианты:

  • "disable"
  • "block"
  • "monitor"

service

any

(список или строка) Объект службы из доступных вариантов.

spamfilter_profile

псевдонимы: spamfilter-profile

string

Профиль защиты от спама.

spamfilter_profile_status

псевдонимы: spamfilter-profile-status

string

Включить/отключить защиту от спама.

Варианты:

  • "disable"
  • "enable"

srcaddr

any

(список или строка) Объект адреса, ограничивающий мониторинг трафика сетевым трафиком, отправляемым с указанного адреса или диапазона адресов.

status

string

Включить/отключить эту политику.

Варианты:

  • "disable"
  • "enable"

uuid

string

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

webfilter_profile

псевдонимы: webfilter-profile

string

Профиль веб-фильтрации.

webfilter_profile_status

псевдонимы: webfilter-profile-status

string

Включить/отключить веб-фильтрацию.

Варианты:

  • "disable"
  • "enable"

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
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4 interface policies.
      fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_interfacepolicy:
          address_type: ipv4 # <value in [ipv4, ipv6]>
          comments: "ansible-comment"
          interface: sslvpn_tun_intf
          policyid: 1
          status: enable

- 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 IPv4 interface policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_interfacepolicy"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            interface_policy: "your_value"

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

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

Ключ

Описание

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

Spec-Zone.ru

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