Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

УСТАРЕЛО

Удалён в:

версии 3.0.0

Почему:

Выпущены обновлённые модули с расширенной функциональностью

Альтернатива:

cisco.meraki.networks_appliance_firewall_l7_firewall_rules

Описание

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

Параметры

Параметр

Комментарии

auth_key

строка / обязательно

Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды MERAKI_KEY не задана.

categories

булево

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

Варианты:

  • false
  • true

host

строка

Имя хоста для панели управления Meraki.

Может использоваться для доступа к региональным средам Meraki, таким как Китай.

По умолчанию: "api.meraki.com"

internal_error_retry_time

целое число

Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной части.

По умолчанию: 60

net_id

строка

Идентификатор сети, в которой находится брандмауэр MX.

net_name

строка

Имя сети, в которой находится брандмауэр MX.

org_id

строка

Идентификатор организации.

org_name

псевдонимы: organization

строка

Название организации.

output_format

строка

Указывает модулю, должны ли ключи ответа быть в нижнем регистре со знаками подчёркивания (например, net_id) или в верхнем регистре с дефисами (например, netId).

Варианты:

  • "snakecase" ← (по умолчанию)
  • "camelcase"

output_level

строка

Устанавливает объём отладочной информации во время выполнения модуля.

Варианты:

  • "debug"
  • "normal" ← (по умолчанию)

rate_limit_retry_time

целое число

Количество секунд для повторной попытки, если срабатывает ограничение скорости.

По умолчанию: 165

rules

список / элементы=словарь

Список правил брандмауэра седьмого уровня.

application

словарь

Приложение для фильтрации.

id

строка

URI приложения, как определено Meraki.

name

строка

Название приложения для фильтрации, как определено Meraki.

countries

список / элементы=строка

Список стран для включения в белый или чёрный список.

Страны следуют формату ISO 3166-1 alpha-2 (двухбуквенный код).

host

строка

FQDN хоста для фильтрации.

ip_range

строка

Диапазон IP-адресов в CIDR-нотации для применения правила.

Порт может быть добавлен к диапазону с использованием ":".

policy

строка

Политика, применяемая при срабатывании правила.

Варианты:

  • "deny" ← (по умолчанию)

port

строка

TCP или UDP порт для фильтрации.

type

строка

Тип политики, применяемой к правилам.

Варианты:

  • "application"
  • "application_category"
  • "blocked_countries"
  • "host"
  • "ip_range"
  • "port"
  • "allowed_countries"

state

строка

Запрос или изменение правила брандмауэра.

Варианты:

  • "present" ← (по умолчанию)
  • "query"
END_OF_DOCUMENT_MARKER

timeout

целое число

Время ожидания для HTTP-запросов.

По умолчанию: 30

use_https

логическое

Если no, будет использоваться HTTP. В противном случае будет использоваться HTTPS.

Полезно только для внутренних разработчиков Meraki.

Варианты:

  • false
  • true ← (по умолчанию)

use_proxy

логическое

Если no, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.

Варианты:

  • false ← (по умолчанию)
  • true

validate_certs

логическое

Подтверждать ли сертификаты HTTP.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Модуль предполагает передачу полного списка правил брандмауэра в качестве параметра.
  • Если есть интерес к модулю, позволяющему манипулировать отдельным правилом брандмауэра, пожалуйста, отправьте запрос на эту тему.
  • Дополнительную информацию об 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-файлы.
  • Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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

complex

Правила брандмауэра, связанные с сетью.

Возвращается: успех

application_categories

list / elements=string

Список категорий приложений и приложений.

Возвращается: успех, при запросе приложений

applications

list / elements=string

Список приложений в категории.

Возвращается: успех

id

string

URI приложения.

Возвращается: успех

Пример: "Gmail"

name

string

Описательное имя приложения.

Возвращается: успех

Пример: "meraki:layer7/application/4"

id

string

URI категории приложений.

Возвращается: успех

Пример: "Email"

name

string

Описательное имя категории приложений.

Возвращается: успех

Пример: "layer7/category/1"

rules

list / elements=string

Упорядоченный список правил брандмауэра.

Возвращается: успех, если не запрашиваются приложения

allowedCountries

string

Разрешённые страны.

Возвращается: успех

Пример: "CA"

applicationCategory

list / elements=string

Список категорий приложений в категории.

Возвращается: успех

id

string

URI приложения.

Возвращается: успех

Пример: "Gmail"

name

string

Описательное имя приложения.

Возвращается: успех

Пример: "meraki:layer7/application/4"

applications

list / elements=string

Список приложений в категории.

Возвращается: успех

id

string

URI приложения.

Возвращается: успех

Пример: "Gmail"

name

string

Описательное имя приложения.

Возвращается: успех

Пример: "meraki:layer7/application/4"

blockedCountries

string

Страны, которые должны быть заблокированы.

Возвращается: успех

Пример: "RU"

ipRange

string

Диапазон IP-адресов в правиле.

Возвращается: успех

Пример: "1.1.1.0/23"

policy

string

Действие, которое необходимо применить при срабатывании правила.

Возвращается: успех

Пример: "deny"

port

string

Номер порта в правиле.

Возвращаемое значение: success

Пример: "23"

type

string

Тип категории правил.

Возвращаемое значение: success

Пример: "applications"

Статус

  • Этот модуль будет удален в версии 3.0.0. [устарел]
  • Дополнительная информация см. УСТАРЕЛО.

Авторы

  • Kevin Breit (@kbreit)

Ссылки на сборку

  • Отслеживание ошибок
  • Репозиторий (источники)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API