модуль cisco.meraki.organizations_cellular_gateway_uplink_statuses_info — информационный модуль для организаций _cellulargateway _uplink _statuses

Примечание

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

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

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

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

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

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

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

Информационный модуль для Organizations Cellulargateway Uplink Statuses Info.
Получение всех organizations _cellulargateway _uplink _statuses.
Вывод состояния восходящих каналов всех сотовых шлюзов Meraki MG в организации.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

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

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _cellulargateway _uplink _statuses
  cisco.meraki.organizations_cellular_gateway_uplink_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 list / elements=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"networkId\": \"string\",\n \"serial\": \"string\",\n \"model\": \"string\",\n \"lastReportedAt\": \"string\",\n \"uplinks\": [\n {\n \"interface\": \"string\",\n \"status\": \"string\",\n \"ip\": \"string\",\n \"provider\": \"string\",\n \"publicIp\": \"string\",\n \"model\": \"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 \"gateway\": \"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

list / elements=dictionary

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

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

Пример: "[\n {\n \"networkId\": \"string\",\n \"serial\": \"string\",\n \"model\": \"string\",\n \"lastReportedAt\": \"string\",\n \"uplinks\": [\n {\n \"interface\": \"string\",\n \"status\": \"string\",\n \"ip\": \"string\",\n \"provider\": \"string\",\n \"publicIp\": \"string\",\n \"model\": \"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 \"gateway\": \"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_cellular_gateway_uplink_statuses_info_module.html