Spec-Zone.ru › Ansible

модуль cisco.meraki.meraki_mx_third_party_vpn_peers — управление сторонними VPN-пирами (IPSec) для устройств MX

Примечание

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

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

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

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

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

УСТАРЕЛО

Удалено в:

версии 3.0.0

Причина:

Выпущены обновлённые модули с расширенной функциональностью

Альтернатива:

cisco.meraki.organizations_appliance_vpn_third_party_vpnpeers

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

  • Создание, редактирование, запрос или удаление сторонних VPN-пиров в среде Meraki.

Параметры

Параметр

Комментарии

auth_key

string / обязательный

Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды MERAKI_KEY не задана.

host

string

Имя хоста панели управления Meraki.

Можно использовать для доступа к региональным средам Meraki, например в Китае.

По умолчанию: "api.meraki.com"

internal_error_retry_time

integer

Количество секунд ожидания перед повторным запросом, если сервер возвращает внутреннюю ошибку сервера.

По умолчанию: 60

org_id

string

Идентификатор организации.

org_name

псевдонимы: organization

string

Название организации.

output_format

string

Указывает модулю, следует ли возвращать ключи ответа в snake_case (например, net_id) или camelCase (например, netId).

Варианты:

  • "snakecase" ← (по умолчанию)
  • "camelcase"

output_level

string

Задаёт объём отладочных сообщений во время выполнения модуля.

Варианты:

  • "debug"
  • "normal" ← (по умолчанию)

peers

list / элементы=dictionary

Список VPN-пиров.

ike_version

string

Версия IKE, используемая в конфигурации IPsec VPN-пира.

Варианты:

  • "1" ← (по умолчанию)
  • "2"

ipsec_policies

dictionary

Пользовательские политики IPSec для VPN-пира. Если параметр не указан и предустановленный набор не выбран, будут использоваться политики IPSec по умолчанию.

child_auth_algo

list / элементы=string

Алгоритмы аутентификации, используемые на этапе 2.

Варианты:

  • "sha256"
  • "sha1"
  • "md5"

child_cipher_algo

list / элементы=string

Алгоритмы шифрования, используемые на этапе 2.

Варианты:

  • "aes256"
  • "aes192"
  • "aes128"
  • "tripledes"
  • "des"
  • "null"

child_lifetime

integer

Время жизни SA этапа 2 в секундах.

child_pfs_group

list / элементы=string

Группа Диффи — Хеллмана, используемая для совершенной прямой секретности на этапе 2.

Варианты:

  • "disabled"
  • "group14"
  • "group5"
  • "group2"
  • "group1"

ike_auth_algo

list / элементы=string

Алгоритм аутентификации, используемый на этапе 1.

Варианты:

  • "sha256"
  • "sha1"
  • "md5"

ike_cipher_algo

list / элементы=string

Алгоритм шифрования, используемый на этапе 1.

Варианты:

  • "aes256"
  • "aes192"
  • "aes128"
  • "tripledes"
  • "des"

ike_diffie_hellman_group

list / элементы=string

Группа Диффи — Хеллмана, используемая на этапе 1.

Варианты:

  • "group14"
  • "group5"
  • "group2"
  • "group1"

ike_lifetime

integer

Время жизни SA этапа 1 в секундах.

ike_prf_algo

list / элементы=string

Псевдослучайная функция, используемая в IKE_SA.

Варианты:

  • "prfsha256"
  • "prfsha1"
  • "prfmd5"
  • "default"

ipsec_policies_preset

string

Задаёт предустановленные значения IPsec. Если этот параметр указан, параметр ‘ipsecPolicies’ игнорируется.

Варианты:

  • "default"
  • "aws"
  • "azure"

name

string

Имя VPN-пира.

Обязательно, если state имеет значение present.

network_tags

list / элементы=string

Список тегов сети, которые будут подключаться к этому пиру. Если не указан, используется значение по умолчанию [‘all’].

private_subnets

list / элементы=string

Список частных подсетей VPN-пира.

Обязательно, если state имеет значение present.

public_ip

string

Публичный IP-адрес VPN-пира.

Обязательно, если state имеет значение present.

remote_id

string

Удалённый идентификатор используется для идентификации подключающегося VPN-пира. Это может быть действительный адрес IPv4, FQDN или пользовательский FQDN.

secret

string

Общий секрет с VPN-пиром.

Обязательно, если state имеет значение present.

