Spec-Zone.ru › Ansible

cisco.meraki.networks_vlan_profiles_assignments_by_device_info модуль — Модуль информации для сетей _vlanprofiles _assignments _bydevice

Примечание

Этот модуль является частью коллекции cisco.meraki (версия 2.18.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 2.18.0

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

Обзор

  • Получить все сети _vlanprofiles _assignments _bydevice.
  • Получить назначенные профили VLAN для устройств в сети.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

direction

строка

направление (строка), направление для постраничной навигации, либо «next» (по умолчанию), либо «prev» страница

По умолчанию: "https://api.meraki.com/api/v1"

endingBefore

строка

Параметр запроса EndingBefore. Маркер, используемый сервером для обозначения конца страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна его определять.

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

networkId

строка

Параметр пути NetworkId. Идентификатор сети.

perPage

целое число

Параметр запроса perPage. Количество записей на страницу, возвращаемых результатами. Допустимый диапазон 3 - 1000. По умолчанию 1000.

productTypes

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

Параметр запроса ProductTypes. Необязательный параметр для фильтрации устройств по типам продуктов.

serials

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

Параметр запроса serials. Необязательный параметр для фильтрации устройств по серийным номерам. Все возвращаемые устройства относятся к серийным номерам, которые точно совпадают.

stackIds

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

Параметр запроса stackIds. Необязательный параметр для фильтрации устройств по идентификаторам стека коммутаторов.

startingAfter

строка

Параметр запроса startingAfter. Токен, используемый сервером для обозначения начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна его определить.

total_pages

строка / обязательный

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_, используются Cisco meraki Python SDK для установления подключения

См. также

См. также

Документация 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_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

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

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

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

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

Spec-Zone.ru

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