Spec-Zone.ru › Ansible

модуль cisco.meraki.devices_switch_ports_statuses_info — информационный модуль для устройств _switch _ports _statuses

Примечание

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

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

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

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

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

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

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

  • Информационный модуль для сведений о состоянии портов коммутаторов устройств.
  • Получение сведений о состоянии портов коммутаторов всех устройств.
  • Возвращает состояние всех портов коммутатора.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

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 ← (по умолчанию)

serial

string

Информационный модуль для сведений о состоянии портов коммутаторов устройств.

Параметр пути serial.

t0

string

Информационный модуль для сведений о состоянии портов коммутаторов устройств.

Параметр запроса T0. Начало временного интервала, за который запрашиваются данные. Максимальный период ретроспективного просмотра — 31 день от текущей даты.

timespan

float

Информационный модуль для сведений о состоянии портов коммутаторов устройств.

Параметр запроса timespan. Временной интервал, за который будут получены сведения. Если указан timespan, не указывайте параметр t0. Значение должно быть задано в секундах и не превышать 31 день. По умолчанию используется 1 день.

Примечания

Примечание

  • Используемый метод SDK: switch.Switch.get_device_switch_ports_statuses,
  • Используемый путь: get /devices/{serial}/switch/ports/statuses,
  • Поддерживает check_mode
  • Плагин запускается на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco meraki SDK
  • Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установления подключения

См. также

См. также

Документация Cisco Meraki по методу switch getDeviceSwitchPortsStatuses

Полное описание API getDeviceSwitchPortsStatuses.

Примеры

- name: Get all devices _switch _ports _statuses
  cisco.meraki.devices_switch_ports_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 }}"
    t0: string
    timespan: 0
    serial: string
  register: result

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

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

Ключ

Описание

meraki_response

list / элементы=dictionary

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

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

Пример: "[\n  {\n    \"portId\": \"string\",\n    \"enabled\": true,\n    \"status\": \"string\",\n    \"isUplink\": true,\n    \"errors\": [\n      \"string\"\n    ],\n    \"warnings\": [\n      \"string\"\n    ],\n    \"speed\": \"string\",\n    \"duplex\": \"string\",\n    \"spanningTree\": {\n      \"statuses\": [\n        \"string\"\n      ]\n    },\n    \"poe\": {\n      \"isAllocated\": true\n    },\n    \"usageInKb\": {\n      \"total\": 0,\n      \"sent\": 0,\n      \"recv\": 0\n    },\n    \"cdp\": {\n      \"systemName\": \"string\",\n      \"platform\": \"string\",\n      \"deviceId\": \"string\",\n      \"portId\": \"string\",\n      \"nativeVlan\": 0,\n      \"address\": \"string\",\n      \"managementAddress\": \"string\",\n      \"version\": \"string\",\n      \"vtpManagementDomain\": \"string\",\n      \"capabilities\": \"string\"\n    },\n    \"lldp\": {\n      \"systemName\": \"string\",\n      \"systemDescription\": \"string\",\n      \"chassisId\": \"string\",\n      \"portId\": \"string\",\n      \"managementVlan\": 0,\n      \"portVlan\": 0,\n      \"managementAddress\": \"string\",\n      \"portDescription\": \"string\",\n      \"systemCapabilities\": \"string\"\n    },\n    \"clientCount\": 0,\n    \"powerUsageInWh\": 0,\n    \"trafficInKbps\": {\n      \"total\": 0,\n      \"sent\": 0,\n      \"recv\": 0\n    },\n    \"securePort\": {\n      \"enabled\": true,\n      \"active\": true,\n      \"authenticationStatus\": \"string\",\n      \"configOverrides\": {\n        \"type\": \"string\",\n        \"vlan\": 0,\n        \"voiceVlan\": 0,\n        \"allowedVlans\": \"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/devices_switch_ports_statuses_info_module.html

Spec-Zone.ru

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