Модуль cisco.meraki.meraki_device — управление устройствами в облаке Meraki

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.meraki_device.

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

УСТАРЕЛО

Удалено в:: версии 3.0.0
Причина:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.networks_devices_claim, cisco.meraki.networks_devices_remove и cisco.meraki.networks

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

Просмотр устройств, связанных со средой Meraki.

Параметры

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

Примечания

Примечание

Этот модуль не поддерживает добавление устройств или лицензий в организацию 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.
В Ansible 2.13 модули Meraki в Ansible перестанут поддерживать вывод в стиле camel case. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. В режиме проверки будет сообщено об изменениях, если конфигурации различаются, однако изменения не отправляются в API для проверки.

Примеры

- 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 dictionary	Данные, возвращённые панелью управления Meraki. Возвращается: информация

Статус

Этот модуль будет удалён в версии 3.0.0. [устарело]
Дополнительные сведения см. в разделе УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

© 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_device_module.html