Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

УСТАРЕВШИЙ

Удалено в:

версии 3.0.0

Почему:

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

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

cisco.meraki.organizations_appliance_vpn_third_party_vpnpeers

Описание

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

Параметры

Параметр

Комментарии

auth_key

строка / обязательно

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

host

строка

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

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

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

internal_error_retry_time

целое число

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

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

org_id

строка

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

org_name

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

строка

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

output_format

строка

Указывает модулю, следует ли использовать ключи ответа в нижнем регистре с дефисами (например, net_id) или в верхнем регистре со словами через подчеркивание (например, netId).

Варианты:

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

output_level

строка

Установите количество отладочной информации во время выполнения модуля.

Варианты:

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

peers

список / элементы=словарь

Список VPN-клиентов.

ike_version

строка

Версия IKE, которая будет использоваться для настройки VPN-клиента IPsec.

Варианты:

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

ipsec_policies

словарь

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

child_auth_algo

список / элементы=строка

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

Варианты:

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

child_cipher_algo

список / элементы=строка

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

Варианты:

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

child_lifetime

целое число

Срок действия SA фазы 2 в секундах.

child_pfs_group

список / элементы=строка

Группа Diffie-Hellman, которая будет использоваться для Perfect Forward Secrecy на фазе 2.

Варианты:

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

ike_auth_algo

список / элементы=строка

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

Варианты:

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

ike_cipher_algo

список / элементы=строка

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

Варианты:

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

ike_diffie_hellman_group

список / элементы=строка

Группа Diffie-Hellman, которая будет использоваться на фазе 1.

Варианты:

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

ike_lifetime

целое число

Срок действия SA фазы 1 в секундах.
END_OF_DOCUMENT_MARKER

ike_prf_algo

список / элементы=строка

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

Варианты:

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

ipsec_policies_preset

строка

Указывает значения предварительной настройки IPsec. Если это значение указано, параметр «ipsecPolicies» игнорируется.

Варианты:

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

name

строка

Имя VPN-узла.

Требуется, если задан параметр state.

network_tags

список / элементы=строка

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

private_subnets

список / элементы=строка

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

Требуется, если задан параметр state.

public_ip

строка

Общедоступный IP-адрес VPN-узла.

Требуется, если задан параметр state.

remote_id

строка

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

secret

строка

Общий секрет с VPN-узлом.

Требуется, если задан параметр state.

rate_limit_retry_time

целое число

Количество секунд для повторной попытки, если срабатывает ограничитель скорости.

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

state

строка

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

Варианты:

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

timeout

целое число

Время ожидания HTTP-запросов.

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

use_https

булево

Если no, будет использоваться HTTP. В противном случае будет использоваться HTTPS.

Полезна только для внутренних разработчиков Meraki.

Варианты:

  • false
  • true ← (по умолчанию)

use_proxy

булево

Если no, прокси не будет использоваться, даже если она определена в переменной окружения на целевых хостах.

Варианты:

  • false ← (по умолчанию)
  • true

validate_certs

булево

Подтверждать ли HTTP-сертификаты.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
  • Некоторые параметры, вероятно, используются только разработчиками внутри Meraki.
  • Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake_case. Для использования camelCase установите переменную окружения ANSIBLE_MERAKI_FORMAT в значение camelcase.
  • Модули Meraki от Ansible перестанут поддерживать вывод camelCase в Ansible 2.13. Пожалуйста, обновите свои playbook'ы.
  • Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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-адрес или определённые Meraki DNS-серверы, которые 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

Это группа Диффи-Хеллмана, которая будет использоваться для Perfect Forward Secrecy на этапе 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"

имя

строка

Имя VPN-узла.

Возвращается: успех

Пример: "MyVPNPeer"

network_tags

список / элементы=строка

Список сетевых тегов, которые будут подключены к этому узлу.

Возвращается: успех

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

private_subnets

список / элементы=строка

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

Возвращается: успех

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

public_ip

строка

Общедоступный IP-адрес VPN-узла.

Возвращается: успех

Пример: "198.51.100.1"

remote_id

строка

Идентификатор удаленного узла используется для идентификации подключаемого VPN-узла.

Возвращается: успех

Пример: "s3cret"

Статус

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

Spec-Zone.ru

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