rate_limit_retry_time

integer

Количество секунд ожидания перед повторным запросом при срабатывании ограничения частоты запросов.

По умолчанию: 165

state

string

Указывает, следует ли запрашивать сведения об объекте, создавать или изменять его либо удалять.

Варианты:

  • "absent"
  • "present"
  • "query" ← (по умолчанию)

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. Чтобы использовать camelCase, установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
  • В Ansible 2.13 модули Meraki для Ansible перестанут поддерживать вывод в camelCase. Обновите свои плейбуки.
  • Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. Если в конфигурациях есть различия, режим проверки сообщит об изменениях, но не отправит их в API для проверки.

Примеры

- name: Query all VPN peers
  meraki_mx_third_party_vpn_peers:
    auth_key: abc123
    state: query
    org_name: orgName
- name: Create VPN peer with an IPsec policy
  meraki_mx_third_party_vpn_peers:
    auth_key: abc123
    state: present
    org_name: orgName
    peers:
      - name: Test peer
        public_ip: 198.51.100.1
        secret: s3cret
        private_subnets:
          - 192.0.2.0/24
        ike_version: '2'
        network_tags:
          - none
        remote_id: 192.0.2.0
        ipsec_policies:
          child_lifetime: 600
          ike_lifetime: 600
          child_auth_algo:
            - md5
          child_cipher_algo:
            - tripledes
            - aes192
          child_pfs_group:
            - disabled
          ike_auth_algo:
            - sha256
          ike_cipher_algo:
            - tripledes
          ike_diffie_hellman_group:
            - group2
          ike_prf_algo:
            - prfmd5

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

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

Ключ

Описание

response

complex

Информация об организации, которая была создана или изменена

Возвращается: success

appliance_ip

string

IP-адрес устройства Meraki в VLAN

Возвращается: success

Пример: "192.0.1.1"

dnsnamservers

string

IP-адрес или DNS-серверы Meraki, которые VLAN должна использовать по умолчанию

Возвращается: success

Пример: "upstream_dns"

peers

complex

Список VPN-пиров.

Возвращается: success

ike_version

string

Версия IKE, используемая в конфигурации IPsec VPN-пира.

Возвращается: success

Пример: "1"

ipsec_policies

complex

Пользовательские политики IPSec для VPN-пира.

Возвращается: success

child_auth_algo

list / elements=string

Алгоритмы аутентификации, используемые на этапе 2.

Возвращается: success

Пример: ["sha1"]

child_cipher_algo

list / elements=string

Алгоритмы шифрования, используемые на этапе 2.

Возвращается: success

Пример: ["aes192"]

child_lifetime

string

Время жизни SA этапа 2 в секундах.

Возвращается: success

Пример: "60"

child_pfs_group

list / elements=string

Группа Диффи — Хеллмана, используемая для совершенной прямой секретности (PFS) на этапе 2.

Возвращается: success

Пример: ["group14"]

ike_auth_algo

list / elements=string

Алгоритм аутентификации, используемый на этапе 1.

Возвращается: success

Пример: ["sha1"]

ike_cipher_algo

list / elements=string

Алгоритм шифрования, используемый на этапе 1.

Возвращается: success

Пример: ["aes128"]

ike_diffie_hellman_group

list / elements=string

Группа Диффи — Хеллмана, используемая на этапе 1.

Возвращается: success

Пример: ["group14"]

ike_lifetime

string

Время жизни SA этапа 1 в секундах.

Возвращается: success

Пример: "60"

ike_prf_algo

list / elements=string

Псевдослучайная функция, используемая в IKE_SA.

Возвращается: success

Пример: ["prfmd5"]

ipsec_policies_preset

string

Предварительно настроенные параметры IPsec.

Возвращается: success

Пример: "aws"

name

string

Имя VPN-пира.

Возвращается: success

Пример: "MyVPNPeer"

network_tags

list / elements=string

Список тегов сетей, которые будут подключаться к этому пиру.

Возвращается: success

Пример: ["all"]

private_subnets

list / elements=string

Список частных подсетей VPN-пира.

Возвращается: success

Пример: ["192.0.2.0/24"]

public_ip

string

Публичный IP-адрес VPN-пира.

Возвращается: success

Пример: "198.51.100.1"

remote_id

string

Удалённый идентификатор используется для идентификации подключающегося VPN-пира.

Возвращается: success

Пример: "s3cret"

Статус

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API