Модуль fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy — Настройка политик 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_hyperscalepolicy.

Новая функция в fortinet.fortimanager 2.2.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_hyperscalepolicy словарь	Настройка параметров верхнего уровня.
action строка	Действие политики Варианты: `"deny"` `"accept"`
auto_asic_offload строка	Включить/выключить отгрузку трафика политики ASIC. Варианты: `"disable"` `"enable"`
cgn_eif строка	Включить/выключить независимую фильтрацию конечных точек CGN. Варианты: `"disable"` `"enable"`
cgn_eim строка	Включить/выключить независимое отображение конечных точек CGN. Варианты: `"disable"` `"enable"`
cgn_log_server_grp строка	Имя группы серверов журналов NP.
cgn_resource_quota целое число	Квота ресурсов.
cgn_session_quota целое число	Квота сеансов.
comments строка	Комментарий.
delay_tcp_npu_session строка	Включить задержку сеансов TCP NPU для гарантии порядка пакетов. Варианты: `"disable"` `"enable"`
dstaddr любой	(список или строка) Названия адресов и адресных групп назначения IPv4.
dstaddr_negate строка	Когда включено, dstaddr/dstaddr6 указывает, что адрес назначения должен… Варианты: `"disable"` `"enable"`
dstaddr6 любой	(список или строка) Названия адресов и адресных групп назначения IPv6.
dstintf любой	(список или строка) Исходящие

END_OF_DOCUMENT_MARKER

firewall-session-dirty string	Устарело, переименуйте в firewall_session_dirty. Как обрабатывать сессии, если конфигурация этой политики брандмауэра… Варианты: `"check-all"` `"check-new"`
global-label string	Устарело, переименуйте в global_label. Метка для политики, которая отображается, когда графический интерфейс находится в режиме глобального просмотра.
ippool string	Включить использование пулов IP-адресов для NAT источника. Варианты: `"disable"` `"enable"`
label string	Метка для политики, которая отображается, когда графический интерфейс находится в режиме просмотра раздела.
name string	Имя политики.
nat string	Включить/отключить source NAT. Варианты: `"disable"` `"enable"`
policy-offload string	Устарело, переименуйте в policy_offload. Включить/отключить аппаратную настройку сессии для CGNAT. Варианты: `"disable"` `"enable"`
policyid integer / required	Идентификатор политики
poolname any	(список или строка) Имена пулов IP-адресов.
poolname6 any	(список или строка) Имена пулов IPv6-адресов.
send-deny-packet string	Устарело, переименуйте в send_deny_packet. Включить отправку ответа, когда сессия отклонена или заблокирована брандмауэром… Варианты: `"disable"` `"enable"`
service any	(список или строка) Имена сервисов и групп сервисов.
service-negate string	Устарело, переименуйте в service_negate. При включении service указывает, каким сервис НЕ должен быть. Варианты: `"disable"` `"enable"`
srcaddr any	(список или строка) Имена исходных IPv4-адресов и групп адресов.
srcaddr-negate string	Устарело, переименуйте в srcaddr_negate. При включении srcaddr/srcaddr6 указывает, каким исходный адрес НЕ должен быть. Варианты: `"disable"` `"enable"`
srcaddr6 any	(список или строка) Имя исходного IPv6-адреса и имена групп адресов.
srcintf any	(список или строка) Входящий
status string	Включить или отключить эту политику. Варианты: `"disable"` `"enable"`
tcp-timeout-pid string	Устарело, переименуйте в tcp_timeout_pid. Идентификатор профиля тайм-аута TCP
traffic-shaper string	Устарело, переименуйте в traffic_shaper. Формирователь трафика.
traffic-shaper-reverse string	Устарело, переименуйте в traffic_shaper_reverse. Обратный формирователь трафика.

udp-timeout-pid string	Устаревший параметр, переименуйте его на udp_timeout_pid. ID профиля таймаута UDP
uuid string	Универсальный уникальный идентификатор
proposed_method string	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=целое число	Список кодов rc, при которых условия будут нарушены.
rc_succeeded list / элементы=целое число	Список кодов rc, при которых условия будут выполнены.
state string / обязательно	Направление для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки в режиме работы с рабочей областью FortiManager, значение может быть глобальным и другими, включая 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 помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой при возврате ненулевого кода rc. Вы также можете переопределить условия для завершения ошибкой или успешного завершения с параметрами rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure IPv4/IPv6 policies.
      fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_firewall_hyperscalepolicy:
          action: <value in [deny, accept]>
          auto_asic_offload: <value in [disable, enable]>
          cgn_eif: <value in [disable, enable]>
          cgn_eim: <value in [disable, enable]>
          cgn_log_server_grp: <string>
          cgn_resource_quota: <integer>
          cgn_session_quota: <integer>
          comments: <string>
          delay_tcp_npu_session: <value in [disable, enable]>
          dstaddr: <list or string>
          dstaddr_negate: <value in [disable, enable]>
          dstaddr6: <list or string>
          dstintf: <list or string>
          firewall_session_dirty: <value in [check-all, check-new]>
          global_label: <string>
          ippool: <value in [disable, enable]>
          label: <string>
          name: <string>
          nat: <value in [disable, enable]>
          policy_offload: <value in [disable, enable]>
          policyid: <integer>
          poolname: <list or string>
          poolname6: <list or string>
          send_deny_packet: <value in [disable, enable]>
          service: <list or string>
          service_negate: <value in [disable, enable]>
          srcaddr: <list or string>
          srcaddr_negate: <value in [disable, enable]>
          srcaddr6: <list or string>
          srcintf: <list or string>
          status: <value in [disable, enable]>
          tcp_timeout_pid: <string>
          traffic_shaper: <string>
          traffic_shaper_reverse: <string>
          udp_timeout_pid: <string>
          uuid: <string>

Значения возврата

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

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