meraki_mx_l3_firewall – Управление брандмауэрами MX уровня 3 на приборе Meraki

Новое в версии 2.7.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Состояние

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно			Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения `MERAKI_KEY` не задана.
host строка		Значение по умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число		Значение по умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки.
net_id -			Идентификатор сети, в которой находится брандмауэр MX.
net_name -			Имя сети, в которой находится брандмауэр MX.
org_id строка			Идентификатор организации.
org_name строка			Имя организации. псевдонимы: организация
output_format строка		Варианты: snakecase ← camelcase	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка		Варианты: debug normal ←	Устанавливает количество отладочной информации во время выполнения модуля.
rate_limit_retry_time целое число		Значение по умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничитель скорости.
rules -			Список правил брандмауэра.
	comment -		Необязательный комментарий для описания правила брандмауэра.
	dest_cidr -		Список сетей назначения в формате CIDR, разделенные запятыми.
	dest_port -		Список номеров портов назначения, разделенных запятыми, для сопоставления.
	policy -	Варианты: allow deny	Политика, которая применяется при срабатывании правила.
	protocol -	Варианты: any icmp tcp udp	Протокол для сопоставления.
	src_cidr -		Список сетей источника в формате CIDR, разделенных запятыми.
	src_port -		Список номеров портов источника, разделенных запятыми, для сопоставления.
	syslog_enabled -		Указывает, нужно ли регистрировать события по правилу брандмауэра. Применимо только в случае, если сервер syslog указан для сети.
state -		Варианты: present ← query	Создание или изменение организации.
syslog_default_rule boolean		Варианты: no ← yes	Указывает, нужно ли регистрировать срабатывания по правилу брандмауэра по умолчанию. Применимо только в случае, если сервер syslog указан для сети. Это не отображается в ответе от Meraki. Вместо этого обратитесь к значению `syslog_enabled` в правиле по умолчанию.
timeout целое число		Значение по умолчанию: 30	Время ожидания для HTTP-запросов.
use_https boolean		Варианты: no yes ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy boolean		Варианты: no yes	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах.
validate_certs boolean		Варианты: no yes ←	Подтверждать ли сертификаты HTTP.

Примечания

Примечание

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

Примеры

- 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: permit
  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: yes
  delegate_to: localhost

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

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

Ключ		Возвращаемое значение	Описание
data complex		success	Правила брандмауэра, связанные с сетью.
	comment string	always	Комментарий для описания правила брандмауэра. Пример: Блокировать трафик к серверу
	dest_cidr string	always	Список сетей назначения в формате CIDR, разделенные запятыми. Пример: 192.0.1.1/32,192.0.1.2/32
	dest_port string	always	Список портов назначения, разделенных запятыми. Пример: 80,443
	policy string	always	Действие, которое нужно выполнить при совпадении с правилом.
	protocol string	always	Сеть протокол, с которым необходимо сопоставить. Пример: tcp
	src_cidr string	always	Список сетей источника в формате CIDR, разделенных запятыми. Пример: 192.0.1.1/32,192.0.1.2/32
	src_port string	always	Список портов источника, разделенных запятыми. Пример: 80,443
	syslog_enabled boolean	always	Включить запись в syslog при совпадении с правилом. Пример: True

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Данный модуль поддерживается сообществом Ansible. [community]

Авторы

Kevin Breit (@kbreit)

Подсказка

Если вы обнаружите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/meraki_mx_l3_firewall_module.html