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

Примечание

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

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

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

Для использования в книге задач укажите: cisco.meraki.organizations_switch_ports_by_switch_info.

Новое в cisco.meraki 2.16.0

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

Описание

Получить все организации _switch _ports _byswitch.
Список портов коммутатора в организации по коммутатору.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

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

Примечания

Примечание

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

См. также

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

Примеры

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

Значения возврата

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: "[\n {\n \"mac\": \"string\",\n \"model\": \"string\",\n \"name\": \"string\",\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"ports\": [\n {\n \"accessPolicyType\": \"string\",\n \"allowedVlans\": \"string\",\n \"enabled\": true,\n \"linkNegotiation\": \"string\",\n \"name\": \"string\",\n \"poeEnabled\": true,\n \"portId\": \"string\",\n \"rstpEnabled\": true,\n \"stickyMacAllowList\": [\n \"string\"\n ],\n \"stickyMacAllowListLimit\": 0,\n \"stpGuard\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"type\": \"string\",\n \"vlan\": 0,\n \"voiceVlan\": 0\n }\n ],\n \"serial\": \"string\"\n }\n]\n"

Ключ

Описание

meraki_response

список / элементы=словарь

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

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

Пример: "[\n {\n \"mac\": \"string\",\n \"model\": \"string\",\n \"name\": \"string\",\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"ports\": [\n {\n \"accessPolicyType\": \"string\",\n \"allowedVlans\": \"string\",\n \"enabled\": true,\n \"linkNegotiation\": \"string\",\n \"name\": \"string\",\n \"poeEnabled\": true,\n \"portId\": \"string\",\n \"rstpEnabled\": true,\n \"stickyMacAllowList\": [\n \"string\"\n ],\n \"stickyMacAllowListLimit\": 0,\n \"stpGuard\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"type\": \"string\",\n \"vlan\": 0,\n \"voiceVlan\": 0\n }\n ],\n \"serial\": \"string\"\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_switch_ports_by_switch_info_module.html