модуль cisco.meraki.organizations_policies_assignments_by_client_info — информационный модуль для организаций _policies _assignments _by _client

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string), направление пагинации: страница “next” (по умолчанию) или “prev” По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для получения сведений о назначениях политик организации по клиентам. Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Часто это временная метка или идентификатор, но не обязательно. Клиентские приложения не должны задавать этот параметр. Его должно определять значение ссылки на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
headers dictionary	Дополнительные заголовки.
includeUndetectedClients boolean	Информационный модуль для получения сведений о назначениях политик организации по клиентам. Параметр запроса IncludeUndetectedClients. Включать подготовленных клиентов, которые не подключались к сети. По умолчанию — false. Варианты: `false` `true`
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), время ожидания перед повтором при ошибке 429 от Nginx По умолчанию: `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` ← (по умолчанию)
networkIds list / элементы=string	Информационный модуль для получения сведений о назначениях политик организации по клиентам. Параметр запроса NetworkIds. Идентификаторы сетей (минимум 1, максимум 30).
organizationId string	Информационный модуль для получения сведений о назначениях политик организации по клиентам. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения сведений о назначениях политик организации по клиентам. Параметр запроса PerPage. Количество записей на странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 50.
startingAfter string	Информационный модуль для получения сведений о назначениях политик организации по клиентам. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это временная метка или идентификатор, но не обязательно. Клиентские приложения не должны задавать этот параметр. Его должно определять значение ссылки на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
t0 string	Информационный модуль для получения сведений о назначениях политик организации по клиентам. Параметр запроса T0. Начало временного интервала данных. Максимальный период ретроспективного просмотра — 31 день от текущей даты.
timespan float	Информационный модуль для получения сведений о назначениях политик организации по клиентам. Параметр запроса Timespan. Временной интервал, за который будут получены сведения. Если указан timespan, не указывайте параметр t0. Значение задаётся в секундах и не должно превышать 31 день. По умолчанию — 1 день.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить общее число результатов до total_pages*perPage; -1 означает все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _policies _assignments _by _client
  cisco.meraki.organizations_policies_assignments_by_client_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
    t0: string
    timespan: 0
    includeUndetectedClients: true
    networkIds: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / элементы=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"name\": \"string\",\n \"clientId\": \"string\",\n \"mac\": \"string\",\n \"networkId\": \"string\",\n \"assigned\": [\n {\n \"name\": \"string\",\n \"type\": \"string\",\n \"id\": \"string\",\n \"limitTo\": [\n {\n \"appliance\": true,\n \"ssids\": [\n {\n \"number\": 0\n }\n ]\n }\n ]\n }\n ]\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"name\": \"string\",\n \"clientId\": \"string\",\n \"mac\": \"string\",\n \"networkId\": \"string\",\n \"assigned\": [\n {\n \"name\": \"string\",\n \"type\": \"string\",\n \"id\": \"string\",\n \"limitTo\": [\n {\n \"appliance\": true,\n \"ssids\": [\n {\n \"number\": 0\n }\n ]\n }\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_policies_assignments_by_client_info_module.html