cisco.meraki.organizations_appliance_vpn_third_party_vpn_peers module – Модуль ресурсов для сторонних VPN-пиров устройств организации

meraki_action_batch_retry_wait_time

integer

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

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

meraki_api_key

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

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

meraki_base_url

string

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

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

meraki_be_geo_id

string

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

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

meraki_certificate_path

string

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

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

meraki_inherit_logging_config

boolean

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

Варианты:

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

meraki_log_file_prefix

string

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

По умолчанию: "meraki_api_"

meraki_log_path

string

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

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

meraki_maximum_retries

integer

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

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

meraki_nginx_429_retry_wait_time

integer

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

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

meraki_output_log

boolean

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

Варианты:

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

meraki_print_console

boolean

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

Варианты:

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

meraki_requests_proxy

string

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

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

meraki_retry_4xx_error

boolean

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

Варианты:

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

meraki_retry_4xx_error_wait_time

integer

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

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

meraki_simulate

boolean

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

Варианты:

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

meraki_single_request_timeout

integer

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

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

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), отключить ведение всех журналов? Тогда вы предоставлены сами себе!

Варианты:

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

meraki_use_iterator_for_get_pages

boolean

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

Варианты:

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

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), повторять попытку при ошибке ограничения частоты запросов 429?

Варианты:

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

organizationId

string

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

peers

list / elements=dictionary

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

ebgpNeighbor

dictionary

Необязательно. Конфигурация BGP-соседа для VPN-пира. Поддерживается только в MX 19.1 и более поздних версиях.

ebgpHoldTimer

integer

Таймер удержания eBGP в секундах для каждого соседа. Значение таймера удержания eBGP должно быть целым числом от 12 до 240.

ebgpMultihop

integer

Настройте этот параметр, если сосед не является смежным. Значение eBGP multi-hop должно быть целым числом от 1 до 255.

ipVersion

integer

Версия IP соседа.

multiExitDiscriminator

integer

Настраивает локальную метрику, связанную с маршрутами, полученными от удаленного пира. Предпочтение отдается маршрутам от пиров с меньшими метриками. Значение должно быть целым числом от 0 до 4294967295. MED занимает 6-е место в дереве принятия решений, если существуют идентичные маршруты от нескольких пиров.

neighborIp

string

Адрес IPv4/IPv6 соседа.

pathPrepend

list / elements=integer

Добавляет префиксы к атрибуту BGP AS_PATH, связанному с маршрутами, полученными от удаленного пира. Настраиваемое значение ASN для добавления. Длина массива не должна превышать 10, а каждый ASN в массиве должен быть целым числом от 1 до 4294967295. AS_PATH занимает 4-е место в дереве принятия решений, если существуют идентичные маршруты от нескольких пиров.

remoteAsNumber

integer

Удаленный ASN соседа. Удаленный ASN должен быть целым числом от 1 до 4294967295.

sourceIp

string

Исходный IP-адрес соседа eBGP.

weight

integer

Настраивает локальную метрику, связанную с маршрутами, полученными от удаленного пира. Предпочтение отдается маршрутам от пиров с меньшими метриками. Значение должно быть целым числом от 0 до 4294967295. MED занимает 6-е место в дереве принятия решений, если существуют идентичные маршруты от нескольких пиров.

ecmpUplinkConfigs

list / elements=dictionary

Необязательная конфигурация BGP поверх IPsec для VPN-пира с ECMP отдельно для каждого восходящего канала.

ebgpNeighbor

dictionary

Необязательно. Конфигурация BGP-соседа для VPN-пира. Поддерживается только в MX 19.1 и более поздних версиях.

neighborIp

string

Адрес IPv4/IPv6 соседа.

sourceIp

string

Исходный IP-адрес соседа eBGP.

id

string

Идентификатор конфигурации восходящего канала ECMP.

privateSubnets

list / elements=string

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

wan

string

Восходящий канал WAN, связанный с этой конфигурацией ECMP.

group

dictionary

Необязательно. Содержит сопоставление основного туннеля с резервными туннелями.

activeActiveTunnel

boolean

Необязательно. Основной и резервный туннели активны одновременно.

Варианты:

• false
• true

failover

dictionary

Необязательно. Содержит конфигурацию переключения при сбое для группы.

directToInternet

boolean

Необязательно. Если основной и резервный туннели отключены, направлять трафик в интернет. Трафик будет маршрутизироваться через WAN.

Варианты:

• false
• true

number

integer

Необязательно. Определяет порядок группы основных и резервных туннелей. Основные и резервные туннели группируются по этому номеру. Если отправить запрос с номерами 1, 9, 999, они будут автоматически перенумерованы последовательно, начиная с 1. Таким образом, они будут заменены на 1, 2, 3 в соответствии с их позициями в последовательности.

ikeVersion

string

Необязательно. Версия IKE, используемая в конфигурации VPN-пира IPsec. Если параметр не указан, используется значение «1».

ipsecPolicies

dictionary

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

childAuthAlgo

list / elements=string

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

childCipherAlgo

list / elements=string

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

childLifetime

integer

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

childPfsGroup

list / elements=string

