модуль cisco.meraki.meraki_admin — Управление администраторами в облаке Meraki

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.meraki.

Чтобы использовать её в сценарии, укажите: cisco.meraki.meraki_admin.

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

УСТАРЕЛО
Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалено в:: версии 3.0.0
Причина:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.organizations_admins

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

Позволяет создавать администраторов Meraki, управлять ими и просматривать сведения о них.

Параметры

Параметр	Комментарии
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если не задана переменная среды `MERAKI_KEY`.
email string	Адрес электронной почты нельзя изменить. Обязателен при создании или редактировании администратора.
host string	Имя хоста панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд ожидания перед повторной попыткой, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
name string	Имя администратора панели управления. Обязательно при создании администратора.
networks list / элементы=словарь	Список сетей, к которым у администратора есть права доступа. При создании администратора необходимо указать `org_name`, `network` или `tags`.
access string	Уровень доступа администратора панели управления к сети. Допустимые значения: `full`, `read-only` или `none`.
id string	Идентификатор сети, для которой следует назначить права администратора.
network string	Название сети, для которой следует назначить права администратора.
org_access псевдонимы: orgAccess string	Права, назначенные администратору в организации. Варианты: `"full"` `"none"` `"read-only"`
org_id string	Идентификатор организации.
org_name псевдонимы: organization string	Название организации. Используется, когда `name` должно ссылаться на другой объект. При создании администратора необходимо указать `org_name`, `network` или `tags`.
output_format string	Указывает модулю, следует ли использовать в ключах ответа snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задаёт объём отладочных данных, выводимых при выполнении модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time integer	Количество секунд ожидания перед повторной попыткой при срабатывании ограничителя частоты запросов. По умолчанию: `165`
state string / обязательный	Создать, изменить или удалить организацию Если `state` имеет значение `absent`, при указании обоих параметров приоритет имеет имя, а не адрес электронной почты. Варианты: `"absent"` `"present"` `"query"`
tags list / элементы=словарь	Теги, к которым у администратора есть права доступа. При создании администратора необходимо указать `org_name`, `network` или `tags`. Если указан `none`, необходимо указать `network` или `tags`.
access string	Уровень доступа администратора панели управления к тегу.
tag string	Тег объекта, для которого следует назначить права.
timeout integer	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https boolean	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах. Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Проверять ли HTTP-сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Дополнительную информацию об API Meraki можно найти на странице https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, задайте для переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
Поддержка вывода в формате camel case в модулях Meraki Ansible будет прекращена в Ansible 2.13. Обновите свои сценарии.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. В режиме проверки будет сообщено об изменениях, если конфигурации различаются, но изменения не отправляются в API для проверки.

Примеры

- name: Query information about all administrators associated to the organization
  meraki_admin:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Query information about a single administrator by name
  meraki_admin:
    auth_key: abc12345
    org_id: 12345
    state: query
    name: Jane Doe

- name: Query information about a single administrator by email
  meraki_admin:
    auth_key: abc12345
    org_name: YourOrg
    state: query
    email: jane@doe.com

- name: Create new administrator with organization access
  meraki_admin:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    name: Jane Doe
    org_access: read-only
    email: jane@doe.com

- name: Create new administrator with organization access
  meraki_admin:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    name: Jane Doe
    org_access: read-only
    email: jane@doe.com

- name: Create a new administrator with organization access
  meraki_admin:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    name: Jane Doe
    org_access: read-only
    email: jane@doe.com

- name: Revoke access to an organization for an administrator
  meraki_admin:
    auth_key: abc12345
    org_name: YourOrg
    state: absent
    email: jane@doe.com

- name: Create a new administrator with full access to two tags
  meraki_admin:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    name: Jane Doe
    orgAccess: read-only
    email: jane@doe.com
    tags:
      - tag: tenant
        access: full
      - tag: corporate
        access: read-only

- name: Create a new administrator with full access to a network
  meraki_admin:
    auth_key: abc12345
    org_name: YourOrg
    state: present
    name: Jane Doe
    orgAccess: read-only
    email: jane@doe.com
    networks:
      - id: N_12345
        access: full

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

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

Ключ	Описание
data complex	Список администраторов. Возвращается: при успехе
account_status string	Статус учётной записи. Возвращается: при успехе Пример: `"ok"`
email string	Адрес электронной почты администратора. Возвращается: при успехе Пример: `"your@email.com"`
has_api_key boolean	Указывает, назначен ли администратору API в его учётной записи. Возвращается: при успехе Пример: `false`
id string	Уникальный идентификатор администратора. Возвращается: при успехе Пример: `"1234567890"`
last_active string	Дата и время последней активности администратора на панели управления. Возвращается: при успехе Пример: `"2019-01-28 14:58:56 -0800"`
name string	Имя администратора. Возвращается: при успехе Пример: `"John Doe"`
networks complex	Список сетей, к которым у администратора есть доступ. Возвращается: при успехе
access string	Уровень доступа администратора. Допустимые значения: ‘full’, ‘read-only’ или ‘none’. Возвращается: если заданы разрешения для сети Пример: `"read-only"`
id string	Идентификатор сети. Возвращается: если заданы разрешения для сети Пример: `"N_0123456789"`
org_access string	Уровень доступа администратора панели управления к организации. Допустимые значения: ‘full’, ‘read-only’ или ‘none’. Возвращается: при успехе Пример: `"full"`
tags complex	Теги, к которым у администратора есть доступ. Возвращается: при успехе
access string	Уровень доступа администратора. Допустимые значения: ‘full’, ‘read-only’ или ‘none’. Возвращается: если заданы разрешения для тегов Пример: `"full"`
tag string	Название тега. Возвращается: если заданы разрешения для тегов Пример: `"production"`
two_factor_auth_enabled boolean	Состояние двухфакторной аутентификации администратора. Возвращается: при успехе Пример: `false`

Статус

Этот модуль будет удалён в версии 3.0.0. [устарело]
Дополнительные сведения см. в разделе УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

© 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/meraki_admin_module.html