Spec-Zone.ru › Ansible 2.11

cisco.meraki.meraki_mx_site_to_site_firewall – Управление правилами брандмауэра приложений MX для VPN-соединений сайта-сайту

Примечание

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

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

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

Новое в версии 1.0.0: плагина cisco.meraki

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_key
строка / обязательно
Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды MERAKI_KEY не задана.
host
строка
Значение по умолчанию:
"api.meraki.com"
Имя хоста панели управления Meraki.
Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time
целое число
Значение по умолчанию:
60
Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней системы.
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 ←
  • query
Создание или изменение организации.
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_site_to_site_firewall:
    auth_key: abc123
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Set two firewall rules
  meraki_mx_site_to_site_firewall:
    auth_key: abc123
    org_name: YourOrg
    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_site_to_site_firewall:
    auth_key: abc123
    org_name: YourOrg
    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
логический
всегда
Включить логирование в syslog при совпадении правила.

Пример:
True


Авторы

  • Kevin Breit (@kbreit)

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

Spec-Zone.ru

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