meraki_network – Управление сетями в облаке Meraki

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно		Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
disable_my_meraki логическое значение добавлено в 2.7	Варианты: нет да	- Отключает страницы статуса локальных устройств (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)). - Взаимоисключающее с `enable_my_meraki`. - Будет устаревшим в Ansible 2.13 в пользу `enable_my_meraki`.
enable_my_meraki логическое значение добавлено в 2.9	Варианты: нет да	- Включает страницы статуса локальных устройств (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)). - В Ansible 2.7 этот параметр был `disable_my_meraki`.
enable_remote_status_page логическое значение добавлено в 2.9	Варианты: нет да	Включает доступ к странице статуса устройства (http://device LAN IP). Может быть задано только если `enable_my_meraki:` установлено в `yes`.
enable_vlans логическое значение добавлено в 2.9	Варианты: нет да	Логическое значение, указывающее, должны ли поддерживаться VLAN на сети. Требует `net_name` или `net_id`.
host строка	По умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, например, в Китае.
internal_error_retry_time целое число	По умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки.
net_id -		Идентификационный номер сети.
net_name -		Имя сети. псевдонимы: name, network
org_id строка		Идентификатор организации.
org_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	Создать или изменить организацию.
tags список		Список тегов для назначения сети. `tags` имя конфликтует с параметром тегов в Ansible. Проблемы с отступами могут привести к неожиданному поведению. Ansible 2.8 преобразует это в список из списка, разделенного запятыми.
timeout целое число	По умолчанию: 30	Время ожидания для HTTP-запросов.
timezone -		Часовой пояс, связанный с сетью. См. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones для получения списка допустимых часовых поясов.
type список	Варианты: appliance switch wireless	Тип устройства сети, которую управляет сеть. Требуется при создании сети. Начиная с Ansible 2.8, `combined` тип больше не поддерживается. Начиная с Ansible 2.8, изменения в этом параметре больше не идемпотентны. псевдонимы: net_type
use_https логическое значение	Варианты: нет да ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логическое значение	Варианты: нет да	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
validate_certs логическое значение	Варианты: нет да ←	Подтверждать ли 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 в Ansible 2.13. Обновите свои playbook'ы.

Примеры

- 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: Enable VLANs on a network
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
        net_name: MyNet
        enable_vlans: yes

Значения возврата

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

Ключ		Возвращаемое значение	Описание
data complex		info	Информация об созданном или изменённом объекте.
	disable_my_meraki_com boolean	success	Указывает, следует ли отключить my.meraki.com и другие порталы устройств. Пример: True
	disableRemoteStatusPage boolean	success	Отключает доступ к странице состояния устройства. Пример: True
	id string	success	Строка идентификации сети. Пример: N_12345
	name string	success	Написанное название сети. Пример: YourNet
	organization_id string	success	Идентификатор организации, владеющей сетью. Пример: 0987654321
	tags string	success	Теги, разделенные пробелами, назначенные сети. Пример: production wireless
	time_zone string	success	Временная зона, в которой находится сеть. Пример: America/Chicago
	type string	success	Функциональный тип сети. Пример: switch

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.9/modules/meraki_network_module.html