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

Примечание

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

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

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно		Ключ аутентификации, предоставленный панелью управления. Обязательно, если переменная среды `MERAKI_KEY` не установлена.
enable_vlans логическое значение	Варианты: no yes	Логическое значение, определяющее, будут ли поддерживаться VLAN в сети. Требуется указать `net_name` или `net_id`.
host строка	По умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число	По умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки.
local_status_page_enabled логическое значение	Варианты: no yes	- Включает локальные страницы состояния устройств (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 строка		Идентификатор сети.
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	Количество секунд для повторной попытки, если срабатывает ограничение скорости.
remote_status_page_enabled логическое значение	Варианты: no yes	Включает доступ к странице состояния устройства (http://device LAN IP). Можно установить только если `local_status_page_enabled:` установлено в `yes`.
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 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 в Ansible 2.13. Пожалуйста, обновите свои книги задач.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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: Enable VLANs on a network
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
        net_name: MyNet
        enable_vlans: yes

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

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

Ключ		Возвращаемое	Описание
data сложное		info	Информация о созданном или обработанном объекте.
	id строка	success	Идентификационная строка сети. Пример: N_12345
	local_status_page_enabled логическое значение	success	Указывает, нужно ли включать страницы my.meraki.com и другие порталы устройств. Пример: True
	name строка	success	Записанное имя сети. Пример: ВашаСеть
	organization_id строка	success	Идентификатор организации, владеющей сетью. Пример: 0987654321
	remote_status_page_enabled логическое значение	success	Включает доступ к странице состояния устройства. Пример: True
	tags список / элементы=строка	success	Теги, разделенные пробелами, назначенные сети. Пример: ['production']
	time_zone строка	success	Часовой пояс, в котором находится сеть. Пример: America/Chicago
	type список / элементы=строка	success	Функциональный тип сети. Пример: ['switch']

Авторы

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.10/collections/cisco/meraki/meraki_network_module.html