Модуль cisco.meraki.organizations_camera_roles_info — Информационный модуль для ролей камер организаций

Примечание

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

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

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

Для использования в playbook укажите: cisco.meraki.organizations_camera_roles_info.

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

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

Описание

Получить все роли камер организаций.
Вывести список всех ролей в этой организации.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий Default: `60`
meraki_api_key string / required	meraki_api_key (string), API ключ, сгенерированный на панели управления; может также быть установлен как переменная окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем ресурсам конечной точки Default: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная окружения BE_GEO_ID Default: `""`
meraki_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER Default: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследует собственный экземпляр регистратора Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала, к которому добавляются дата и метка времени Default: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иное Default: `""`
meraki_maximum-retries integer	meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки для ошибки Nginx 429 Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл выходного журнала? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), выводить выходные данные журнала на консоль? Choices: `false` `true` ← (default)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Choices: `false` ← (default) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки при других ошибках 4XX Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Choices: `false` ← (default) `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` ← (по умолчанию)
organizationId строка	Параметр пути OrganizationId. Идентификатор организации.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _camera _roles
  cisco.meraki.organizations_camera_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_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    organizationId: string
  register: result

Значения возврата

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список со значением, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: "[\n {\n \"appliedOnDevices\": [\n {\n \"id\": \"string\",\n \"permissionLevel\": \"string\",\n \"permissionScope\": \"string\",\n \"permissionScopeId\": \"string\",\n \"tag\": \"string\"\n }\n ],\n \"appliedOnNetworks\": [\n {\n \"id\": \"string\",\n \"permissionLevel\": \"string\",\n \"permissionScope\": \"string\",\n \"permissionScopeId\": \"string\",\n \"tag\": \"string\"\n }\n ],\n \"appliedOrgWide\": [\n {\n \"permissionLevel\": \"string\",\n \"permissionScope\": \"string\",\n \"permissionScopeId\": \"string\",\n \"tag\": \"string\"\n }\n ],\n \"name\": \"string\"\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"appliedOnDevices\": [\n {\n \"id\": \"string\",\n \"permissionLevel\": \"string\",\n \"permissionScope\": \"string\",\n \"permissionScopeId\": \"string\",\n \"tag\": \"string\"\n }\n ],\n \"appliedOnNetworks\": [\n {\n \"id\": \"string\",\n \"permissionLevel\": \"string\",\n \"permissionScope\": \"string\",\n \"permissionScopeId\": \"string\",\n \"tag\": \"string\"\n }\n ],\n \"appliedOrgWide\": [\n {\n \"permissionLevel\": \"string\",\n \"permissionScope\": \"string\",\n \"permissionScopeId\": \"string\",\n \"tag\": \"string\"\n }\n ],\n \"name\": \"string\"\n }\n]\n"

Авторы

Франсиско Муньос (@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/organizations_camera_roles_info_module.html