Модуль fortinet.fortimanager.fmgr_pkg_firewall_policy46 — Настройка правил IPv4/IPv6.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_pkg_firewall_policy46.

Добавлен в 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_policy46 словарь	Настройка параметров верхнего уровня.
action строка	Принять или отклонить трафик, соответствующий политике. Варианты: `"deny"` `"accept"`
cgn_log_server_grp строка	Устарело, пожалуйста, переименуйте на cgn_log_server_grp. Имя группы серверов журналов NP
comments строка	Комментарий.
dstaddr любой тип	(список или строка) Объекты адресов назначения.
dstintf строка	Имя интерфейса назначения.
fixedport строка	Включение/выключение фиксированного порта для этой политики. Варианты: `"disable"` `"enable"`
ippool строка	Включение/выключение использования пулов IP для источника NAT. Варианты: `"disable"` `"enable"`
logtraffic строка	Включение/выключение ведения журнала трафика для этой политики. Варианты: `"disable"` `"enable"`
logtraffic_start строка	Устарело, пожалуйста, переименуйте на logtraffic_start. Записывать журналы при запуске и завершении сессии. Варианты: `"disable"` `"enable"`
name строка	Имя политики.
per_ip_shaper строка	Устарело, пожалуйста, переименуйте на per_ip_shaper. Ограничение трафика по IP.
permit_any_host строка	Устарело, пожалуйста, переименуйте на permit_any_host. Включение/выключение разрешения любому хосту. Варианты: `"disable"` `"enable"`
policy_offload строка	Устарело, пожалуйста, переименуйте на policy_offload. Включение/выключение аппаратной установки сессий для CGNAT. Варианты: `"disable"` `"enable"`
policyid целое число / обязательно	Идентификатор политики.

poolname any	(список или строка) Имена IP-пулов.
schedule строка	Имя расписания.
service any	(список или строка) Имя службы.
srcaddr any	(список или строка) Объекты исходных адресов.
srcintf строка	Имя интерфейса источника.
status строка	Включить/выключить эту политику. Варианты: `"disable"` `"enable"`
tags строка	Применённые теги объекта.
tcp-mss-receiver целое число	Устарело, пожалуйста, переименуйте на tcp_mss_receiver. Значение TCP максимального размера сегмента получателя
tcp-mss-sender целое число	Устарело, пожалуйста, переименуйте на tcp_mss_sender. Значение TCP максимального размера сегмента отправителя
traffic-shaper строка	Устарело, пожалуйста, переименуйте на traffic_shaper. Формирователь трафика.
traffic-shaper-reverse строка	Устарело, пожалуйста, переименуйте на traffic_shaper_reverse. Обратный формирователь трафика.
uuid строка	Универсальный уникальный идентификатор
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_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 to IPv6 policies.
      fortinet.fortimanager.fmgr_pkg_firewall_policy46:
        bypass_validation: true
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_policy46:
          action: accept # <value in [deny, accept]>
          comments: ansible-comment
          dstaddr: ansible-test-vip46
          dstintf: any
          policyid: 1
          schedule: always
          service: ALL
          srcaddr: all
          srcintf: any
          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 IPv4 to IPv6 policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_policy46"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            policy46: "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 список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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_policy46_module.html