Группа Диффи — Хеллмана для обеспечения совершенной прямой секретности (PFS) на этапе 2. Значение должно быть массивом, содержащим одно из следующих значений: ‘disabled’, ‘group14’, ‘group5’, ‘group2’, ‘group1’.

ikeAuthAlgo

list / elements=string

Алгоритм аутентификации для использования на этапе 1. Значение должно быть массивом, содержащим один из следующих алгоритмов: ‘sha256’, ‘sha1’, ‘md5’.

ikeCipherAlgo

list / elements=string

Алгоритм шифрования для использования на этапе 1. Значение должно быть массивом, содержащим один из следующих алгоритмов: ‘aes256’, ‘aes192’, ‘aes128’, ‘tripledes’, ‘des’.

ikeDiffieHellmanGroup

list / elements=string

Это группа Диффи — Хеллмана, используемая на этапе 1. Значение должно представлять собой массив с одним из следующих алгоритмов: ‘group14’, ‘group5’, ‘group2’, ‘group1’.

ikeLifetime

integer

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

ikePrfAlgo

list / elements=string

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

ipsecPoliciesPreset

string

Один из доступных предустановленных вариантов: ‘default’, ‘aws’, ‘azure’, ‘umbrella’, ‘zscaler’. Если это значение указано, параметр ‘ipsecPolicies’ игнорируется.

isRouteBased

boolean

Необязательно. Если значение равно true, VPN-пир использует маршрутизацию. Если параметр не указан, по умолчанию используется значение false. Поддерживается только в MX 19.1 и более поздних версиях.

Варианты:

• false
• true

localId

string

Необязательно. Локальный идентификатор используется для идентификации MX на стороне пира. Он будет применяться ко всем MX, к которым относится этот пир.

name

string

Имя VPN-пира.

network

dictionary

Необязательно. Список имен и идентификаторов сетей, которые будут подключаться к этому пиру. Поддерживается только в MX 19.1 и более поздних версиях.

ids

list / elements=string

Необязательно. Список идентификаторов сетей.

networkTags

list / elements=string

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

peerId

string

Идентификатор IPsec-пира.

priorityInGroup

integer

Необязательно. Задает порядок пира в группе. Если отправить запрос с номерами 1, 9, 999, эти номера будут автоматически преобразованы в последовательный порядок, начиная с 1. Таким образом, они станут 1, 2, 3, отражая свои позиции в последовательности.

privateSubnets

list / elements=string

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

publicHostname

string

Необязательно. Публичное имя хоста VPN-пира.

publicIp

string

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

remoteId

string

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

secret

string

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

slaPolicy

dictionary

Необязательно. Сведения о политике SLA, применяемой к пиру.

id

string

Идентификатор политики SLA.

meraki_response

dictionary

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

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

Пример: "[\n  {\n    \"peerId\": \"string\",\n    \"name\": \"string\",\n    \"publicIp\": \"string\",\n    \"remoteId\": \"string\",\n    \"localId\": \"string\",\n    \"secret\": \"string\",\n    \"privateSubnets\": [\n      \"string\"\n    ],\n    \"ipsecPolicies\": {\n      \"ikeCipherAlgo\": [\n        \"string\"\n      ],\n      \"ikeAuthAlgo\": [\n        \"string\"\n      ],\n      \"ikePrfAlgo\": [\n        \"string\"\n      ],\n      \"ikeDiffieHellmanGroup\": [\n        \"string\"\n      ],\n      \"ikeLifetime\": 0,\n      \"childCipherAlgo\": [\n        \"string\"\n      ],\n      \"childAuthAlgo\": [\n        \"string\"\n      ],\n      \"childPfsGroup\": [\n        \"string\"\n      ],\n      \"childLifetime\": 0\n    },\n    \"slaPolicy\": {\n      \"id\": \"string\"\n    },\n    \"ipsecPoliciesPreset\": \"string\",\n    \"ikeVersion\": \"string\",\n    \"networkTags\": [\n      \"string\"\n    ],\n    \"network\": {\n      \"names\": [\n        \"string\"\n      ],\n      \"ids\": [\n        \"string\"\n      ]\n    },\n    \"isRouteBased\": true,\n    \"ebgpNeighbor\": {\n      \"neighborId\": 0,\n      \"neighborIp\": \"string\",\n      \"ipVersion\": 0,\n      \"remoteAsNumber\": 0,\n      \"ebgpHoldTimer\": 0,\n      \"ebgpMultihop\": 0,\n      \"sourceIp\": \"string\",\n      \"pathPrepend\": [\n        0\n      ],\n      \"multiExitDiscriminator\": 0,\n      \"weight\": 0\n    },\n    \"ecmpUplinkConfigs\": [\n      {\n        \"id\": \"string\",\n        \"wan\": \"string\",\n        \"privateSubnets\": [\n          \"string\"\n        ],\n        \"ebgpNeighbor\": {\n          \"neighborIp\": \"string\",\n          \"sourceIp\": \"string\"\n        }\n      }\n    ],\n    \"priorityInGroup\": 0,\n    \"group\": {\n      \"number\": 0,\n      \"failover\": {\n        \"directToInternet\": true\n      },\n      \"activeActiveTunnel\": true\n    }\n  }\n]\n"