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

Примечание

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

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

Для использования в playbook, укажите: cisco.meraki.meraki_mx_site_to_site_vpn.

Новое в версии 1.1.0: модуля cisco.meraki

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательный			Ключ аутентификации, предоставленный панелью управления. Обязательно, если переменная среды `MERAKI_KEY` не задана.
host строка		По умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может быть использовано для доступа к региональным средам Meraki, например, Китая.
hubs список / элементы=словарь			Список хабов, которые нужно назначить спикеру.
	hub_id строка		Идентификатор сети хаба.
	use_default_route логический тип	Варианты: no yes	Указывает, нужно ли отправлять трафик по умолчанию в этот хаб. Действительно только в режиме спикера.
internal_error_retry_time целое число		По умолчанию: 60	Количество секунд, которое нужно ждать при повторном запросе, если сервер вернул ошибку внутренней системы.
mode строка		Варианты: none hub spoke	Установите режим VPN для сети.
net_id строка			Идентификатор сети, в которой находится брандмауэр MX.
net_name строка			Имя сети, в которой находится брандмауэр MX.
org_id строка			Идентификатор организации.
org_name строка			Имя организации. псевдонимы: организация
output_format строка		Варианты: snakecase ← camelcase	Указывает модулю, нужно ли использовать ключи ответа в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка		Варианты: debug normal ←	Установите уровень отладки во время выполнения модуля.
rate_limit_retry_time целое число		По умолчанию: 165	Количество секунд ожидания при повторном запросе, если срабатывает ограничитель скорости.
state строка		Варианты: present ← query	Создать или изменить организацию.
subnets список / элементы=словарь			Список подсетей, которые нужно рекламировать через VPN.
	local_subnet строка		Подсеть в формате CIDR.
	use_vpn логический тип	Варианты: no yes	Рекламировать ли через VPN.
timeout целое число		По умолчанию: 30	Время ожидания для HTTP-запросов.
use_https логический тип		Варианты: no yes ←	Если `no`, то будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логический тип		Варианты: no ← yes	Если `no`, то прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.
validate_certs логический тип		Варианты: no yes ←	Нужно ли проверять 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. Обновите свои playbooks.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправит изменения в 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: 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 сложный			успех	Настройки VPN.
	hubs сложный		всегда	Сети хабов для ассоциации.
		hub_id сложный	всегда	Идентификатор сети хаба. Пример: N_12345
		use_default_route логический тип	всегда	Отправлять ли весь трафик по умолчанию через VPN. Пример: True
	mode строка		всегда	Режим, назначенный сети. Пример: spoke
	subnets сложный		всегда	Список подсетей для рекламы через VPN.
		local_subnet строка	всегда	Подсеть в формате CIDR. Пример: 192.168.1.0/24
		use_vpn логический тип	всегда	Использовать ли VPN для подсети. Пример: True

Авторы

Kevin Breit (@kbreit)

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