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

Примечание

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

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

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

Чтобы использовать её в playbook, укажите: cisco.meraki.meraki_organization.

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

УСТАРЕВШИЙ

Удалено в:: версии 3.0.0
Причина:: Выпущены обновленные модули с расширенной функциональностью
Альтернатива:: cisco.meraki.organizations

Краткое описание

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

Параметры

Параметр	Комментарии
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды `MERAKI_KEY` не установлена.
clone строка	Организация для клонирования в новую организацию.
delete_confirm строка	ID организации, необходимый для подтверждения перед удалением.
host строка	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повтора попытки, если сервер возвращает внутреннюю ошибку сервера. По умолчанию: `60`
org_id псевдонимы: id строка	ID организации.
org_name псевдонимы: name, organization строка	Название организации. Если указан `clone`, `org_name` — это имя новой организации.
output_format строка	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Устанавливает объем отладочной информации во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time целое число	Количество секунд для повтора попытки, если срабатывает ограничитель скорости. По умолчанию: `165`
state строка	Создать или изменить организацию. `org_id` должен быть указан, если существует несколько организаций с одинаковым именем. `absent` УДАЛИТ ВСЮ ВАШУ ОРГАНИЗАЦИЮ И ВСЕ АССОЦИИРОВАННЫЕ ОБЪЕКТЫ БЕЗ ПОДТВЕРЖДЕНИЯ. ИСПОЛЬЗУЙТЕ С ОСТОРОЖНОСТЬЮ. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
timeout целое число	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https булево	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy булево	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs булево	Проверять ли HTTP-сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Дополнительную информацию об 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. Обновите свои playbook-файлы.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о внесённых изменениях, если конфигурации отличаются, но не отправляет изменения в 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"`

Статус

Этот модуль будет удалён в версии 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_organization_module.html