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

Примечание

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

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

Для использования в playbook укажите: cisco.meraki.meraki_mx_l7_firewall.

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

Обзор

Позволяет создавать, управлять и получать доступ к брандмауэрам уровня 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.
	countries список / элементы=строка			Список стран для включения или исключения. Страны следуют формату двухбуквенного ISO 3166-1 alpha-2.
	host строка			FQDN хоста для фильтрации.
	ip_range строка			Диапазон IP-адресов в CIDR-нотации для применения правила. Порт может быть добавлен к диапазону с помощью `":"`.
	policy строка		Варианты: отклонить ←	Политика для применения, если срабатывает правило.
	port строка			Порт на основе TCP или UDP для фильтрации.
	type строка		Варианты: приложение категория_приложения заблокированные_страны хост диапазон_ip порт разрешённые_страны	Тип применяемой политики.
state строка			Варианты: наличие ← запрос	Запрос или изменение правила брандмауэра.
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. Пожалуйста, обновите свои playbooks.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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: 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: 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 сложное				успех	Правила брандмауэра, связанные с сетью.
	application_categories список / элементы=строка			успех, при запросе приложений	Список категорий приложений и самих приложений.
		applications список / элементы=строка		успех	Список приложений в рамках категории.
			id строка	успех	URI приложения. Пример: Gmail
			name строка	успех	Дескриптивное имя приложения. Пример: meraki:layer7/application/4
		id строка		успех	URI категории приложения. Пример: Email
		name строка		успех	Дескриптивное имя категории приложения. Пример: layer7/category/1
	rules список / элементы=строка			успех, при отсутствии запроса приложений	Упорядоченный список правил брандмауэра.
		allowedCountries строка		успех	Допускаемые страны. Пример: CA
		applicationCategory список / элементы=строка		успех	Список категорий приложений внутри категории.
			id строка	успех	URI приложения. Пример: Gmail
			name строка	успех	Дескриптивное имя приложения. Пример: meraki:layer7/application/4
		applications список / элементы=строка		успех	Список приложений в рамках категории.
			id строка	успех	URI приложения. Пример: Gmail
			name строка	успех	Дескриптивное имя приложения. Пример: meraki:layer7/application/4
		blockedCountries строка		успех	Запрещенные страны. Пример: RU
		ipRange строка		успех	Диапазон IP-адресов в правиле. Пример: 1.1.1.0/23
		policy строка		успех	Действие, применяемое при срабатывании правила. Пример: deny
		port строка		успех	Номер порта в правиле. Пример: 23
		type строка		успех	Тип категории правил. Пример: applications

Авторы

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.10/collections/cisco/meraki/meraki_mx_l7_firewall_module.html