Модуль cisco.meraki.organizations_sm_admins_roles — модуль ресурса для 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.

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

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

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

Управление операциями создания, обновления и удаления ресурса organizations _sm _admins _roles.
Создание роли с ограниченным доступом.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
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 (строка), базовый URL, предшествующий всем конечным точкам ресурсов По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также можно задать в переменной окружения BE_GEO_ID По умолчанию: `""`
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`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повторной попыткой после ошибки 429 от Nginx По умолчанию: `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. Идентификатор организации.
scope строка	Область действия роли с ограниченным доступом.
tags список / элементы=строка	Теги роли с ограниченным доступом.

Примечания

Примечание

Используемый метод SDK: sm.Sm.create_organization_sm_admins_role,
Используемые пути: post /organizations/{organizationId}/sm/admins/roles,
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный диспетчер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco Meraki для sm createOrganizationSmAdminsRole: Полный справочник по API createOrganizationSmAdminsRole.

Примеры

- name: Create
  cisco.meraki.organizations_sm_admins_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_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: present
    name: sample name
    organizationId: string
    scope: all_tags
    tags:
      - tag

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

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

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

Авторы

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