Модуль fortinet.fortimanager.fmgr_pkg_firewall_localinpolicy — настройка пользовательских политик local-in IPv4.

Примечание

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

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

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

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

Добавлено в 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_localinpolicy dictionary	Параметры верхнего уровня.
action string	Действие, выполняемое для трафика, соответствующего политике Варианты: `"deny"` `"accept"`
comments string	Комментарий.
dstaddr any	(список или строка) Объект адреса назначения из доступных вариантов.
dstaddr_negate псевдонимы: dstaddr-negate string	Если параметр включен, dstaddr указывает, каким НЕ должен быть адрес назначения. Варианты: `"disable"` `"enable"`
ha_mgmt_intf_only псевдонимы: ha-mgmt-intf-only string	Включить или отключить выделение интерфейса управления HA исключительно для политики local-in. Варианты: `"disable"` `"enable"`
internet_service_src псевдонимы: internet-service-src string	Включить или отключить использование Internet Services в качестве источника для этой политики local-in. Варианты: `"disable"` `"enable"`
internet_service_src_custom псевдонимы: internet-service-src-custom any	(список) Имя пользовательского Internet Service источника.
internet_service_src_custom_group псевдонимы: internet-service-src-custom-group any	(список) Имя группы пользовательских Internet Service источников.
internet_service_src_fortiguard псевдонимы: internet-service-src-fortiguard any	(список) Имя источника Internet Service FortiGuard.
internet_service_src_group псевдонимы: internet-service-src-group any	(список) Имя группы источников Internet Service.
internet_service_src_name псевдонимы: internet-service-src-name any	(список) Имя источника Internet Service.
internet_service_src_negate псевдонимы: internet-service-src-negate string	Если параметр включен, internet-service-src указывает, каким НЕ должна быть служба. Варианты: `"disable"` `"enable"`
intf any	Имя входящего интерфейса из доступных вариантов.
logtraffic string	Включить или отключить ведение журнала трафика local-in. Варианты: `"disable"` `"enable"`
policyid integer / обязательный	Идентификатор пользовательской политики local-in.
schedule string	Объект расписания из доступных вариантов.
service any	(список или строка) Объект службы из доступных вариантов.
service_negate псевдонимы: service-negate string	Если параметр включен, service указывает, какой НЕ должна быть служба. Варианты: `"disable"` `"enable"`
srcaddr any	(список или строка) Объект исходного адреса из доступных вариантов.
srcaddr_negate псевдонимы: srcaddr-negate string	Если параметр включен, srcaddr указывает, каким НЕ должен быть исходный адрес. Варианты: `"disable"` `"enable"`
status string	Включить или отключить эту политику local-in. Варианты: `"disable"` `"enable"`
uuid string	Универсальный уникальный идентификатор
virtual_patch псевдонимы: virtual-patch 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 user defined IPv4 local-in policies.
      fortinet.fortimanager.fmgr_pkg_firewall_localinpolicy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_localinpolicy:
          action: deny # <value in [deny, accept]>
          dstaddr: all
          intf: any
          policyid: 1
          schedule: always
          service: ALL
          srcaddr: all
          status: disable

- 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 user defined IPv4 local-in policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_localinpolicy"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            local_in_policy: "your_value"

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

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

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