модуль cisco.meraki.organizations_campus_gateway_clusters_info — информационный модуль для организаций _campus _gateway _clusters

Примечание

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

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

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

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

Добавлено в cisco.meraki 1.0.0

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

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

Информационный модуль для получения сведений о кластерах шлюзов кампуса организации.
Получение всех кластеров _campus _gateway _clusters организации.
Получение сведений о кластерах шлюзов кампуса.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string), направление постраничной навигации: “next” (по умолчанию) или страница “prev” По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для получения сведений о кластерах шлюзов кампуса организации. Параметр запроса endingBefore. Токен, который сервер использует для обозначения конца страницы. Часто это временная метка или идентификатор, но это не обязательно. Клиентские приложения не должны задавать этот параметр. Он должен определяться ссылкой на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
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` ← (по умолчанию)
networkIds list / elements=string	Информационный модуль для получения сведений о кластерах шлюзов кампуса организации. Параметр запроса NetworkIds. Сети, сведения о которых необходимо получить.
organizationId string	Информационный модуль для получения сведений о кластерах шлюзов кампуса организации. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения сведений о кластерах шлюзов кампуса организации. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон — от 3 до 100. Значение по умолчанию — 50.
startingAfter string	Информационный модуль для получения сведений о кластерах шлюзов кампуса организации. Параметр запроса StartingAfter. Токен, который сервер использует для обозначения начала страницы. Часто это временная метка или идентификатор, но это не обязательно. Клиентские приложения не должны задавать этот параметр. Он должен определяться ссылкой на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить общее количество результатов, не превышающее total_pages*perPage; -1 означает все страницы

Примечания

Примечание

Используемый метод SDK: campus_gateway.CampusGateway.get_organization_campus_gateway_clusters,
Используемые пути: get /organizations/{organizationId}/campusGateway/clusters,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный менеджер подключений из Cisco Meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco Meraki для установки подключения

См. также

Документация Cisco Meraki по campusGateway getOrganizationCampusGatewayClusters: Полное описание API getOrganizationCampusGatewayClusters.

Примеры

- name: Get all organizations _campus _gateway _clusters
  cisco.meraki.organizations_campus_gateway_clusters_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 }}"
    networkIds: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: {"items": [{"clusterId": "string", "devices": [{"memberId": "string", "serial": "string", "tunnels": [{"addresses": [{"address": "string", "protocol": "string"}], "interface": "string"}], "uplinks": [{"addresses": [{"address": "string", "protocol": "string"}], "interface": "string"}]}], "name": "string", "nameservers": {"addresses": ["string"]}, "network": {"id": "string"}, "notes": "string", "portChannels": [{"allowedVlans": "string", "id": "string", "name": "string", "vlan": 0}], "tunnels": [{"addresses": [{"gateway": "string", "protocol": "string", "subnetMask": "string"}], "interface": "string", "uplink": {"interface": "string"}, "vlan": 0}], "uplinks": [{"addresses": [{"assignmentMode": "string", "gateway": "string", "protocol": "string", "subnetMask": "string"}], "interface": "string", "vlan": 0}], "url": "string"}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"items": [{"clusterId": "string", "devices": [{"memberId": "string", "serial": "string", "tunnels": [{"addresses": [{"address": "string", "protocol": "string"}], "interface": "string"}], "uplinks": [{"addresses": [{"address": "string", "protocol": "string"}], "interface": "string"}]}], "name": "string", "nameservers": {"addresses": ["string"]}, "network": {"id": "string"}, "notes": "string", "portChannels": [{"allowedVlans": "string", "id": "string", "name": "string", "vlan": 0}], "tunnels": [{"addresses": [{"gateway": "string", "protocol": "string", "subnetMask": "string"}], "interface": "string", "uplink": {"interface": "string"}, "vlan": 0}], "uplinks": [{"addresses": [{"assignmentMode": "string", "gateway": "string", "protocol": "string", "subnetMask": "string"}], "interface": "string", "vlan": 0}], "url": "string"}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}

Авторы

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_campus_gateway_clusters_info_module.html