Модуль cisco.meraki.organizations_camera_roles – Модуль ресурсов для ролей камер организаций

Примечание

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

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

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

Для использования в книге задач укажите: cisco.meraki.organizations_camera_roles.

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

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

Описание

Управление операциями создания, обновления и удаления ресурсов ролей камер организаций.
Создание новой роли для этой организации.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
appliedOnDevices список / элементы=словарь	Тег устройства, к которому применяется это разрешение.
id строка	Идентификатор устройства.
inNetworksWithId строка	Диапазон идентификаторов сетей.
inNetworksWithTag строка	Диапазон тегов сетей.
permissionScopeId строка	Идентификатор области разрешений.
tag строка	Тег устройства.
appliedOnNetworks список / элементы=словарь	Тег сети, к которой применяется это разрешение.
id строка	Идентификатор сети.
permissionScopeId строка	Идентификатор области разрешений.
tag строка	Тег сети.
appliedOrgWide список / элементы=словарь	Разрешения, применяемые ко всей организации.
permissionScopeId строка	Идентификатор области разрешений.
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_base_url строка	meraki_base_url (строка), префикс всех ресурсов конечных точек Значение по умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть установлен как переменная окружения BE_GEO_ID Значение по умолчанию: `""`
meraki_caller строка	meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER Значение по умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси Значение по умолчанию: `""`
meraki_inherit_logging_config логический тип	meraki_inherit_logging_config (логический тип), наследует собственный экземпляр логгера Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла лога, дополненное датой и временем Значение по умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для вывода логов; по умолчанию - рабочая директория скрипта, если не указано Значение по умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), максимальное количество попыток повтора при ошибках 429 или других ошибках со стороны сервера Значение по умолчанию: `2`

END_OF_DOCUMENT_MARKER

meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания повторной попытки при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log логический тип	meraki_output_log (логический тип), создать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логический тип	meraki_print_console (логический тип), выводить данные журнала на консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка), прокси-сервер и порт (при необходимости) для HTTPS По умолчанию: `""`
meraki_retry_4xx_error логический тип	meraki_retry_4xx_error (логический тип), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
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` ← (по умолчанию)
name строка	Название новой роли. Должно быть уникальным. Этот параметр обязателен.
organizationId строка	Параметр пути organizationId. Идентификатор организации.

Примечания

Примечание

Используемые методы SDK: camera.Camera.create_organization_camera_role,
Используемые пути: post /organizations/{organizationId}/camera/roles,
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco Meraki по созданию роли камеры createOrganizationCameraRole: Полное описание API createOrganizationCameraRole.

Примеры

- name: Create
  cisco.meraki.organizations_camera_roles:
    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}}"
    state: present
    appliedOnDevices:
    - id: ''
      permissionScopeId: '1'
      tag: reception-desk
    appliedOnNetworks:
    - id: ''
      permissionScopeId: '2'
      tag: building-a
    appliedOrgWide:
    - id: ''
      permissionScopeId: '2'
      tag: building-a
    name: Security_Guard
    organizationId: string

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: `{}`

Авторы

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/organizations_camera_roles_module.html