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

Примечание

Этот модуль входит в коллекцию 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_vpn.

Добавлена в cisco.meraki 1.1.0

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

УСТАРЕВШЕ

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

Описание

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
host строка	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
hubs список / элементы=словарь	Список хабов для назначения спикеру.
hub_id строка	Идентификатор сети хаба
use_default_route логическое	Указывает, следует ли отправлять трафик по умолчанию на этот хаб. Действительно только в режиме спикера. Варианты: `false` `true`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной части. По умолчанию: `60`
mode строка	Установить режим VPN для сети Варианты: `"none"` `"hub"` `"spoke"`
net_id строка	Идентификатор сети, в которой находится брандмауэр MX.
net_name строка	Имя сети, в которой находится брандмауэр MX.
org_id строка	Идентификатор организации.
org_name псевдонимы: организация строка	Название организации.
output_format строка	Указывает модулю, должны ли ключи ответа быть в формате snake_case (например, `net_id`) или camelCase (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Установить количество отладочного вывода во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time целое число	Количество секунд для повторной попытки, если срабатывает ограничитель скорости. По умолчанию: `165`
state строка	Создать или изменить организацию. Варианты: `"present"` ← (по умолчанию) `"query"`
subnets список / элементы=словарь	Список подсетей для рекламы через VPN.
local_subnet строка	Подсеть в формате CIDR.
use_vpn логическое	Рекламировать через VPN. Варианты: `false` `true`
timeout целое число	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https логическое	Если `no`, будет использоваться HTTP. В противном случае используется HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

use_proxy boolean	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах. Выбоpы: `false` ← (по умолчанию) `true`
validate_certs boolean	Подтверждать ли сертификаты HTTP. Выбоpы: `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. Пожалуйста, обновите ваши playbook'ы.
Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если существуют различия в конфигурациях, но не отправляет изменения в 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. Возвращаемое значение: success
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–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_vpn_module.html