Модуль cisco.meraki.organizations_cellular_gateway_uplink_statuses_info – Модуль информации об организациях _cellulargateway _uplink _statuses

Примечание

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

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

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

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

Новая функция в cisco.meraki 2.16.0

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

Описание

Получение всех статусов _cellulargateway _uplink _statuses организаций.
Вывод статуса канала каждого мобильного шлюза Meraki MG в организации.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
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`
...

END_OF_DOCUMENT_MARKER

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 до 1000. По умолчанию 1000.
serials list / elements=string	Параметр запроса serials. Список серийных номеров. Возвращаемые устройства будут отфильтрованы, чтобы включать только эти серийные номера.
startingAfter string	Параметр запроса StartingAfter. Маркер, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но не ограничивается только ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.
total_pages string / обязательно	total_pages(int), использовать с 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_, используются Cisco meraki Python SDK для установления соединения

См. также

Документация 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_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	Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: "[\n {\n \"lastReportedAt\": \"string\",\n \"model\": \"string\",\n \"networkId\": \"string\",\n \"serial\": \"string\",\n \"uplinks\": [\n {\n \"apn\": \"string\",\n \"connectionType\": \"string\",\n \"dns1\": \"string\",\n \"dns2\": \"string\",\n \"gateway\": \"string\",\n \"iccid\": \"string\",\n \"interface\": \"string\",\n \"ip\": \"string\",\n \"model\": \"string\",\n \"provider\": \"string\",\n \"publicIp\": \"string\",\n \"signalStat\": {\n \"rsrp\": \"string\",\n \"rsrq\": \"string\"\n },\n \"signalType\": \"string\",\n \"status\": \"string\"\n }\n ]\n }\n]\n"

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"lastReportedAt\": \"string\",\n \"model\": \"string\",\n \"networkId\": \"string\",\n \"serial\": \"string\",\n \"uplinks\": [\n {\n \"apn\": \"string\",\n \"connectionType\": \"string\",\n \"dns1\": \"string\",\n \"dns2\": \"string\",\n \"gateway\": \"string\",\n \"iccid\": \"string\",\n \"interface\": \"string\",\n \"ip\": \"string\",\n \"model\": \"string\",\n \"provider\": \"string\",\n \"publicIp\": \"string\",\n \"signalStat\": {\n \"rsrp\": \"string\",\n \"rsrq\": \"string\"\n },\n \"signalType\": \"string\",\n \"status\": \"string\"\n }\n ]\n }\n]\n"

Авторы

Francisco Munoz (@fmunoz)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/organizations_cellular_gateway_uplink_statuses_info_module.html