Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy6 – Настройка политик IPv6.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy6.

Новое в 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_hyperscalepolicy6

словарь

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

action

строка

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

Варианты:

  • "deny"
  • "accept"
  • "ipsec"

auto_asic_offload

строка

Включить/выключить кеширование трафика ASIC для политики.

Варианты:

  • "disable"
  • "enable"

cgn_log_server_grp

строка

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

comments

строка

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

dstaddr

любой тип

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

dstaddr_negate

строка

Если включено, dstaddr указывает, чего адрес назначения НЕ должен быть.

Варианты:

  • "disable"
  • "enable"

dstintf

любой тип

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

name

строка

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

policy_offload

строка

Включить/выключить перенос конфигурации политики на процессоры CP.

Варианты:

  • "disable"
  • "enable"

policyid

целое число / обязательно

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

service

любой тип

(список или строка) Названия сервисов и групп сервисов.

service_negate

строка

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

Варианты:

  • "disable"
  • "enable"

srcaddr

любой тип

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

srcaddr-negate

строка

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

Варианты:

  • "disable"
  • "enable"

srcintf

любой

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

status

строка

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

Варианты:

  • "disable"
  • "enable"

tcp-timeout-pid

строка

Устарело, пожалуйста, переименуйте на tcp_timeout_pid. Идентификатор профиля тайм-аута TCP

traffic-shaper

строка

Устарело, пожалуйста, переименуйте на traffic_shaper. Обратный формирователь трафика.

traffic-shaper-reverse

строка

Устарело, пожалуйста, переименуйте на traffic_shaper_reverse. Обратный формирователь трафика.

udp-timeout-pid

строка

Устарело, пожалуйста, переименуйте на udp_timeout_pid. Идентификатор профиля тайм-аута UDP

uuid

строка

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

proposed_method

строка

Переопределённый метод для основного запроса 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 (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 IPv6 policies.
      fortinet.fortimanager.fmgr_pkg_firewall_hyperscalepolicy6:
        # 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_hyperscalepolicy6:
          action: <value in [deny, accept, ipsec]>
          auto_asic_offload: <value in [disable, enable]>
          cgn_log_server_grp: <string>
          comments: <string>
          dstaddr: <list or string>
          dstaddr_negate: <value in [disable, enable]>
          dstintf: <list or string>
          name: <string>
          policy_offload: <value in [disable, enable]>
          policyid: <integer>
          service: <list or string>
          service_negate: <value in [disable, enable]>
          srcaddr: <list or string>
          srcaddr_negate: <value in [disable, enable]>
          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_hyperscalepolicy6_module.html

Spec-Zone.ru

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