Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_appliance_vpn_third_party_vpn_peers_info — информационный модуль для organizations _appliance _vpn _third _party _vpn _peers

Примечание

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

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

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

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

Новый в cisco.meraki 1.0.0

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

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

  • Получить все organizations _appliance _vpn _third _party _vpn _peers.
  • Вернуть VPN-пиры сторонних производителей для организации.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

headers

dictionary

Дополнительные заголовки.

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), базовый URL для всех ресурсов конечных точек

По умолчанию: "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. Идентификатор организации.

Примечания

Примечание

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

См. также

См. также

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

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

Примеры

- name: Get all organizations _appliance _vpn _third _party _vpn _peers
  cisco.meraki.organizations_appliance_vpn_third_party_vpn_peers_info:
    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_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    organizationId: string
  register: result

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

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

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\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"

Авторы

  • Francisco Munoz (@fmunoz)

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

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

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

Spec-Zone.ru

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