Модуль cisco.meraki.meraki_mx_l7_firewall — управление межсетевыми экранами 7-го уровня на устройствах MX в облаке Meraki

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: cisco.meraki.meraki_mx_l7_firewall.

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

УСТАРЕЛО

Удалено в:: версии 3.0.0
Причина:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.networks_appliance_firewall_l7_firewall_rules

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

Позволяет создавать, управлять и просматривать межсетевые экраны 7-го уровня, реализованные на межсетевых экранах Meraki MX.

Параметры

Параметр	Комментарии
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	Идентификатор сети, в которой находится межсетевой экран MX.
net_name string	Имя сети, в которой находится межсетевой экран MX.
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.
countries list / элементы=string	Список стран для включения в белый или чёрный список. Для стран используются двухбуквенные коды стандарта ISO 3166-1 alpha-2.
host string	Полное доменное имя хоста для фильтрации.
ip_range string	Диапазон IP-адресов в нотации CIDR, к которому применяется правило. К диапазону можно добавить порт с помощью `":"`.
policy string	Политика, применяемая при срабатывании правила. Варианты: `"deny"` ← (по умолчанию)
port string	Порт TCP или UDP для фильтрации.
type string	Тип применяемой политики. Варианты: `"application"` `"application_category"` `"blocked_countries"` `"host"` `"ip_range"` `"port"` `"allowed_countries"`
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_mx_l7_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Query applications and application categories
  meraki_mx_l7_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    categories: true
    state: query
  delegate_to: localhost

- name: Set firewall rules
  meraki_mx_l7_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    rules:
      - type: allowed_countries
        countries:
          - US
          - FR
      - type: blocked_countries
        countries:
          - CN
      - 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	Правила межсетевого экрана, связанные с сетью. Возвращается: при успешном выполнении
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	Упорядоченный список правил межсетевого экрана. Возвращается: при успешном выполнении, если не запрашиваются приложения
allowedCountries string	Страны, которым разрешён доступ. Возвращается: при успешном выполнении Пример: `"CA"`
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"`
blockedCountries string	Страны, добавленные в чёрный список. Возвращается: при успешном выполнении Пример: `"RU"`
ipRange string	Диапазон IP-адресов в правиле. Возвращается: при успешном выполнении Пример: `"1.1.1.0/23"`
policy string	Действие, применяемое при срабатывании правила. Возвращается: при успешном выполнении Пример: `"deny"`
port string	Номер порта в правиле. Возвращается: при успешном выполнении Пример: `"23"`
type string	Тип категории правила. Возвращается: при успешном выполнении Пример: `"applications"`

Статус

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

Авторы

Kevin Breit (@kbreit)

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

© 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_mx_l7_firewall_module.html