cisco.meraki.organizations_switch_ports_statuses_by_switch_info module – Информационный модуль для статусов портов коммутаторов организаций по коммутаторам

Примечание

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

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

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

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

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

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

Обзор

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

Примечание

Этому модулю соответствует плагин действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
configurationUpdatedAfter строка	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр запроса ConfigurationUpdatedAfter. Необязательный параметр для фильтрации коммутаторов, конфигурация которых была обновлена после указанной временной метки.
direction строка	direction (строка), направление постраничной навигации: страница «next» (следующая, по умолчанию) или «prev» (предыдущая) По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore строка	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers словарь	Дополнительные заголовки.
mac строка	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр запроса Mac. Необязательный параметр для фильтрации коммутаторов по MAC-адресам, содержащим поисковый запрос или точно совпадающим с ним.
macs список / элементы=строка	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр запроса Macs. Необязательный параметр для фильтрации коммутаторов по одному из указанных MAC-адресов.
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 (целое число), время ожидания перед повторной попыткой при ошибке Nginx 429 По умолчанию: `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` ← (по умолчанию)
name строка	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр запроса Name. Необязательный параметр для фильтрации коммутаторов по именам, содержащим поисковый запрос или точно совпадающим с ним.
networkIds список / элементы=строка	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр запроса NetworkIds. Необязательный параметр для фильтрации коммутаторов, входящих в одну из указанных сетей.
organizationId строка	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр пути OrganizationId. Идентификатор организации.
perPage целое число	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: от 3 до 20. Значение по умолчанию — 10.
portProfileIds список / элементы=строка	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр запроса PortProfileIds. Необязательный параметр для фильтрации коммутаторов, содержащих порты, связанные с одним из указанных профилей портов.
serial строка	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр запроса Serial. Необязательный параметр для фильтрации коммутаторов по серийному номеру, содержащему поисковый запрос или точно совпадающему с ним.
serials список / элементы=строка	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр запроса Serials. Необязательный параметр для фильтрации коммутаторов по одному из указанных серийных номеров.
startingAfter строка	Информационный модуль для получения статусов портов коммутаторов организаций. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages строка / обязательный	total_pages(int), используется вместе с perPage для получения всех результатов до total_pages*perPage; -1 означает все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _switch _ports _statuses _by _switch
  cisco.meraki.organizations_switch_ports_statuses_by_switch_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
    configurationUpdatedAfter: string
    mac: string
    macs: []
    name: string
    networkIds: []
    portProfileIds: []
    serial: string
    serials: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: {"items": [{"mac": "string", "model": "string", "name": "string", "network": {"id": "string", "name": "string"}, "ports": [{"duplex": "string", "enabled": true, "errors": ["string"], "isUplink": true, "poe": {"isAllocated": true}, "portId": "string", "securePort": {"active": true, "authenticationStatus": "string"}, "spanningTree": {"statuses": ["string"]}, "speed": "string", "status": "string", "warnings": ["string"]}], "serial": "string"}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"items": [{"mac": "string", "model": "string", "name": "string", "network": {"id": "string", "name": "string"}, "ports": [{"duplex": "string", "enabled": true, "errors": ["string"], "isUplink": true, "poe": {"isAllocated": true}, "portId": "string", "securePort": {"active": true, "authenticationStatus": "string"}, "spanningTree": {"statuses": ["string"]}, "speed": "string", "status": "string", "warnings": ["string"]}], "serial": "string"}], "meta": {"counts": {"items": {"remaining": 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_statuses_by_switch_info_module.html