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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki.

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

Новая в cisco.meraki 1.0.0

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

УСТАРЕВШЕ

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

Описание

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

Параметры

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

Статус

Этот модуль будет удален в версии 3.0.0. [устарел]
Дополнительная информация см. в разделе УСТАРЕВШЕЕ.

Авторы

Kevin Breit (@kbreit)

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

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