модуль cisco.meraki.meraki_network — управление сетями в облаке Meraki
Примечание
Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki.
Чтобы использовать её в плейбуке, укажите: cisco.meraki.meraki_network.
УСТАРЕЛО
- Удалён в:
-
версии 3.0.0
- Причина:
-
Выпущены обновлённые модули с расширенными возможностями
- Альтернатива:
-
cisco.meraki.networks
Краткое описание
- Позволяет создавать сети Meraki, управлять ими и просматривать информацию о них.
Параметры
Параметр | Комментарии |
|---|---|
auth_key string / обязательный | Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды |
copy_from_network_id string | Новая сеть наследует свойства сети с этим идентификатором. Другие указанные параметры переопределят скопированную конфигурацию. Тип должен точно совпадать с типом этой сети. |
enable_vlans boolean | Логическое значение, указывающее, следует ли поддерживать VLAN в сети. Необходимо указать Варианты:
|
host string | Имя узла панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: |
internal_error_retry_time integer | Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку сервера. По умолчанию: |
local_status_page_enabled boolean | - Этот параметр больше не работает и, вероятно, будет перенесён в отдельный модуль. - Включает локальные страницы состояния устройств (U[my.meraki.com](my.meraki.com), U[ap.meraki.com](ap.meraki.com), U[switch.meraki.com](switch.meraki.com), U[wired.meraki.com](wired.meraki.com)). - Можно указать только отдельно или вместе с Варианты:
|
net_id string | Идентификатор сети. |
net_name псевдонимы: name, network string | Название сети. |
org_id string | Идентификатор организации. |
org_name псевдонимы: organization string | Название организации. |
output_format string | Указывает модулю, должны ли ключи ответа быть в формате snake case (например, Варианты:
|
output_level string | Задаёт объём отладочных данных во время выполнения модуля. Варианты:
|
rate_limit_retry_time integer | Количество секунд до повторной попытки, если сработало ограничение частоты запросов. По умолчанию: |
remote_status_page_enabled boolean | Этот параметр больше не работает и, вероятно, будет перенесён в отдельный модуль. Включает доступ к странице состояния устройства (http://device LAN IP). Можно задать, только если для Можно указать только отдельно или вместе с Варианты:
|
state string | Создать или изменить организацию. Варианты:
|
tags list / элементы=string | Список тегов, назначаемых сети. Имя Ansible 2.8 преобразует этот параметр в список из строки, разделённой запятыми. |
timeout integer | Время ожидания для HTTP-запросов до истечения тайм-аута. По умолчанию: |
timezone string | Часовой пояс, связанный с сетью. Список допустимых часовых поясов см. на странице https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. |
type псевдонимы: net_type list / элементы=string | Тип сети устройств, управляемых сетью. Обязателен при создании сети. Начиная с Ansible 2.8, тип Начиная с Ansible 2.8, изменения этого параметра больше не являются идемпотентными. Варианты:
|
use_https boolean | Если Полезно только для внутренних разработчиков Meraki. Варианты:
|
use_proxy boolean | Если Варианты:
|
validate_certs boolean | Проверять ли сертификаты HTTP. Варианты:
|
Примечания
Примечание
- Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
- Некоторые параметры, вероятно, используются только разработчиками Meraki.
- Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, задайте переменной среды
ANSIBLE_MERAKI_FORMATзначениеcamelcase. - В Ansible 2.13 модули Meraki в Ansible перестанут поддерживать вывод в формате camel case. Обновите свои плейбуки.
- Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. В режиме проверки будет сообщено об изменениях, если конфигурации различаются, но изменения не отправляются в API для проверки.
Примеры
- delegate_to: localhost
block:
- name: List all networks associated to the YourOrg organization
meraki_network:
auth_key: abc12345
state: query
org_name: YourOrg
- name: Query network named MyNet in the YourOrg organization
meraki_network:
auth_key: abc12345
state: query
org_name: YourOrg
net_name: MyNet
- name: Create network named MyNet in the YourOrg organization
meraki_network:
auth_key: abc12345
state: present
org_name: YourOrg
net_name: MyNet
type: switch
timezone: America/Chicago
tags: production, chicago
- name: Create combined network named MyNet in the YourOrg organization
meraki_network:
auth_key: abc12345
state: present
org_name: YourOrg
net_name: MyNet
type:
- switch
- appliance
timezone: America/Chicago
tags: production, chicago
- name: Create new network based on an existing network
meraki_network:
auth_key: abc12345
state: present
org_name: YourOrg
net_name: MyNet
type:
- switch
- appliance
copy_from_network_id: N_1234
- name: Enable VLANs on a network
meraki_network:
auth_key: abc12345
state: query
org_name: YourOrg
net_name: MyNet
enable_vlans: true
- name: Modify local status page enabled state
meraki_network:
auth_key: abc12345
state: query
org_name: YourOrg
net_name: MyNet
local_status_page_enabled: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь; далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
data complex | Информация о созданном или изменённом объекте. Возвращается: info |
|
id string |
Идентификатор сети. Возвращается: success Пример: |
|
local_status_page_enabled boolean |
Указывает, должны ли быть включены my.meraki.com и другие порталы устройств. Возвращается: success Пример: |
|
name string |
Заданное название сети. Возвращается: success Пример: |
|
organization_id string |
Идентификатор организации, которой принадлежит сеть. Возвращается: success Пример: |
|
remote_status_page_enabled boolean |
Включает доступ к странице состояния устройства. Возвращается: success Пример: |
|
tags list / элементы=string |
Теги, назначенные сети и разделённые пробелами. Возвращается: success Пример: |
|
time_zone string |
Часовой пояс сети. Возвращается: success Пример: |
|
type list / элементы=string |
Функциональный тип сети. Возвращается: success Пример: |
Статус
- Этот модуль будет удалён в версии 3.0.0. [устарело]
- Дополнительную информацию см. в разделе УСТАРЕЛО.
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/meraki_network_module.html