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

Примечание

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

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

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

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

Новое в cisco.meraki 1.0.0

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

УСТЕРЕГШЕЕ

Удалено в:: версии 3.0.0
Почему:: Выпущены обновленные модули с расширенными функциями
Альтернатива:: cisco.meraki.organizations_appliance_vpn_vpn_firewall_rules

Описание

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
auth_key строка / обязательный	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения `MERAKI_KEY` не установлена.
host строка	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней системы. По умолчанию: `60`
org_id строка	Идентификатор организации.
org_name псевдонимы: organization строка	Название организации.
output_format строка	Указывает модулю, следует ли использовать кейс snake (например, `net_id`) или camel case (например, `netId`) для ключей ответа. Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
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 указан для сети. Варианты: `false` ← (по умолчанию) `true`
state строка	Создание или изменение организации. Варианты: `"present"` ← (по умолчанию) `"query"`
syslog_default_rule логическое значение	Включить или выключить логирование событий по правилу брандмауэра по умолчанию. Применимо только если сервер syslog указан для сети. Это не отображается в ответе от Meraki. Вместо этого см. значение `syslog_enabled` в правиле по умолчанию. Варианты: `false` `true`
timeout целое число	Время ожидания для HTTP-запросов. По умолчанию: `30`

END_OF_DOCUMENT_MARKER

use_https boolean	Если `no`, будет использоваться HTTP. В противном случае используется HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy boolean	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Производить ли проверку сертификатов HTTP. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Модуль предполагает передачу полного списка правил брандмауэра в качестве параметра.
Дополнительную информацию об API Meraki можно найти на странице https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake_case. Чтобы использовать camelCase, установите переменную окружения ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki Ansible прекратят поддержку вывода в формате camelCase в 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 complex	Правила брандмауэра, связанные с сетью. Возвращается: успех
rules complex	Список правил брандмауэра, связанных с сетью. Возвращается: успех
comment string	Комментарий для описания правила брандмауэра. Возвращается: всегда Пример: `"Block traffic to server"`
dest_cidr string	Список CIDR-нотаций целевых сетей, разделённых запятыми. Возвращается: всегда Пример: `"192.0.1.1/32,192.0.1.2/32"`
dest_port string	Список целевых портов, разделённых запятыми. Возвращается: всегда Пример: `"80,443"`
policy string	Действие, выполняемое при совпадении с правилом. Возвращается: всегда
protocol string	Сеть протокол, для которого требуется соответствие. Возвращается: всегда Пример: `"tcp"`
src_cidr string	Список CIDR-нотаций исходных сетей, разделённых запятыми. Возвращается: всегда Пример: `"192.0.1.1/32,192.0.1.2/32"`
src_port string	Список исходных портов, разделённых запятыми. Возвращается: всегда Пример: `"80,443"`
syslog_enabled boolean	Включена ли запись в syslog при совпадении с правилом. Возвращается: всегда Пример: `true`

Статус

Этот модуль будет удален в версии 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_site_to_site_firewall_module.html