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

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.1.3).

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

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

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

Обзор

Позволяет создавать, управлять и получать доступ к данным о брандмауэрах уровня 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 через запятую. `Any` должно быть заглавным.
	dest_port строка		Список портов назначения через запятую для сопоставления. `Any` должно быть заглавным.
	policy строка	Варианты: allow deny	Политика, которая применяется, если правило срабатывает.
	protocol строка	Варианты: any icmp tcp udp	Протокол для сопоставления.
	src_cidr строка		Список сетей источника в формате CIDR через запятую. `Any` должно быть заглавным.
	src_port строка		Список портов источника через запятую для сопоставления. `Any` должно быть заглавным.
	syslog_enabled логический тип	Варианты: нет ← да	Включает или отключает протоколирование сообщений об ошибках для правила брандмауэра. Применимо только если сервер syslog указан для сети.
state строка		Варианты: present ← запрос	Создание или изменение организации.
syslog_default_rule логический тип		Варианты: нет да	Включает или отключает протоколирование срабатываний по умолчанию для правила брандмауэра. Применимо только если сервер syslog указан для сети. Это не отображается в ответе от Meraki. Вместо этого обратитесь к значению `syslog_enabled` в правиле по умолчанию.
timeout целое число		Значение по умолчанию: 30	Время ожидания для HTTP-запросов.
use_https логический тип		Варианты: нет да ←	Если `no`, используется HTTP. В противном случае используется HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логический тип		Варианты: нет ← да	Если `no`, прокси не используется, даже если он определен в переменной окружения на целевых хостах.
validate_certs логический тип		Варианты: нет да ←	Проверка сертификатов HTTP.

Примечания

Примечание

Модуль предполагает, что весь список правил брандмауэра передается в качестве параметра.
Если есть интерес к модулю, позволяющему манипулировать отдельным правилом брандмауэра, пожалуйста, создайте запрос на изменение для этого модуля.
Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, задайте переменную окружения ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki в Ansible перестанут поддерживать вывод в camel case в Ansible 2.13. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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: 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 сложный тип			успех	Правила брандмауэра, связанные с сетью.
	rules сложный тип		успех	Список правил брандмауэра.
		comment строка	всегда	Комментарий для описания правила брандмауэра. Пример: Заблокировать трафик серверу
		dest_cidr строка	всегда	Список сетей назначения в формате CIDR через запятую. Пример: 192.0.1.1/32,192.0.1.2/32
		dest_port строка	всегда	Список портов назначения через запятую. Пример: 80,443
		policy строка	всегда	Действие при срабатывании правила.
		protocol строка	всегда	Протокол сети для сопоставления. Пример: tcp
		src_cidr строка	всегда	Список сетей источника в формате CIDR через запятую. Пример: 192.0.1.1/32,192.0.1.2/32
		src_port строка	всегда	Список портов источника через запятую. Пример: 80,443
		syslog_enabled логический тип	всегда	Включает или отключает протоколирование при срабатывании правила. Пример: True

Авторы

Kevin Breit (@kbreit)

END_OF_DOCUMENT_MARKER

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