Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_appliance_vpn_third_party_vpnpeers – Модуль ресурсов для организаций _appliance _vpn _thirdpartyvpnpeers

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

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

Новый в cisco.meraki 2.16.0

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Обзор

  • Управление обновлением операций ресурса organizations _appliance _vpn _thirdpartyvpnpeers.
  • Обновление VPN-соединений третьих сторон для организации.

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий

Default: 60

meraki_api_key

string / required

meraki_api_key (string), API ключ, сгенерированный на панели управления; также может быть установлен как переменная окружения MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (string), предшествует всем ресурсам конечных точек

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; также может быть установлен как переменная окружения BE_GEO_ID

Default: ""

meraki_caller

string

meraki_caller (string), необязательный идентификатор для отслеживания использования API; также может быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER

Default: ""

meraki_certificate_path

string

meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр регистратора

Choices:

  • false ← (default)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (string), имя файла журнала, к которому добавляются дата и метка времени

Default: "meraki_api_"

meraki_log_path

string

log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан

Default: ""

meraki_maximum_retries

integer

meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки Nginx 429

Default: 60

meraki_output_log

boolean

meraki_output_log (boolean), создать файл выходного журнала?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (boolean), выводить сообщения журнала на консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS

Default: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)?

Choices:

  • false ← (default)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки при других ошибках 4XX

Default: 60

meraki_simulate

boolean

meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения?

Choices:

  • false ← (default)
  • true

meraki_single_request_timeout

целое число

meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова API

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

meraki_suppress_logging

булево

meraki_suppress_logging (булево), отключить всю регистрацию? Тогда сами разбирайтесь!

Варианты:

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

meraki_use_iterator_for_get_pages

булево

meraki_use_iterator_for_get_pages (булево), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами

Варианты:

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

meraki_wait_on_rate_limit

булево

meraki_wait_on_rate_limit (булево), повторить попытку при обнаружении ошибки лимита запросов 429?

Варианты:

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

organizationId

строка

Параметр пути OrganizationId. Идентификатор организации.

peers

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

Список VPN-шлюзов.

ikeVersion

строка

Необязательно. Версия IKE, которая будет использоваться для настройки IPsec VPN-шлюза. По умолчанию «1», если опущено.

ipsecPolicies

словарь

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

childAuthAlgo

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

Это алгоритмы аутентификации, которые будут использоваться на фазе 2. Значение должно быть массивом с одним из следующих алгоритмов «sha256», «sha1», «md5».

childCipherAlgo

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

Это алгоритмы шифрования, которые будут использоваться на фазе 2. Значение должно быть массивом с одним или несколькими из следующих алгоритмов «aes256», «aes192», «aes128», «tripledes», «des», «null».

childLifetime

целое число

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

childPfsGroup

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

Это группа Diffie-Hellman, которая будет использоваться для Perfect Forward Secrecy на фазе 2. Значение должно быть массивом с одним из следующих значений «disabled», «group14», «group5», «group2», «group1».

ikeAuthAlgo

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

Это алгоритм аутентификации, который будет использоваться на фазе 1. Значение должно быть массивом с одним из следующих алгоритмов «sha256», «sha1», «md5».

ikeCipherAlgo

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

Это алгоритм шифрования, который будет использоваться на фазе 1. Значение должно быть массивом с одним из следующих алгоритмов «aes256», «aes192», «aes128», «tripledes», «des».

ikeDiffieHellmanGroup

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

Это группа Diffie-Hellman, которая будет использоваться на фазе 1. Значение должно быть массивом с одним из следующих алгоритмов «group14», «group5», «group2», «group1».

ikeLifetime

целое число

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

ikePrfAlgo

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

Необязательно. Это псевдослучайная функция, которая будет использоваться в IKE_SA. Значение должно быть массивом с одним из следующих алгоритмов «prfsha256», «prfsha1», «prfmd5», «default». Опция «default» может быть использована для возврата к алгоритму аутентификации по умолчанию.

ipsecPoliciesPreset

строка

Один из следующих доступных предварительных наборов «default», «aws», «azure». Если это указано, параметр «ipsecPolicies» игнорируется.

localId

строка

