Модуль cisco.meraki.organizations_saml_roles — модуль ресурсов для organizations _samlroles

Примечание

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

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

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

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

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

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

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

Управление операциями создания, обновления и удаления ресурса organizations _samlroles.
Создание роли SAML.
Удаление роли SAML.
Обновление роли SAML.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
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` ← (по умолчанию)
networks list / elements=dictionary	Список сетей, к которым администратор SAML имеет доступ.
access string	Уровень доступа администратора SAML к сети. Допустимые значения: ‘full’, ‘read-only’, ‘guest-ambassador’, ‘monitor-only’, ‘ssid-admin’ или ‘port-tags’, либо пользовательская роль в формате custom-role ID.
id string	Идентификатор сети.
orgAccess string	Уровень доступа администратора SAML к организации. Допустимые значения: ‘none’, ‘read-only’, ‘full’ или ‘enterprise’, либо пользовательская роль в формате custom-role ID NAME.
organizationId string	Параметр пути OrganizationId. Идентификатор организации.
role string	Роль администратора SAML.
samlRoleId string	Параметр пути SamlRoleId. Идентификатор роли SAML.
tags list / elements=dictionary	Список тегов, к которым администратор SAML имеет доступ.
access string	Уровень доступа администратора SAML к тегу. Допустимые значения: ‘full’, ‘read-only’, ‘guest-ambassador’ или ‘monitor-only’, либо пользовательская роль в формате custom-role ID.
tag string	Имя тега.

Примечания

Примечание

Используемые методы SDK: organizations.Organizations.create_organization_saml_role, organizations.Organizations.delete_organization_saml_role, organizations.Organizations.update_organization_saml_role,
Используемые пути: post /organizations/{organizationId}/samlRoles, delete /organizations/{organizationId}/samlRoles/{samlRoleId}, put /organizations/{organizationId}/samlRoles/{samlRoleId},
Не поддерживает check_mode
Модуль выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный менеджер подключений
из Python SDK Cisco Dashboard API
Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установки подключения

См. также

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

Примеры

- name: Create
  cisco.meraki.organizations_saml_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
    networks:
      - access: full
        id: N_24329156
    orgAccess: none
    organizationId: string
    role: myrole
    tags:
      - access: read-only
        tag: west
- name: Update by id
  cisco.meraki.organizations_saml_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
    networks:
      - access: full
        id: N_24329156
    orgAccess: none
    organizationId: string
    role: myrole
    samlRoleId: string
    tags:
      - access: read-only
        tag: west
- name: Delete by id
  cisco.meraki.organizations_saml_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: absent
    organizationId: string
    samlRoleId: string

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: `{"camera": [{"access": "string", "orgWide": true}], "id": "string", "networks": [{"access": "string", "id": "string"}], "orgAccess": "string", "role": "string", "tags": [{"access": "string", "tag": "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_saml_roles_module.html