cisco.meraki.meraki_organization – Управление организациями в облаке Meraki

Примечание

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

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

Для использования в книге задач укажите: cisco.meraki.meraki_organization.

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно		Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
clone строка		Организация, которую нужно клонировать в новую организацию.
delete_confirm строка		Идентификатор организации, необходимый для подтверждения перед удалением.
host строка	По умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число	По умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней ошибки.
org_id строка		Идентификатор организации. псевдонимы: id
org_name строка		Название организации. Если `clone` указано, `org_name` — это имя новой организации. псевдонимы: name, 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	Создание или изменение организации. `org_id` должен быть указан, если существуют несколько организаций с одинаковым именем. `absent` УДАЛИТ ВСЮ ВАШУ ОРГАНИЗАЦИЮ И ВСЕ СВЯЗАННЫЕ ОБЪЕКТЫ БЕЗ ПОДТВЕРЖДЕНИЯ. ИСПОЛЬЗУЙТЕ С ОСТОРОЖНОСТЬЮ.
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 output в Ansible 2.13. Обновите свои книги задач.
Режим проверки скачивает текущую конфигурацию с панели управления, а затем сравнивает изменения с этим скачиванием. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в API для проверки изменения.

Примеры

- name: Create a new organization named YourOrg
  meraki_organization:
    auth_key: abc12345
    org_name: YourOrg
    state: present
  delegate_to: localhost

- name: Delete an organization named YourOrg
  meraki_organization:
    auth_key: abc12345
    org_name: YourOrg
    state: absent
  delegate_to: localhost

- name: Query information about all organizations associated to the user
  meraki_organization:
    auth_key: abc12345
    state: query
  delegate_to: localhost

- name: Query information about a single organization named YourOrg
  meraki_organization:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Rename an organization to RenamedOrg
  meraki_organization:
    auth_key: abc12345
    org_id: 987654321
    org_name: RenamedOrg
    state: present
  delegate_to: localhost

- name: Clone an organization named Org to a new one called ClonedOrg
  meraki_organization:
    auth_key: abc12345
    clone: Org
    org_name: ClonedOrg
    state: present
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ		Возвращаемое значение	Описание
data сложное		успех	Информация об организации, которая была создана или изменена
	id целое число	успех	Уникальный идентификатор организации Пример: 2930418
	name строка	успех	Имя организации Пример: YourOrg

Авторы

Kevin Breit (@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_organization_module.html