Spec-Zone.ru › Ansible

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

Примечание

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

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_hyperscalepolicy

dictionary

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

action

string

Действие политики

Варианты:

  • "deny"
  • "accept"

auto_asic_offload

псевдонимы: auto-asic-offload

string

Включить или отключить аппаратную разгрузку трафика политики на ASIC.

Варианты:

  • "disable"
  • "enable"

cgn_eif

псевдонимы: cgn-eif

string

Включить или отключить независимую от конечной точки фильтрацию CGN.

Варианты:

  • "disable"
  • "enable"

cgn_eim

псевдонимы: cgn-eim

string

Включить или отключить независимое от конечной точки сопоставление CGN.

Варианты:

  • "disable"
  • "enable"

cgn_log_server_grp

псевдонимы: cgn-log-server-grp

string

Имя группы серверов журналов NP

cgn_resource_quota

псевдонимы: cgn-resource-quota

integer

Квота ресурсов

cgn_session_quota

псевдонимы: cgn-session-quota

integer

Квота сеансов

comments

string

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

delay_tcp_npu_session

псевдонимы: delay-tcp-npu-session

string

Включить задержку сеанса TCP NPU для гарантии порядка пакетов при трёхэтапном установлении соединения.

Варианты:

  • "disable"
  • "enable"

dstaddr

any

(список или строка) IPv4-адрес назначения и имена групп адресов.

dstaddr6

any

(список или строка) Имя IPv6-адреса назначения и имена групп адресов.

dstaddr_negate

псевдонимы: dstaddr-negate

string

Если параметр включён, dstaddr/dstaddr6 задаёт адрес назначения, которым адрес НЕ должен быть.

Варианты:

  • "disable"
  • "enable"

dstintf

any

(список или строка) Исходящий интерфейс

firewall_session_dirty

псевдонимы: firewall-session-dirty

string

Способ обработки сеансов при изменении конфигурации этой политики брандмауэра.

Варианты:

  • "check-all"
  • "check-new"

global_label

псевдонимы: global-label

string

Метка политики, отображаемая в графическом интерфейсе в режиме глобального представления.

ippool

string

Включить использование пулов IP-адресов для трансляции исходных адресов (SNAT).

Варианты:

  • "disable"
  • "enable"

label

string

Метка политики, отображаемая в графическом интерфейсе в режиме представления разделов.

name

string

Имя политики.

nat

string

Включить или отключить трансляцию исходных адресов (SNAT).

Варианты:

  • "disable"
  • "enable"

policy_offload

псевдонимы: policy-offload

string

Включить или отключить аппаратное установление сеансов для CGNAT.

Варианты:

  • "disable"
  • "enable"

policyid

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

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

poolname

any

(список или строка) Имена пулов IP-адресов.

poolname6

any

(список или строка) Имена пулов IPv6.

send_deny_packet

псевдонимы: send-deny-packet

string

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

Варианты:

  • "disable"
  • "enable"

service

any

(список или строка) Имена служб и групп служб.

service_negate

псевдонимы: service-negate

string

Если параметр включён, service задаёт службу, которой НЕ должна быть служба.

Варианты:

  • "disable"
  • "enable"

srcaddr

any

(список или строка) IPv4-адрес источника и имена групп адресов.

srcaddr6

any

(список или строка) Имя IPv6-адреса источника и имена групп адресов.

srcaddr_negate

псевдонимы: srcaddr-negate

string

Если параметр включён, srcaddr/srcaddr6 задаёт адрес источника, которым адрес НЕ должен быть.

Варианты:

  • "disable"
  • "enable"

srcintf

any

(список или строка) Входящий интерфейс

status

string

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

Варианты:

  • "disable"
  • "enable"

tcp_timeout_pid

псевдонимы: tcp-timeout-pid

string

Идентификатор профиля тайм-аута TCP

traffic_shaper

псевдонимы: traffic-shaper

string

Формирователь трафика.

traffic_shaper_reverse

псевдонимы: traffic-shaper-reverse

string

Формирователь обратного трафика.

udp_timeout_pid

псевдонимы: udp-timeout-pid

string

Идентификатор профиля тайм-аута UDP

uuid

string

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

proposed_method

string

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

Варианты:

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

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия неудачного выполнения.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия успешного выполнения.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

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

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

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие ADOM, включая 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure IPv4/IPv6 policies.
      fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_firewall_hyperscalepolicy:
          policyid: 0 # Required variable, integer
          # 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]>
          # 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

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

Spec-Zone.ru

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