Spec-Zone.ru › Ansible

модуль cisco.meraki.meraki_mr_l7_firewall — управление межсетевыми экранами уровня 7 точек доступа MR в облаке Meraki

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.meraki_mr_l7_firewall.

  • УСТАРЕЛО
  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТАРЕЛО

Удалено в:

версии 3.0.0

Причина:

Выпущены обновлённые модули с расширенной функциональностью

Альтернатива:

cisco.meraki.networks_appliance_firewall_l7_firewall_rules

Краткое описание

  • Позволяет создавать межсетевые экраны уровня 7 на точках доступа Meraki MR, управлять ими и просматривать их состояние.
  • Предполагается, что в качестве параметра передаётся полный список правил межсетевого экрана.
  • Если вам нужна возможность изменять отдельное правило с помощью этого модуля, отправьте запрос в службу поддержки этого модуля.

Параметры

Параметр

Комментарии

auth_key

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

Ключ аутентификации, предоставленный панелью управления. Обязателен, если не задана переменная среды MERAKI_KEY.

categories

boolean

Если задано значение True, вместо правил межсетевого экрана запрашиваются приложения и категории приложений.

Варианты:

  • false
  • true

host

string

Имя хоста панели управления Meraki.

Можно использовать для доступа к региональным средам Meraki, например в Китае.

По умолчанию: "api.meraki.com"

internal_error_retry_time

integer

Количество секунд до повтора запроса, если сервер возвращает внутреннюю ошибку.

По умолчанию: 60

net_id

string

Идентификатор сети, в которой находятся точки доступа.

net_name

string

Название сети, в которой находятся точки доступа.

number

псевдонимы: ssid_number

string

Номер SSID, для которого применяется правило межсетевого экрана.

org_id

string

Идентификатор организации.

org_name

псевдонимы: organization

string

Название организации.

output_format

string

Указывает модулю, должны ли ключи ответа быть в формате snake case (например, net_id) или camel case (например, netId).

Варианты:

  • "snakecase" ← (по умолчанию)
  • "camelcase"

output_level

string

Задаёт объём отладочных сообщений во время выполнения модуля.

Варианты:

  • "debug"
  • "normal" ← (по умолчанию)

rate_limit_retry_time

integer

Количество секунд до повтора запроса при срабатывании ограничения частоты запросов.

По умолчанию: 165

rules

list / элементы=dictionary

Список правил межсетевого экрана уровня 7.

application

dictionary

Приложение для фильтрации.

id

string

URI приложения, определённый Meraki.

name

string

Название приложения для фильтрации, определённое Meraki.

host

string

Полное доменное имя хоста для фильтрации.

ip_range

string

Диапазон IP-адресов в нотации CIDR, к которому применяется правило.

К диапазону можно добавить порт, используя ":".

policy

string

Политика, применяемая при срабатывании правила.

Варианты:

  • "deny" ← (по умолчанию)

port

string

Порт TCP или UDP для фильтрации.

type

string

Тип применяемой политики.

Варианты:

  • "application"
  • "application_category"
  • "host"
  • "ip_range"
  • "port"

ssid_name

псевдонимы: ssid

string

Название SSID, для которого применяется правило межсетевого экрана.

state

string

Запрос или изменение правила межсетевого экрана.

Варианты:

  • "present" ← (по умолчанию)
  • "query"

timeout

integer

Время ожидания для HTTP-запросов.

По умолчанию: 30

use_https

boolean

Если задано значение no, будет использоваться HTTP. В противном случае будет использоваться HTTPS.

Полезно только для внутренних разработчиков Meraki.

Варианты:

  • false
  • true ← (по умолчанию)

use_proxy

boolean

Если задано значение no, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах.

Варианты:

  • false ← (по умолчанию)
  • true

validate_certs

boolean

Проверять ли сертификаты HTTP.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
  • Некоторые параметры, вероятно, используются только разработчиками Meraki.
  • Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, установите для переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
  • Поддержка вывода в формате camel case в модулях Meraki Ansible будет прекращена в Ansible 2.13. Обновите свои плейбуки.
  • Режим проверки загружает текущую конфигурацию из панели управления, а затем сравнивает с ней изменения. Режим проверки сообщит об изменениях, если конфигурации различаются, но не отправит изменения в API для проверки.

Примеры

- name: Query firewall rules
  meraki_mr_l7_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
    number: 1
  delegate_to: localhost
- name: Query applications and application categories
  meraki_mr_l7_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    number: 1
    categories: true
    state: query
  delegate_to: localhost
- name: Set firewall rules
  meraki_mr_l7_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    number: 1
    state: present
    rules:
      - policy: deny
        type: port
        port: 8080
      - type: port
        port: 1234
      - type: host
        host: asdf.com
      - type: application
        application:
          id: meraki:layer7/application/205
      - type: application_category
        application:
          id: meraki:layer7/category/24
  delegate_to: localhost

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

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

Ключ

Описание

data

complex

Правила межсетевого экрана, связанные с SSID сети.

Возвращается: при успешном выполнении

application_categories

list / элементы=string

Список категорий приложений и приложений.

Возвращается: при успешном выполнении, если запрашивались приложения

applications

list / элементы=string

Список приложений в категории.

Возвращается: при успешном выполнении

id

string

URI приложения.

Возвращается: при успешном выполнении

Пример: "Gmail"

name

string

Описательное название приложения.

Возвращается: при успешном выполнении

Пример: "meraki:layer7/application/4"

id

string

URI категории приложения.

Возвращается: при успешном выполнении

Пример: "Email"

name

string

Описательное название категории приложения.

Возвращается: при успешном выполнении

Пример: "layer7/category/1"

rules

list / элементы=string

Упорядоченный список правил межсетевого экрана.

Возвращается: при успешном выполнении, если не запрашивались приложения

applicationCategory

list / элементы=string

Список категорий приложений внутри категории.

Возвращается: при успешном выполнении

id

string

URI приложения.

Возвращается: при успешном выполнении

Пример: "Gmail"

name

string

Описательное название приложения.

Возвращается: при успешном выполнении

Пример: "meraki:layer7/application/4"

applications

list / элементы=string

Список приложений в категории.

Возвращается: при успешном выполнении

id

string

URI приложения.

Возвращается: при успешном выполнении

Пример: "Gmail"

name

string

Описательное название приложения.

Возвращается: при успешном выполнении

Пример: "meraki:layer7/application/4"

ipRange

string

Диапазон IP-адресов в правиле.

Возвращается: при успешном выполнении

Пример: "1.1.1.0/23"

policy

string

Действие, применяемое при срабатывании правила.

Возвращается: при успешном выполнении

Пример: "deny"

port

string

Номер порта в правиле.

Возвращается: при успешном выполнении

Пример: "23"

type

string

Тип категории правила.

Возвращается: при успешном выполнении

Пример: "applications"

Статус

  • Этот модуль будет удалён в версии 3.0.0. [устарело]
  • Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

  • Joshua Coronado (@joshuajcoronado)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/cisco/meraki/meraki_mr_l7_firewall_module.html

Spec-Zone.ru

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