Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_uplinks_statuses_info — Модуль информации об устройствах организации _uplinks _statuses

Примечание

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

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

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

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

Введено в cisco.meraki 2.16.0

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

Описание

  • Получение всех статусов _uplinks _statuses организаций.
  • Вывод статуса подключения каждого устройства Meraki MX, MG и Z-серии в организации.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

direction

string

direction (строка), направление для постраничной навигации, либо “next” (по умолчанию), либо “prev” страница

Default: "https://api.meraki.com/api/v1"

endingBefore

string

Параметр запроса EndingBefore. Маркер, используемый сервером для указания конца страницы. Часто это метка времени или ID, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.

headers

dictionary

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

iccids

list / elements=string

Параметр запроса Iccids. Список ICCID. Возвращаемые устройства будут отфильтрованы, чтобы включать только эти ICCID.

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (целое число), время ожидания повторной попытки при ошибке параллельной обработки пакета действий

Default: 60

meraki_api_key

string / required

meraki_api_key (строка), API ключ, сгенерированный на панели управления; может также быть установлен как переменная окружения MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (строка), предшествующий всем конечным точкам ресурсов

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная окружения BE_GEO_ID

Default: ""

meraki_caller

string

meraki_caller (строка), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER

Default: ""

meraki_certificate_path

string

meraki_certificate_path (строка), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (логическое значение), наследует ваш собственный экземпляр логгера

Choices:

  • false ← (default)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (строка), имя файла журнала с добавлением даты и времени

Default: "meraki_api_"

meraki_log_path

string

log_path (строка), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иное

Default: ""

meraki_maximum_retries

integer

meraki_maximum_retries (целое число), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (целое число), время ожидания повторной попытки Nginx 429

Default: 60

meraki_output_log

boolean

meraki_output_log (логическое значение), создать файл выходного журнала?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (логическое значение), выводить сообщения журнала в консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (строка), прокси-сервер и порт, если необходимо, для HTTPS

Default: ""

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 — organizations.Organizations.get_organization_uplinks_statuses,
  • Используемые пути — get /organizations/{organizationId}/uplinks/statuses,
  • Поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключения от Cisco meraki SDK
  • Параметры, начинающиеся с meraki_, используются Cisco meraki Python SDK для установления подключения

См. также

См. также

Документация Cisco Meraki для организации 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_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    \"highAvailability\": {\n      \"enabled\": true,\n      \"role\": \"string\"\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        \"ipAssignedBy\": \"string\",\n        \"primaryDns\": \"string\",\n        \"provider\": \"string\",\n        \"publicIp\": \"string\",\n        \"secondaryDns\": \"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_uplinks_statuses_info_module.html

Spec-Zone.ru

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