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_access строка		Варианты: full none read-only	Права администратора в организации. Псевдонимы: orgAccess
org_id строка			Идентификатор организации.
org_name строка			Название организации. Используется, когда `name` должен ссылаться на другой объект. При создании нового администратора необходимо указать `org_name`, `network`, или `tags`. Псевдонимы: organization
output_level строка		Варианты: debug normal ←	Устанавливает объем отладочной информации во время выполнения модуля.
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
    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 сложный			успех	Список администраторов.
	accountStatus строка		успех	Статус учетной записи. Пример: ok
	email строка		успех	Электронный адрес администратора. Пример: your@email.com
	hasApiKey логическое		успех	Определяет, назначен ли администратору API для его учетной записи.
	id строка		успех	Уникальный идентификационный номер администратора. Пример: 1234567890
	lastActive строка		успех	Дата и время последней активности администратора в панели управления. Пример: 2019-01-28 14:58:56 -0800
	name строка		успех	Имя администратора. Пример: John Doe
	networks сложный		успех	Список сетей, к которым у администратора есть доступ.
		access строка	при установке разрешений сети	Уровень доступа администратора. Доступные значения: 'полный', 'только чтение' или 'нет'. Пример: только чтение
		id строка	при установке разрешений сети	Идентификатор сети. Пример: N_0123456789
	orgAccess строка		успех	Привилегии администратора панели управления в организации. Доступные значения: 'полный', 'только чтение' или 'нет'. Пример: полный
	tags сложный		успех	Теги, к которым у администратора есть доступ.
		access строка	при установке разрешений тегов	Уровень доступа администратора. Доступные значения: 'полный', 'только чтение' или 'нет'. Пример: полный
		tag строка	при установке разрешений тегов	Название тега. Пример: production
	twoFactorAuthEnabled логическое		успех	Состояние включения двухфакторной аутентификации для администратора.

Статус

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Данный модуль поддерживается сообществом 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.8/modules/meraki_admin_module.html