cisco.meraki.meraki_mx_l3_firewall модуль — Управление брандмауэрами MX appliance уровня 3 в облаке Meraki

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki.

Чтобы использовать её в playbook, укажите: cisco.meraki.meraki_mx_l3_firewall.

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

УСТАРЕВШИЙ

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

Синопсис

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

Параметры

Параметр	Комментарии
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
host строка	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней системы. По умолчанию: `60`
net_id строка	Идентификатор сети, в которой находится брандмауэр MX.
net_name строка	Имя сети, в которой находится брандмауэр MX.
org_id строка	Идентификатор организации.
org_name псевдонимы: organization строка	Имя организации.
output_format строка	Указывает модулю, следует ли использовать ключи ответа в формате snake case (например, `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`
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. Пожалуйста, обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если конфигурации отличаются, но не отправляет изменения в API для проверки изменений.

Примеры

- name: Query firewall rules
  meraki_mx_l3_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Set two firewall rules
  meraki_mx_l3_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    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: allow
  delegate_to: localhost

- name: Set one firewall rule and enable logging of the default rule
  meraki_mx_l3_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    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 строка	Комментарий для описания правила брандмауэра. Возвращаемое значение: всегда Пример: `"Block traffic to server"`
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`

Статус

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