meraki_admin – Управление администраторами в облаке Meraki

Новая версия с 2.6.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_key -			Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды MERAKI_KEY не установлена.
email строка			Адрес электронной почты администратора панели управления. Электронную почту нельзя изменить. Требуется при создании или редактировании администратора.
host строка		По умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki Полезно только для внутренних разработчиков Meraki
name строка			Имя администратора панели управления. Требуется при создании нового администратора.
networks -			Список сетей, на которых у администратора есть права. При создании нового администратора необходимо указать `org_name`, `network`, или `tags`.
	access строка		Права администратора панели управления в сети. Допустимые значения: `full`, `read-only`, или `none`.
	id строка		Идентификатор сети, для которой должны быть назначены права администратора.
org_id строка			Идентификатор организации.
org_name строка			Имя организации. Используется, когда `name` должен ссылаться на другой объект. При создании нового администратора необходимо указать `org_name`, `network`, или `tags`. Псевдонимы: организация
orgAccess строка		Варианты: full none read-only	Права, предоставленные администратору в организации.
output_level -		Варианты: normal ← debug	Установите объем отладочного вывода во время выполнения модуля
state строка / требуется		Варианты: absent present query	Создание или изменение, или удаление организации Если `state` равно `absent`, имя имеет приоритет над email, если оба указаны.
tags -			Теги, на которых у администратора есть права. При создании нового администратора необходимо указать `org_name`, `network`, или `tags`. Если указан `none`, необходимо указать `network` или `tags`.
	access строка		Права администратора панели управления для тега.
	tag строка		Тег объекта, для которого должны быть назначены права.
timeout целое число		По умолчанию: 30	Время ожидания для HTTP-запросов.
use_https булево		Варианты: no yes ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki
use_proxy булево		Варианты: no yes	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
validate_certs булево		Варианты: no yes ←	Подтверждать ли 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
    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
    orgAccess: 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
    orgAccess: 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
    orgAccess: 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			success	Список администраторов.
	accountStatus string		success	Статус учетной записи. Пример: ok
	email string		success	Электронный адрес администратора. Пример: your@email.com
	hasApiKey boolean		success	Определяет, назначен ли администратору API-ключ.
	id string		success	Уникальный идентификационный номер администратора. Пример: 1234567890
	lastActive string		success	Дата и время последней активности администратора в Дэшборде. Пример: 2019-01-28 14:58:56 -0800
	name string		success	Имя администратора. Пример: John Doe
	networks complex		success	Список сетей, к которым имеет доступ администратор.
		access string	при установке разрешений сети	Уровень доступа администратора. Доступные значения: 'full', 'read-only' или 'none'. Пример: read-only
		id string	при установке разрешений сети	Идентификатор сети. Пример: N_0123456789
	orgAccess string		success	Права администратора Дэшборда в организации. Доступные значения: 'full', 'read-only' или 'none'. Пример: full
	tags complex		success	Теги, к которым имеет доступ администратор.
		access string	при установке разрешений тегов	Уровень доступа администратора. Доступные значения: 'full', 'read-only' или 'none'. Пример: full
		tag string	при установке разрешений тегов	Имя тега. Пример: production
	twoFactorAuthEnabled boolean		success	Включен ли двухфакторный аутентификацию для администратора.

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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