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

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.1.3).

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

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

Добавлен в версии 1.0.0: модуля cisco.meraki

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно			Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения `MERAKI_KEY` не задана.
email строка			Адрес электронной почты администратора панели управления. Адрес электронной почты изменить нельзя. Необходим при создании или редактировании администратора.
host строка		По умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может быть использован для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число		По умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает внутреннюю ошибку сервера.
name строка			Имя администратора панели управления. Требуется при создании нового администратора.
networks список / элементы=словарь			Список сетей, на которых у администратора есть права. При создании нового администратора необходимо указать `org_name`, `network`, или `tags`.
	access строка		Права администратора панели управления в сети. Допустимые значения: `full`, `read-only`, или `none`.
	id строка		Идентификатор сети, для которой администратору должны быть назначены права.
	network строка		Имя сети, для которой администратору должны быть назначены права.
org_access строка		Варианты: full none read-only	Права, назначенные администратору в организации. псевдонимы: orgAccess
org_id строка			Идентификатор организации.
org_name строка			Имя организации. Используется, когда `name` должен ссылаться на другой объект. При создании нового администратора необходимо указать `org_name`, `network`, или `tags`. псевдонимы: organization
output_format строка		Варианты: snakecase ← camelcase	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка		Варианты: debug normal ←	Устанавливает объем отладочной информации во время выполнения модуля.
rate_limit_retry_time целое число		По умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничение скорости.
state строка / обязательно		Варианты: absent present query	Создать или изменить, или удалить организацию Если `state` имеет значение `absent`, имя имеет приоритет над адресом электронной почты, если оба указаны.
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.
Начиная с Ansible 2.9, ключи вывода модулей Meraki возвращаются в формате snake case. Для использования формата camel case установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki Ansible перестанут поддерживать вывод в формате camel case в 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			success	Список администраторов.
	account_status string		success	Статус учетной записи. Пример: ok
	email string		success	Электронный адрес администратора. Пример: your@email.com
	has_api_key boolean		success	Определяет, имеет ли администратор API, назначенный их учетной записи.
	id string		success	Уникальный идентификационный номер администратора. Пример: 1234567890
	last_active string		success	Дата и время последнего входа администратора в Дэшборд. Пример: 2019-01-28 14:58:56 -0800
	name string		success	Имя администратора. Пример: John Doe
	networks complex		success	Список сетей, к которым имеет доступ администратор.
		access string	при установленных разрешениях сети	Уровень доступа администратора. Возможные значения: «полный», «только чтение» или «нет». Пример: только чтение
		id string	при установленных разрешениях сети	Идентификатор сети. Пример: N_0123456789
	org_access string		success	Привилегии администратора Дэшборда в организации. Возможные значения: «полный», «только чтение» или «нет». Пример: полный
	tags complex		success	Теги, к которым имеет доступ администратор.
		access string	при установленных разрешениях по тегам	Уровень доступа администратора. Возможные значения: «полный», «только чтение» или «нет». Пример: полный
		tag string	при установленных разрешениях по тегам	Имя тега. Пример: production
	two_factor_auth_enabled boolean		success	Состояние включения двухфакторной аутентификации для администратора.

Авторы

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.10/collections/cisco/meraki/meraki_admin_module.html