Необязательно. Идентификатор локального шлюза используется для идентификации MX для шлюза. Это будет применяться ко всем MX, для которых этот шлюз используется.

name

string

Имя VPN-узла.

networkTags

list / elements=string

Список меток сетей, которые будут подключены к этому узлу. Используйте «all» для всех сетей. Используйте «none» для отсутствия сетей. Если не указано, значение по умолчанию — «all».

privateSubnets

list / elements=string

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

publicIp

string

Необязательно. Публичный IP-адрес VPN-узла.

remoteId

string

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

secret

string

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

Примечания

Примечание

  • Используемые методы SDK: appliance.Appliance.update_organization_appliance_vpn_third_party_vpnpeers,
  • Используемые пути: put /organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers,
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует какие-либо плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco Meraki для appliance updateOrganizationApplianceVpnThirdPartyVPNPeers

Полное описание API updateOrganizationApplianceVpnThirdPartyVPNPeers.

Примеры

- name: Update all
  cisco.meraki.organizations_appliance_vpn_third_party_vpnpeers:
    meraki_api_key: "{{meraki_api_key}}"
    meraki_base_url: "{{meraki_base_url}}"
    meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
    meraki_certificate_path: "{{meraki_certificate_path}}"
    meraki_requests_proxy: "{{meraki_requests_proxy}}"
    meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
    meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
    meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
    meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
    meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
    meraki_maximum_retries: "{{meraki_maximum_retries}}"
    meraki_output_log: "{{meraki_output_log}}"
    meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
    meraki_log_path: "{{meraki_log_path}}"
    meraki_print_console: "{{meraki_print_console}}"
    meraki_suppress_logging: "{{meraki_suppress_logging}}"
    meraki_simulate: "{{meraki_simulate}}"
    meraki_be_geo_id: "{{meraki_be_geo_id}}"
    meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: present
    organizationId: string
    peers:
    - ikeVersion: '2'
      ipsecPolicies:
        childAuthAlgo:
        - sha1
        childCipherAlgo:
        - aes128
        childLifetime: 28800
        childPfsGroup:
        - disabled
        ikeAuthAlgo:
        - sha1
        ikeCipherAlgo:
        - tripledes
        ikeDiffieHellmanGroup:
        - group2
        ikeLifetime: 28800
        ikePrfAlgo:
        - prfsha1
      ipsecPoliciesPreset: default
      localId: myMXId@meraki.com
      name: Peer Name
      networkTags:
      - none
      privateSubnets:
      - 192.168.1.0/24
      - 192.168.128.0/24
      publicIp: 123.123.123.1
      remoteId: miles@meraki.com
      secret: Sample Password

Значения возврата

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

Ключ

Описание

meraki_response

dictionary

Словарь или список с ответом, возвращённым Cisco Meraki Python SDK

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

Пример: "[\n  {\n    \"ikeVersion\": \"string\",\n    \"ipsecPolicies\": {\n      \"childAuthAlgo\": [\n        \"string\"\n      ],\n      \"childCipherAlgo\": [\n        \"string\"\n      ],\n      \"childLifetime\": 0,\n      \"childPfsGroup\": [\n        \"string\"\n      ],\n      \"ikeAuthAlgo\": [\n        \"string\"\n      ],\n      \"ikeCipherAlgo\": [\n        \"string\"\n      ],\n      \"ikeDiffieHellmanGroup\": [\n        \"string\"\n      ],\n      \"ikeLifetime\": 0,\n      \"ikePrfAlgo\": [\n        \"string\"\n      ]\n    },\n    \"ipsecPoliciesPreset\": \"string\",\n    \"localId\": \"string\",\n    \"name\": \"string\",\n    \"networkTags\": [\n      \"string\"\n    ],\n    \"privateSubnets\": [\n      \"string\"\n    ],\n    \"publicIp\": \"string\",\n    \"remoteId\": \"string\",\n    \"secret\": \"string\"\n  }\n]\n"

Авторы

  • Francisco Munoz (@fmunoz)

Ссылки на коллекцию

  • Система отслеживания задач
  • Репозиторий (исходные коды)

© 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/organizations_appliance_vpn_third_party_vpnpeers_module.html

Spec-Zone.ru

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