meraki_admin — Управление администраторами в облаке Meraki
Новая версия 2.6.
Обзор
- Позволяет создавать, управлять и контролировать доступ администраторов в Meraki.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth_key | Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды MERAKI_KEY не задана. | |
| Электронный адрес администратора панели управления. Электронный адрес не может быть изменён. Требуется при создании или редактировании администратора. | ||
| host строка | По умолчанию: "api.meraki.com" | Имя хоста для панели управления Meraki Полезно только для внутренних разработчиков Meraki |
| name | Имя администратора панели управления. Требуется при создании нового администратора. | |
| networks | Список сетей, к которым у администратора есть права доступа. При создании нового администратора необходимо указать org_name, network, или tags. | |
| org_id | Идентификатор организации. | |
| org_name | Название организации. Используется, когда name должен ссылаться на другой объект.При создании нового администратора необходимо указать org_name, network, или tags. псевдонимы: организация | |
| orgAccess |
| Права доступа администратора в организации. |
| output_level |
| Устанавливает уровень вывода отладки во время выполнения модуля |
| state обязательно |
| Создание или изменение организации |
| tags | Теги, к которым у администратора есть права доступа. При создании нового администратора необходимо указать org_name, network, или tags. Если none указан, необходимо указать network или tags. | |
| timeout целое число | По умолчанию: 30 | Время ожидания для HTTP-запросов. |
| use_https булево |
| Если no, будет использоваться HTTP. В противном случае будет использоваться HTTPS.Полезно только для внутренних разработчиков Meraki |
| use_proxy булево |
| Если no, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. |
| validate_certs булево |
| Требовать валидацию сертификатов HTTP. |
Примечания
Примечание
- Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
- Некоторые параметры, вероятно, используются только внутренними разработчиками Meraki.
Примеры
- name: Query information about all administrators associated to the organization
meraki_admin:
auth_key: abc12345
state: query
delegate_to: localhost
- name: Query information about a single administrator by name
meraki_admin:
auth_key: abc12345
state: query
name: Jane Doe
- name: Query information about a single administrator by email
meraki_admin:
auth_key: abc12345
state: query
email: jane@doe.com
- name: new administrator with organization access
meraki_admin:
auth_key: abc12345
state: present
name: Jane Doe
orgAccess: read-only
email: jane@doe.com
- name: Create a new administrator with organization access
meraki_admin:
auth_key: abc12345
state: present
name: Jane Doe
orgAccess: read-only
email: jane@doe.com
- name: Revoke access to an organization for an administrator
meraki_admin:
auth_key: abc12345
state: absent
email: jane@doe.com
Возвращаемые значения
Общие возвращаемые значения описаны здесь, а следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| data сложное | успех | Список администраторов. | ||
| email строка | успех | Электронный адрес администратора. Пример: your@email.com | ||
| id строка | успех | Уникальный идентификатор администратора. Пример: 1234567890 | ||
| name строка | успех | Имя администратора. Пример: Иванов Иван | ||
| networks сложное | успех | Список сетей, к которым имеет доступ администратор. | ||
| id строка | при установке сетевых разрешений | Идентификатор сети. Пример: N_0123456789 | ||
| access строка | при установке сетевых разрешений | Уровень доступа администратора. Доступные значения: «полный», «только чтение» или «отсутствует». Пример: только чтение | ||
| tags сложное | успех | Теги, к которым имеет доступ администратор. | ||
| tag строка | при установке разрешений по тегам | Имя тега. Пример: производство | ||
| access строка | при установке разрешений по тегам | Уровень доступа администратора. Доступные значения: «полный», «только чтение» или «отсутствует». Пример: полный | ||
| orgAccess строка | успех | Права администратора на организацию. Доступные значения: «полный», «только чтение» или «отсутствует». Пример: полный | ||
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробнее см. Поддержка и обслуживание модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Kevin Breit (@kbreit)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/meraki_admin_module.html
