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

Примечание

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

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

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

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

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

УСТАРЕЛ

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

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

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

Параметры

Параметр	Комментарии
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная окружения `MERAKI_KEY` не задана.
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	Список правил межсетевого экрана.
comment string	Необязательный комментарий с описанием правила межсетевого экрана.
dest_cidr string	Список сетей назначения в нотации CIDR, разделённых запятыми. `Any` необходимо указывать заглавными буквами.
dest_port string	Список номеров портов назначения для сопоставления, разделённых запятыми. `Any` необходимо указывать заглавными буквами.
policy string	Политика, применяемая при срабатывании правила. Варианты: `"allow"` `"deny"`
protocol string	Протокол для сопоставления. Варианты: `"any"` `"icmp"` `"tcp"` `"udp"`
src_cidr string	Список исходных сетей в нотации CIDR, разделённых запятыми. `Any` необходимо указывать заглавными буквами.
src_port string	Список номеров исходных портов для сопоставления, разделённых запятыми. `Any` необходимо указывать заглавными буквами.
syslog_enabled boolean	Следует ли регистрировать совпадения с правилом межсетевого экрана. Применимо, только если для сети указан сервер syslog. Варианты: `false` ← (по умолчанию) `true`
state string	Создать или изменить организацию. Варианты: `"present"` ← (по умолчанию) `"query"`
syslog_default_rule boolean	Следует ли регистрировать совпадения с правилом межсетевого экрана по умолчанию. Применимо, только если для сети указан сервер syslog. Это значение не отображается в ответе Meraki. Вместо этого обратитесь к значению `syslog_enabled` в правиле по умолчанию. Варианты: `false` `true`
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.
В Ansible 2.13 модули Meraki перестанут поддерживать вывод в формате camel case. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с загруженными данными. Режим проверки сообщит об изменениях, если конфигурации различаются, но не отправит изменения в API для проверки.

Примеры

- name: Query firewall rules
  meraki_mx_l3_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Set two firewall rules
  meraki_mx_l3_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    rules:
      - comment: Block traffic to server
        src_cidr: 192.0.1.0/24
        src_port: any
        dest_cidr: 192.0.2.2/32
        dest_port: any
        protocol: any
        policy: deny
      - comment: Allow traffic to group of servers
        src_cidr: 192.0.1.0/24
        src_port: any
        dest_cidr: 192.0.2.0/24
        dest_port: any
        protocol: any
        policy: allow
  delegate_to: localhost

- name: Set one firewall rule and enable logging of the default rule
  meraki_mx_l3_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    rules:
      - comment: Block traffic to server
        src_cidr: 192.0.1.0/24
        src_port: any
        dest_cidr: 192.0.2.2/32
        dest_port: any
        protocol: any
        policy: deny
    syslog_default_rule: true
  delegate_to: localhost

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

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

Ключ	Описание
data complex	Правила межсетевого экрана, связанные с сетью. Возвращается: при успехе
rules complex	Список правил межсетевого экрана. Возвращается: при успехе
comment string	Комментарий с описанием правила межсетевого экрана. Возвращается: всегда Пример: `"Block traffic to server"`
dest_cidr string	Список сетей назначения в нотации CIDR, разделённых запятыми. Возвращается: всегда Пример: `"192.0.1.1/32,192.0.1.2/32"`
dest_port string	Список портов назначения, разделённых запятыми. Возвращается: всегда Пример: `"80,443"`
policy string	Действие, выполняемое при совпадении с правилом. Возвращается: всегда
protocol string	Сетевой протокол для сопоставления. Возвращается: всегда Пример: `"tcp"`
src_cidr string	Список исходных сетей в нотации CIDR, разделённых запятыми. Возвращается: всегда Пример: `"192.0.1.1/32,192.0.1.2/32"`
src_port string	Список исходных портов, разделённых запятыми. Возвращается: всегда Пример: `"80,443"`
syslog_enabled boolean	Следует ли записывать событие в syslog при совпадении с правилом. Возвращается: всегда Пример: `true`

Статус

Этот модуль будет удалён в версии 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_l3_firewall_module.html