Модуль cisco.meraki.organizations_uplinks_statuses_info – информационный модуль для статусов восходящих каналов организаций

Примечание

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

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

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

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

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

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

Описание

Информационный модуль для получения сведений о статусах восходящих каналов организаций.
Получить все статусы восходящих каналов организаций.
Получить список статусов восходящих каналов всех устройств Meraki серий MX, MG и Z в организации.

Примечание

Этому модулю соответствует модуль действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction строка	direction (строка), направление пагинации: страница “next” (по умолчанию) или “prev” По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore строка	Информационный модуль для получения сведений о статусах восходящих каналов организаций. Параметр запроса endingBefore. Токен, используемый сервером для указания конца страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers словарь	Дополнительные заголовки.
iccids список / элементы=строка	Информационный модуль для получения сведений о статусах восходящих каналов организаций. Параметр запроса Iccids. Список ICCID. В возвращаемые устройства будут включены только устройства с этими ICCID.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повтором при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key строка / обязательный	meraki_api_key (строка), ключ API, созданный в панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), базовый URL, предшествующий всем ресурсам конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси По умолчанию: `""`
meraki_inherit_logging_config логическое значение	meraki_inherit_logging_config (логическое значение), наследовать ваш собственный экземпляр регистратора Возможные значения: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла журнала с добавленными датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для вывода журнала; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), количество повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повтором при ошибке 429 от Nginx По умолчанию: `60`
meraki_output_log логическое значение	meraki_output_log (логическое значение), создавать файл журнала вывода? Возможные значения: `false` `true` ← (по умолчанию)
meraki_print_console логическое значение	meraki_print_console (логическое значение), выводить журнал в консоль? Возможные значения: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка), сервер и порт прокси для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error логическое значение	meraki_retry_4xx_error (логическое значение), повторять запрос при получении других ошибок 4XX (кроме 429)? Возможные значения: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повтором при других ошибках 4XX По умолчанию: `60`
meraki_simulate логическое значение	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Возможные значения: `false` ← (по умолчанию) `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` ← (по умолчанию)
networkIds список / элементы=строка	Информационный модуль для получения сведений о статусах восходящих каналов организаций. Параметр запроса NetworkIds. Список идентификаторов сетей. В возвращаемые устройства будут включены только устройства из этих сетей.
organizationId строка	Информационный модуль для получения сведений о статусах восходящих каналов организаций. Параметр пути OrganizationId. Идентификатор организации.
perPage целое число	Информационный модуль для получения сведений о статусах восходящих каналов организаций. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 1000.
serials список / элементы=строка	Информационный модуль для получения сведений о статусах восходящих каналов организаций. Параметр запроса Serials. Список серийных номеров. В возвращаемые устройства будут включены только устройства с этими серийными номерами.
startingAfter строка	Информационный модуль для получения сведений о статусах восходящих каналов организаций. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages строка / обязательный	total_pages (целое число), используется вместе с perPage для получения общего количества результатов до total_pages*perPage; значение -1 означает все страницы

Примечания

Примечание

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

См. также

Документация Cisco Meraki для метода organizations getOrganizationUplinksStatuses: Полный справочник по API getOrganizationUplinksStatuses.

Примеры

- name: Get all organizations _uplinks _statuses
  cisco.meraki.organizations_uplinks_statuses_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 }}"
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkIds: []
    serials: []
    iccids: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"networkId\": \"string\",\n \"serial\": \"string\",\n \"model\": \"string\",\n \"lastReportedAt\": \"string\",\n \"highAvailability\": {\n \"enabled\": true,\n \"role\": \"string\"\n },\n \"uplinks\": [\n {\n \"interface\": \"string\",\n \"status\": \"string\",\n \"ip\": \"string\",\n \"gateway\": \"string\",\n \"publicIp\": \"string\",\n \"primaryDns\": \"string\",\n \"secondaryDns\": \"string\",\n \"ipAssignedBy\": \"string\",\n \"provider\": \"string\",\n \"signalStat\": {\n \"rsrp\": \"string\",\n \"rsrq\": \"string\"\n },\n \"mcc\": \"string\",\n \"mnc\": \"string\",\n \"roaming\": {\n \"status\": \"string\"\n },\n \"connectionType\": \"string\",\n \"apn\": \"string\",\n \"dns1\": \"string\",\n \"dns2\": \"string\",\n \"signalType\": \"string\",\n \"mtu\": 0,\n \"iccid\": \"string\",\n \"imsi\": \"string\",\n \"msisdn\": \"string\"\n }\n ]\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"networkId\": \"string\",\n \"serial\": \"string\",\n \"model\": \"string\",\n \"lastReportedAt\": \"string\",\n \"highAvailability\": {\n \"enabled\": true,\n \"role\": \"string\"\n },\n \"uplinks\": [\n {\n \"interface\": \"string\",\n \"status\": \"string\",\n \"ip\": \"string\",\n \"gateway\": \"string\",\n \"publicIp\": \"string\",\n \"primaryDns\": \"string\",\n \"secondaryDns\": \"string\",\n \"ipAssignedBy\": \"string\",\n \"provider\": \"string\",\n \"signalStat\": {\n \"rsrp\": \"string\",\n \"rsrq\": \"string\"\n },\n \"mcc\": \"string\",\n \"mnc\": \"string\",\n \"roaming\": {\n \"status\": \"string\"\n },\n \"connectionType\": \"string\",\n \"apn\": \"string\",\n \"dns1\": \"string\",\n \"dns2\": \"string\",\n \"signalType\": \"string\",\n \"mtu\": 0,\n \"iccid\": \"string\",\n \"imsi\": \"string\",\n \"msisdn\": \"string\"\n }\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_uplinks_statuses_info_module.html