meraki_device – Управление устройствами в облаке Meraki

Новая версия 2.7.

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

Обзор

Доступ к устройствам, связанным с окружением Meraki.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
address строка		Почтовый адрес местоположения устройства.
auth_key строка / обязательно		Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения `MERAKI_KEY` не задана.
host строка	Значение по умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным окружениям Meraki, таким как Китай.
hostname строка		Имя хоста сетевого устройства для поиска. псевдонимы: name
internal_error_retry_time целое число	Значение по умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает внутреннюю ошибку сервера.
lat число с плавающей запятой		Широта географического местоположения устройства. Используйте отрицательное число для южного полушария. псевдонимы: latitude
lldp_cdp_timespan целое число		Срок, в секундах, используемый для запроса информации LLDP и CDP. Должен быть меньше 1 месяца.
lng число с плавающей запятой		Долгота географического местоположения устройства. Используйте отрицательное число для западного полушария. псевдонимы: longitude
model строка		Модель сетевого устройства для поиска.
move_map_marker булево	Варианты: нет да	Указывает, следует ли устанавливать широту и долготу устройства на основе нового адреса. Применимо только тогда, когда `lat` и `lng` не указаны.
net_id строка		Идентификатор сети.
net_name строка		Имя сети. псевдонимы: network
note строка добавлено в 2.8		Информационные заметки об устройстве. Ограничено 255 символами.
org_id строка		Идентификатор организации.
org_name строка		Название организации. псевдонимы: organization
output_format строка	Варианты: snakecase ← camelcase	Указывает модулю, следует ли использовать ключи ответа в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка	Варианты: отладка обычный ←	Устанавливает количество вывода отладки во время выполнения модуля.
rate_limit_retry_time целое число	Значение по умолчанию: 165	Количество секунд для повторной попытки, если срабатывает ограничение скорости.
serial строка		Серийный номер устройства для запроса.
serial_lldp_cdp строка		Серийный номер устройства для запроса информации LLDP/CDP.
serial_uplink строка		Серийный номер устройства для запроса информации об uplink.
state строка	Варианты: отсутствует присутствует запрос ←	Запрос организации.
tags строка		Список тегов, разделенных пробелами, для назначения устройству.
timeout целое число	Значение по умолчанию: 30	Время ожидания для HTTP-запросов.
use_https булево	Варианты: нет да ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy булево	Варианты: нет да	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
validate_certs булево	Варианты: нет да ←	Подтверждать ли сертификаты HTTP.

Примечания

Примечание

Этот модуль не поддерживает заявку на устройства или лицензии в организацию Meraki.
Дополнительную информацию об API Meraki можно найти на странице https://dashboard.meraki.com/api_docs.
Некоторые из параметров, вероятно, используются только разработчиками внутри Meraki.
Дополнительную информацию об 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'и.

Примеры

- name: Query all devices in an organization.
  meraki_device:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Query all devices in a network.
  meraki_device:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Query a device by serial number.
  meraki_device:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    serial: ABC-123
    state: query
  delegate_to: localhost

- name: Lookup uplink information about a device.
  meraki_device:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    serial_uplink: ABC-123
    state: query
  delegate_to: localhost

- name: Lookup LLDP and CDP information about devices connected to specified device.
  meraki_device:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    serial_lldp_cdp: ABC-123
    state: query
  delegate_to: localhost

- name: Lookup a device by hostname.
  meraki_device:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    hostname: main-switch
    state: query
  delegate_to: localhost

- name: Query all devices of a specific model.
  meraki_device:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    model: MR26
    state: query
  delegate_to: localhost

- name: Update information about a device.
  meraki_device:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    serial: '{{serial}}'
    name: mr26
    address: 1060 W. Addison St., Chicago, IL
    lat: 41.948038
    lng: -87.65568
    tags: recently-added
  delegate_to: localhost

- name: Claim a device into a network.
  meraki_device:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    serial: ABC-123
    state: present
  delegate_to: localhost

- name: Remove a device from a network.
  meraki_device:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    serial: ABC-123
    state: absent
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
response словарь	информация	Данные, возвращенные панелью управления Meraki.

Статус

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