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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: 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 логическое значение	Варианты: нет да	Указывает, следует ли отправлять трафик по умолчанию в этот хаб. Действительно только в режиме спика.
internal_error_retry_time целое число		По умолчанию: 60	Количество секунд, в течение которых будет происходить повторная попытка, если сервер возвращает ошибку внутренней системы.
mode строка		Варианты: нет хаб спик	Установить режим 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 логическое значение	Варианты: нет да	Необходимо ли публиковать через VPN.
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: 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 строка		всегда	Режим, назначенный сети. Пример: спик
	subnets сложный		всегда	Список подсетей, которые нужно опубликовать через VPN.
		local_subnet строка	всегда	Подсеть в формате CIDR. Пример: 192.168.1.0/24
		use_vpn логическое значение	всегда	Подсеть должна использовать VPN. Пример: 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_vpn_module.html