meraki_mx_l7_firewall – Управление брандмауэрами уровня 7 MX-приборов в облаке Meraki

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

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно				Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды `MERAKI_KEY` не задана.
categories логическое значение			Варианты: нет да	При `True`, указывает, что необходимо запросить приложения и категории приложений вместо правил брандмауэра.
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 строка			Варианты: отладка нормальный ←	Устанавливает объем вывода отладки во время выполнения модуля.
rate_limit_retry_time целое число			Значение по умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничение скорости.
rules список				Список правил брандмауэра уровня 7.
	application -			Приложение для фильтрации.
		id строка		URI приложения, как определено Meraki.
		name строка		Имя приложения для фильтрации, как определено Meraki.
	application_category -			Категория приложений для фильтрации.
		id строка		URI категории приложений, как определено Meraki.
		name строка		Имя категории приложений для фильтрации, как определено Meraki.
	countries список			Список стран для включения в белый список или исключения из него. Страны следуют формату двухбуквенных кодов ISO 3166-1 alpha-2.
	host строка			FQDN хоста для фильтрации.
	ip_range строка			Диапазон IP-адресов в CIDR-нотации для применения правила. Порт может быть добавлен к диапазону с `":"`.
	policy строка		Варианты: отклонить ←	Политика, которая применяется, если правило выполнено.
	port строка			Порт на основе TCP или UDP для фильтрации.
	type строка		Варианты: приложение категория_приложений заблокированные_страны хост диапазон_ip порт разрешённые_страны	Тип политики для применения.
state строка			Варианты: present ← запрос	Запрос или изменение правила брандмауэра.
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. Пожалуйста, обновите свои playbook-файлы.

Примеры

- 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: yes
    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: whitelisted_countries
        countries:
          - US
          - FR
      - type: blacklisted_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 сложный тип				успех	Правила брандмауэра, связанные с сетью.
	application_categories список			успех, при запросе приложений	Список категорий приложений и самих приложений.
		applications список			Список приложений в рамках категории.
			id строка	успех	URI приложения. Пример: Gmail
			name строка	успех	Описание приложения. Пример: meraki:layer7/application/4
		id строка		успех	URI категории приложения. Пример: Email
		name строка		успех	Описание категории приложения. Пример: layer7/category/1
	rules список			успех, если не запрашиваются приложения	Отсортированный список правил брандмауэра.
		applicationCategory список			Список категорий приложений в рамках категории.
			id строка	успех	URI приложения. Пример: Gmail
			name строка	успех	Описание приложения. Пример: meraki:layer7/application/4
		applications список			Список приложений в рамках категории.
			id строка	успех	URI приложения. Пример: Gmail
			name строка	успех	Описание приложения. Пример: meraki:layer7/application/4
		blacklistedCountries строка		успех	Запрещенные страны. Пример: RU
		ipRange строка		успех	Диапазон IP-адресов в правиле. Пример: 1.1.1.0/23
		policy строка		успех	Действие, которое нужно применить при срабатывании правила. Пример: deny
		port строка		успех	Номер порта в правиле. Пример: 23
		type строка		успех	Тип категории правила. Пример: applications
		whitelistedCountries строка		успех	Разрешенные страны. Пример: CA

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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_l7_firewall_module.html