модуль cisco.meraki.organizations_sm_admins_roles_info — информационный модуль для organizations _sm _admins _roles

Примечание

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

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

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

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

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

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

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

Информационный модуль для Organizations Sm Admins Roles Info.
Получение всех organizations _sm _admins _roles.
Вывод ограниченных ролей доступа для организации.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string) — направление постраничной навигации: страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для Organizations Sm Admins Roles Info. Параметр запроса 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` ← (по умолчанию)
organizationId string	Информационный модуль для Organizations Sm Admins Roles Info. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для Organizations Sm Admins Roles Info. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон — от 3 до 1000. Значение по умолчанию — 50.
startingAfter string	Информационный модуль для Organizations Sm Admins Roles Info. Параметр запроса StartingAfter. Токен, с помощью которого сервер указывает начало страницы. Обычно это временная метка или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages string / обязательный	total_pages(int) — используйте вместе с perPage, чтобы получить все результаты до total_pages*perPage; значение -1 означает все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _sm _admins _roles
  cisco.meraki.organizations_sm_admins_roles_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
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: `{"items": [{"name": "string", "roleId": "string", "scope": "string", "tags": ["string"]}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}`

Авторы

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_sm_admins_roles_info_module.html