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

Примечание

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

Для его установки используйте: 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 строка		ID сети, для которой администратору необходимо назначить привилегии.
	network строка		Имя сети, для которой администратору необходимо назначить привилегии.
org_access строка		Варианты: full none read-only	Привилегии, назначенные администратору в организации. псевдонимы: orgAccess
org_id строка			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	Имя администратора. Пример: Иван Иванов
	networks complex		success	Список сетей, к которым имеет доступ администратор.
		access string	при установке разрешений на сеть	Уровень доступа администратора. Доступные значения: «полный», «только чтение» или «нет». Пример: только чтение
		id string	при установке разрешений на сеть	Идентификатор сети. Пример: N_0123456789
	org_access string		success	Права администратора панели управления на организацию. Доступные значения: «полный», «только чтение» или «нет». Пример: полный
	tags complex		success	Теги, к которым имеет доступ администратор.
		access string	при установке разрешений на теги	Уровень доступа администратора. Доступные значения: «полный», «только чтение» или «нет». Пример: полный
		tag string	при установке разрешений на теги	Имя тега. Пример: производство
	two_factor_auth_enabled boolean		success	Состояние двухфакторной аутентификации для администратора.

Авторы

Кевин Брайт (@kbreit)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/meraki/meraki_admin_module.html