модуль cisco.meraki.organizations_wireless_rf_profiles_assignments_by_device_info — информационный модуль для organizations _wireless _rf _profiles _assignments _by _device

Примечание

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

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

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

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

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

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

Обзор

Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info.
Получить все organizations _wireless _rf _profiles _assignments _by _device.
Вывести список RF-профилей организации по устройствам.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string), направление постраничной навигации: «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса endingBefore. Токен, используемый сервером для указания конца страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers dictionary	Дополнительные заголовки.
mac string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса mac. Необязательный параметр для фильтрации RF-профилей по MAC-адресу устройства. У всех возвращённых устройств MAC-адрес будет содержать поисковую строку или точно ей соответствовать.
macs list / elements=string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса macs. Необязательный параметр для фильтрации RF-профилей по одному или нескольким MAC-адресам устройств. MAC-адреса всех возвращённых устройств будут точно соответствовать указанным.
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), базовый адрес для всех ресурсов конечных точек По умолчанию: `"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` ← (по умолчанию)
model string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса model. Необязательный параметр для фильтрации RF-профилей по модели устройства. Модель всех возвращённых устройств будет содержать поисковую строку или точно ей соответствовать.
models list / elements=string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса models. Необязательный параметр для фильтрации RF-профилей по одной или нескольким моделям устройств. Модели всех возвращённых устройств будут точно соответствовать указанным.
name string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса name. Необязательный параметр для фильтрации RF-профилей по имени устройства. Имя всех возвращённых устройств будет содержать поисковую строку или точно ей соответствовать.
networkIds list / elements=string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса networkIds. Необязательный параметр для фильтрации устройств по сети.
organizationId string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр пути organizationId. Идентификатор организации.
perPage integer	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса perPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 1000.
productTypes list / elements=string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса productTypes. Необязательный параметр для фильтрации устройств по типу продукта. Допустимые типы: wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, wirelessController, campusGateway и secureConnect.
serial string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса serial. Необязательный параметр для фильтрации RF-профилей по серийному номеру устройства. Серийный номер всех возвращённых устройств будет содержать поисковую строку или точно ей соответствовать.
serials list / elements=string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса serials. Необязательный параметр для фильтрации RF-профилей по одному или нескольким серийным номерам устройств. Серийные номера всех возвращённых устройств будут точно соответствовать указанным.
startingAfter string	Информационный модуль для Organizations Wireless Rf Profiles Assignments By Device Info. Параметр запроса startingAfter. Токен, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить общее количество результатов до total_pages*perPage; -1 означает все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _wireless _rf _profiles _assignments _by _device
  cisco.meraki.organizations_wireless_rf_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
    networkIds: []
    productTypes: []
    name: string
    mac: string
    serial: string
    model: string
    macs: []
    serials: []
    models: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"items\": [\n {\n \"network\": {\n \"id\": \"string\"\n },\n \"name\": \"string\",\n \"serial\": \"string\",\n \"model\": \"string\",\n \"rfProfile\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"isIndoorDefault\": true,\n \"isOutdoorDefault\": true\n }\n }\n ],\n \"meta\": {\n \"counts\": {\n \"items\": {\n \"total\": 0,\n \"remaining\": 0\n }\n }\n }\n }\n]\n"

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"items\": [\n {\n \"network\": {\n \"id\": \"string\"\n },\n \"name\": \"string\",\n \"serial\": \"string\",\n \"model\": \"string\",\n \"rfProfile\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"isIndoorDefault\": true,\n \"isOutdoorDefault\": true\n }\n }\n ],\n \"meta\": {\n \"counts\": {\n \"items\": {\n \"total\": 0,\n \"remaining\": 0\n }\n }\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/organizations_wireless_rf_profiles_assignments_by_device_info_module.html