Модуль cisco.meraki.organizations_switch_ports_overview_info — информационный модуль для организаций _switch _ports _overview

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений об обзорной информации о портах коммутаторов организаций.
Получение сведений обо всех _switch _ports _overview организаций.
Возвращает количество всех активных портов за запрошенный период времени, сгруппированных по скорости. Активный порт — это порт, который в какой-либо момент рассматриваемого периода был подключен к устройству, отвечающему на запросы, и не был настроен как отключенный. Если в течение периода наблюдения порт работал на нескольких скоростях, он будет учтен на самой высокой из наблюдавшихся скоростей. Также возвращается количество неактивных портов и общее количество портов. Учитываются только порты коммутаторов, находившихся в сети в течение рассматриваемого периода. Порт гарантированно будет включен в результат, только если его коммутатор находился в сети не менее 6 часов за этот период.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
headers словарь	Дополнительные заголовки.
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` ← (по умолчанию)
organizationId строка	Информационный модуль для получения сведений об обзорной информации о портах коммутаторов организаций. Параметр пути OrganizationId. Идентификатор организации.
t0 строка	Информационный модуль для получения сведений об обзорной информации о портах коммутаторов организаций. Параметр запроса T0. Начало периода, за который предоставляются данные.
t1 строка	Информационный модуль для получения сведений об обзорной информации о портах коммутаторов организаций. Параметр запроса T1. Конец периода, за который предоставляются данные. Значение T1 может отстоять от t0 не более чем на 186 дней.
timespan число с плавающей точкой	Информационный модуль для получения сведений об обзорной информации о портах коммутаторов организаций. Параметр запроса Timespan. Период, за который будут получены данные. Если задан параметр timespan, не указывайте параметры t0 и t1. Значение должно быть указано в секундах и составлять не менее 12 часов и не более 186 дней. По умолчанию — 1 день.

Примечания

Примечание

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

См. также

Документация Cisco Meraki по методу switch getOrganizationSwitchPortsOverview: Полное описание API getOrganizationSwitchPortsOverview.

Примеры

- name: Get all organizations _switch _ports _overview
  cisco.meraki.organizations_switch_ports_overview_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
    t1: string
    timespan: 0
    organizationId: string
  register: result

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: `{"byStatus": {"active": {"byMediaAndLinkSpeed": {"rj45": {"10": 0, "100": 0, "1000": 0, "10000": 0, "2500": 0, "5000": 0, "total": 0}, "sfp": {"100": 0, "1000": 0, "10000": 0, "100000": 0, "20000": 0, "25000": 0, "40000": 0, "50000": 0, "total": 0}}, "total": 0}, "inactive": {"byMedia": {"rj45": {"total": 0}, "sfp": {"total": 0}}, "total": 0}}, "total": 0}`

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"byStatus": {"active": {"byMediaAndLinkSpeed": {"rj45": {"10": 0, "100": 0, "1000": 0, "10000": 0, "2500": 0, "5000": 0, "total": 0}, "sfp": {"100": 0, "1000": 0, "10000": 0, "100000": 0, "20000": 0, "25000": 0, "40000": 0, "50000": 0, "total": 0}}, "total": 0}, "inactive": {"byMedia": {"rj45": {"total": 0}, "sfp": {"total": 0}}, "total": 0}}, "total": 0}

Авторы

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_switch_ports_overview_info_module.html