cisco.meraki.meraki_mx_site_to_site_vpn module – Управление подключениями AutoVPN в Meraki

Примечание

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

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

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

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

Новое в cisco.meraki 1.1.0

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

УСТАРЕЛО

Удалено в:: версии 3.0.0
Причина:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.networks_appliance_vpn_site_to_site_vpn

Краткое описание

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

Параметры

Параметр	Комментарии
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды `MERAKI_KEY` не задана.
host string	Имя хоста панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
hubs list / elements=dictionary	Список концентраторов, назначаемых узлу-спице.
hub_id string	Идентификатор сети концентратора
use_default_route boolean	Указывает, следует ли направлять трафик маршрута по умолчанию через этот концентратор. Действительно только в режиме узла-спицы. Варианты: `false` `true`
internal_error_retry_time integer	Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
mode string	Задаёт режим VPN для сети Варианты: `"none"` `"hub"` `"spoke"`
net_id string	Идентификатор сети, в которой находится межсетевой экран MX.
net_name string	Имя сети, в которой находится межсетевой экран MX.
org_id string	Идентификатор организации.
org_name псевдонимы: organization string	Имя организации.
output_format string	Указывает модулю, следует ли использовать для ключей ответа snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задаёт уровень отладочного вывода при выполнении модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time integer	Количество секунд до повторной попытки при срабатывании ограничения частоты запросов. По умолчанию: `165`
state string	Создать или изменить организацию. Варианты: `"present"` ← (по умолчанию) `"query"`
subnets list / elements=dictionary	Список подсетей для объявления через VPN.
local_subnet string	Подсеть в формате CIDR.
use_vpn boolean	Следует ли объявлять подсеть через VPN. Варианты: `false` `true`
timeout integer	Время ожидания для HTTP-запросов. По умолчанию: `30`
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. Чтобы использовать camel case, задайте переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
Поддержка вывода в формате camel case в модулях Meraki для Ansible будет прекращена в Ansible 2.13. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с загруженными данными. Режим проверки сообщит об изменениях, если конфигурации различаются, но не отправляет изменения в API для проверки.

Примеры

- name: Set hub mode
  meraki_site_to_site_vpn:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: hub_network
    mode: hub
  delegate_to: localhost
  register: set_hub

- name: Set spoke mode
  meraki_site_to_site_vpn:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: spoke_network
    mode: spoke
    hubs:
      - hub_id: N_1234
        use_default_route: false
  delegate_to: localhost
  register: set_spoke

- name: Add subnet to hub for VPN. Hub is required.
  meraki_site_to_site_vpn:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: hub_network
    mode: hub
    hubs:
      - hub_id: N_1234
        use_default_route: false
    subnets:
      - local_subnet: 192.168.1.0/24
        use_vpn: true
  delegate_to: localhost
  register: set_hub

- name: Query rules for hub
  meraki_site_to_site_vpn:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: hub_network
  delegate_to: localhost
  register: query_all_hub

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
data complex	Настройки VPN. Возвращается: при успехе
hubs complex	Сети концентраторов, с которыми устанавливается связь. Возвращается: всегда
hub_id complex	Идентификатор сети концентратора. Возвращается: всегда Пример: `"N_12345"`
use_default_route boolean	Следует ли направлять весь трафик маршрута по умолчанию через VPN. Возвращается: всегда Пример: `true`
mode string	Режим, назначенный сети. Возвращается: всегда Пример: `"spoke"`
subnets complex	Список подсетей для объявления через VPN. Возвращается: всегда
local_subnet string	Подсеть в формате CIDR. Возвращается: всегда Пример: `"192.168.1.0/24"`
use_vpn boolean	Следует ли использовать VPN для подсети. Возвращается: всегда Пример: `true`

Статус

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

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

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