Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy модуль — Настройка политик интерфейсов IPv4.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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

строка

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

строка / обязательно

Параметр (adom) в запрошенном URL.

bypass_validation

логическое

Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

логическое

Включить/выключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

строка

Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.

pkg

строка / обязательно

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

pkg_firewall_interfacepolicy

словарь

Настройка верхнего уровня параметров.

address_type

строка

Устарело, пожалуйста, переименуйте на address_type. Тип адреса.

Варианты:

  • "ipv4"
  • "ipv6"

application_list

строка

Устарело, пожалуйста, переименуйте на application_list. Имя списка приложений.

application_list_status

строка

Устарело, пожалуйста, переименуйте на application_list_status. Включение/выключение контроля приложений.

Варианты:

  • "disable"
  • "enable"

av_profile

строка

Устарело, пожалуйста, переименуйте на av_profile. Профиль антивируса.

av_profile_status

строка

Устарело, пожалуйста, переименуйте на av_profile_status. Включение/выключение антивируса.

Варианты:

  • "disable"
  • "enable"

casb_profile

любой

(список) Устарело, пожалуйста, переименуйте на casb_profile. Профиль CASB.

casb_profile_status

строка

Устарело, пожалуйста, переименуйте на casb_profile_status. Включение/выключение CASB.

Варианты:

  • "disable"
  • "enable"

casi_profile

строка

Устарело, пожалуйста, переименуйте на casi_profile. Имя профиля CASI.

casi_profile_status

строка

Устарело, пожалуйста, переименуйте на casi_profile_status. Включение/выключение CASI.

Варианты:

  • "disable"
  • "enable"

comments

строка

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

dlp_profile

строка

Устарело, пожалуйста, переименуйте на dlp_profile. Имя профиля DLP.

dlp_profile_status

строка

Устарело, пожалуйста, переименуйте на dlp_profile_status. Включение/выключение DLP.

Варианты:

  • "disable"
  • "enable"

dlp_sensor

строка

Устарело, пожалуйста, переименуйте на dlp_sensor. Имя датчика DLP.

dlp-sensor-status

string

Устарело, переименуйте в dlp_sensor_status. Включить/выключить DLP.

Choices:

  • "disable"
  • "enable"

dsri

string

Включить/выключить DSRI.

Choices:

  • "disable"
  • "enable"

dstaddr

any

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

emailfilter-profile

string

Устарело, переименуйте в emailfilter_profile. Профиль фильтрации электронной почты.

emailfilter-profile-status

string

Устарело, переименуйте в emailfilter_profile_status. Включить/выключить фильтр электронной почты.

Choices:

  • "disable"
  • "enable"

interface

string

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

ips-sensor

string

Устарело, переименуйте в ips_sensor. Имя сенсора IPS.

ips-sensor-status

string

Устарело, переименуйте в ips_sensor_status. Включить/выключить IPS.

Choices:

  • "disable"
  • "enable"

label

string

Метка.

logtraffic

string

Тип ведения журнала, который будет использоваться в этой политике

Choices:

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

policyid

integer / required

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

scan-botnet-connections

string

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

Choices:

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

service

any

(list or str) Объект сервиса из доступных опций.

spamfilter-profile

string

Устарело, переименуйте в spamfilter_profile. Противоспам профиль.

spamfilter-profile-status

string

Устарело, переименуйте в spamfilter_profile_status. Включить/выключить антиспам.

Choices:

  • "disable"
  • "enable"

srcaddr

any

(list or str) Объект адреса для ограничения мониторинга трафика до сетевого трафика, отправленного с указанного адреса или диапазона.

status

string

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

Choices:

  • "disable"
  • "enable"

uuid

string

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

webfilter-profile

string

Устарело, переименуйте в webfilter_profile. Профиль веб-фильтрации.

webfilter-profile-status

string

Устарело, переименуйте в webfilter_profile_status. Включить/выключить веб-фильтрацию.

Choices:

  • "disable"
  • "enable"

proposed_method

string

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

Варианты:

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

rc_failed

список / элементы=целое число

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

rc_succeeded

список / элементы=целое число

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

state

строка / обязательный

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

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

строка

ADOM для блокировки в режиме работы FortiManager в режиме рабочей области; значение может быть глобальным и другими, включая корень.

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: 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

словарь

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

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

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

Spec-Zone.ru

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