Модуль cisco.meraki.organizations_admins — Модуль ресурсов для администраторов организаций
Примечание
Этот модуль является частью коллекции cisco.meraki (версия 2.18.2).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в playbook укажите: cisco.meraki.organizations_admins.
Новая функция в cisco.meraki 2.16.0
Описание
- Управление операциями создания, обновления и удаления ресурсов администраторов организаций.
- Создание нового администратора панели управления.
- Отзыв всех прав доступа для администратора панели управления в рамках этой организации.
- Обновление администратора.
Примечание
Для этого модуля имеется соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
adminId string | Параметр пути AdminId. ID администратора. |
authenticationMethod string | Метод аутентификации, который пользователь будет использовать для входа в панель управления Meraki. Может быть одним из «Email» или «Cisco SecureX Sign-On». По умолчанию используется аутентификация по электронной почте. |
string | Электронная почта администратора панели управления. Этот атрибут нельзя обновить. |
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий Default: |
meraki_api_key string / required | meraki_api_key (string), API ключ, сгенерированный на панели управления; также может быть установлен как переменная окружения MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (string), предшествует всем ресурсам конечной точки Default: |
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:
|
meraki_log_file_prefix string | meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени Default: |
meraki_log_path string | log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иное Default: |
meraki_maximum_retries integer | meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: |
meraki_nginx_429_retry_wait_time integer | meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки Nginx 429 Default: |
meraki_output_log boolean | meraki_output_log (boolean), создать файл выходного журнала? Choices:
|
meraki_print_console boolean | meraki_print_console (boolean), выводить выходные данные журнала на консоль? Choices:
|
meraki_requests_proxy string | meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: |
meraki_retry_4xx_error boolean | meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Choices:
|
meraki_retry_4xx_error_wait_time integer | meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки при других ошибках 4XX Default: |
meraki_simulate boolean | meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Варианты:
|
meraki_single_request_timeout integer | meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: |
meraki_suppress_logging boolean | meraki_suppress_logging (boolean), отключить всю запись в журнал? Тогда на вас все ложится! Варианты:
|
meraki_use_iterator_for_get_pages boolean | meraki_use_iterator_for_get_pages (boolean), методы list* вернут итератор с каждым объектом вместо полного списка со всеми элементами Варианты:
|
meraki_wait_on_rate_limit boolean | meraki_wait_on_rate_limit (boolean), повторить попытку при возникновении ошибки ограничения скорости 429? Варианты:
|
name string | Имя администратора панели управления. |
networks list / elements=dictionary | Список сетей, на которых у администратора панели управления есть права. |
|
access string |
Права администратора панели управления в сети. Может быть одним из следующих значений: «полный», «только чтение», «гостевой посол» или «только мониторинг». |
|
id string |
Идентификатор сети. |
orgAccess string | Права администратора панели управления в организации. Может быть одним из следующих значений: «полный», «только чтение», «предприятие» или «нет». |
organizationId string | Параметр пути organizationId. Идентификатор организации. |
tags list / elements=dictionary | Список тегов, на которых у администратора панели управления есть права. |
|
access string |
Права администратора панели управления на тег. Может быть одним из следующих значений: «полный», «только чтение», «гостевой посол» или «только мониторинг». |
|
tag string |
Название тега. |
Примечания
Примечание
- Используемые методы SDK: organizations.Organizations.create_organization_admin, organizations.Organizations.delete_organization_admin, organizations.Organizations.update_organization_admin,
- Используемые пути: post /organizations/{organizationId}/admins, delete /organizations/{organizationId}/admins/{adminId}, put /organizations/{organizationId}/admins/{adminId},
- Не поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения
См. также
См. также
- Документация Cisco Meraki по созданию администратора организации
-
Полное описание API createOrganizationAdmin.
- Документация Cisco Meraki по удалению администратора организации
-
Полное описание API deleteOrganizationAdmin.
- Документация Cisco Meraki по обновлению администратора организации
-
Полное описание API updateOrganizationAdmin.
Примеры
- name: Create
cisco.meraki.organizations_admins:
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
authenticationMethod: Email
email: miles@meraki.com
name: Miles Meraki
networks:
- access: full
id: N_24329156
orgAccess: none
organizationId: string
tags:
- access: read-only
tag: west
- name: Delete by id
cisco.meraki.organizations_admins:
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: absent
adminId: string
organizationId: string
- name: Update by id
cisco.meraki.organizations_admins:
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
adminId: string
name: Miles Meraki
networks:
- access: full
id: N_24329156
orgAccess: none
organizationId: string
tags:
- access: read-only
tag: west
Значения возврата
Общие значения возврата описаны в здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meraki_response словарь | Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: |
Ссылки на сборки
© 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_admins_module.html