модуль cisco.meraki.networks_vlan_profiles_assignments_by_device_info — модуль сведений о назначениях профилей VLAN сетей для устройств

Примечание

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

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

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

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

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

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

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

Модуль сведений о назначениях профилей VLAN сетей для устройств.
Получение всех назначений профилей VLAN сетей для устройств.
Получение профилей VLAN, назначенных устройствам в сети.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string) — направление постраничной навигации: страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Модуль сведений о назначениях профилей VLAN сетей для устройств. Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Часто это метка времени или идентификатор, но значение не ограничивается ими. Клиентским приложениям не следует задавать этот параметр. Он должен определяться ссылкой на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
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` ← (по умолчанию)
networkId string	Модуль сведений о назначениях профилей VLAN сетей для устройств. Параметр пути NetworkId. Идентификатор сети.
perPage integer	Модуль сведений о назначениях профилей VLAN сетей для устройств. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон — от 3 до 1000. Значение по умолчанию — 1000.
productTypes list / элементы=string	Модуль сведений о назначениях профилей VLAN сетей для устройств. Параметр запроса ProductTypes. Необязательный параметр для фильтрации устройств по типам продуктов.
serials list / элементы=string	Модуль сведений о назначениях профилей VLAN сетей для устройств. Параметр запроса Serials. Необязательный параметр для фильтрации устройств по серийным номерам. Возвращаются только устройства с точным совпадением серийного номера.
stackIds list / элементы=string	Модуль сведений о назначениях профилей VLAN сетей для устройств. Параметр запроса StackIds. Необязательный параметр для фильтрации устройств по идентификаторам стеков коммутаторов.
startingAfter string	Модуль сведений о назначениях профилей VLAN сетей для устройств. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но значение не ограничивается ими. Клиентским приложениям не следует задавать этот параметр. Он должен определяться ссылкой на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages string / обязательный	total_pages(int) — используйте вместе с perPage, чтобы получить общее количество результатов до total_pages*perPage; значение -1 означает все страницы

Примечания

Примечание

Используемый метод SDK: networks.Networks.get_network_vlan_profiles_assignments_by_device,
Используемый путь: get /networks/{networkId}/vlanProfiles/assignments/byDevice,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а использует встроенный диспетчер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установки соединения

См. также

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

Примеры

- name: Get all networks _vlanprofiles _assignments _bydevice
  cisco.meraki.networks_vlan_profiles_assignments_by_device_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
    serials: []
    productTypes: []
    stackIds: []
    networkId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / элементы=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `"[\n {\n \"name\": \"string\",\n \"serial\": \"string\",\n \"mac\": \"string\",\n \"productType\": \"string\",\n \"vlanProfile\": {\n \"iname\": \"string\",\n \"name\": \"string\",\n \"isDefault\": true\n },\n \"stack\": {\n \"id\": \"string\"\n }\n }\n]\n"`

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"name\": \"string\",\n \"serial\": \"string\",\n \"mac\": \"string\",\n \"productType\": \"string\",\n \"vlanProfile\": {\n \"iname\": \"string\",\n \"name\": \"string\",\n \"isDefault\": true\n },\n \"stack\": {\n \"id\": \"string\"\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/networks_vlan_profiles_assignments_by_device_info_module.html