Spec-Zone.ru › Ansible 2.8

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

Новое в версии 2.6.

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
auth_key
строка
Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения MERAKI_KEY не задана.
clone
-
Организация для клонирования в новую организацию.
host
строка
По умолчанию:
"api.meraki.com"
Имя хоста панели управления Meraki.
Может использоваться для доступа к региональным средам Meraki, таким как Китай.
org_id
целое число
Идентификатор организации.

псевдонимы: id
org_name
строка
Название организации.
Если указан clone, org_name — название новой организации.

псевдонимы: name, организация
output_level
строка
    Варианты:
  • debug
  • normal ←
Устанавливает объем отладочной информации при выполнении модуля.
state
-
    Варианты:
  • present ←
  • query
Создание или изменение организации.
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: Create a new organization named YourOrg
  meraki_organization:
    auth_key: abc12345
    org_name: YourOrg
    state: present
  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
строка
успех
Название организации

Пример:
ВашаОрганизация


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом 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_organization_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API