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

Примечание

Этот модуль является частью коллекции cisco.meraki (версия 2.18.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 / required	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не установлена.
host string	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай. Default: `"api.meraki.com"`
hostname aliases: name string	Имя хоста сетевого устройства для поиска.
internal_error_retry_time integer	Количество секунд для повторной попытки, если сервер возвращает внутреннюю ошибку сервера. Default: `60`
lat aliases: latitude float	Широта географического местоположения устройства. Используйте отрицательное число для южного полушария.
lldp_cdp_timespan integer	Временной интервал, в секундах, используемый для запроса информации LLDP и CDP. Должен быть меньше 1 месяца.
lng aliases: longitude float	Долгота географического местоположения устройства. Используйте отрицательное число для западного полушария.
model string	Модель сетевого устройства для поиска.
move_map_marker boolean	Устанавливать ли широту и долготу устройства на основе нового адреса. Применяется только тогда, когда `lat` и `lng` не указаны. Choices: `false` `true`
net_id string	Идентификатор сети.
net_name aliases: network string	Название сети.
note string	Информационные заметки об устройстве. Ограничено 255 символами.
org_id string	Идентификатор организации.
org_name aliases: organization string	Название организации.
output_format string	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`). Choices: `"snakecase"` ← (default) `"camelcase"`
output_level string	Установите объем отладочного вывода во время выполнения модуля. Choices: `"debug"` `"normal"` ← (default)
query string	Указывает, какая информация должна быть запрошена. Choices: `"lldp_cdp"` `"uplink"`
rate_limit_retry_time integer	Количество секунд для повторной попытки, если срабатывает ограничитель скорости. Default: `165`
serial string	Серийный номер устройства для запроса.
state string	Запрос организации. Choices: `"absent"` `"present"` `"query"` ← (default)
tags list / elements=string	Список тегов, разделенных пробелами, для присвоения устройству.

timeout целое число	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https булево	Если `no`, будет использоваться HTTP. В противном случае — HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy булево	Если `no`, прокси не будет использоваться, даже если она определена в переменной окружения на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs булево	Подтверждать ли 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. Чтобы использовать camelCase, установите переменную окружения ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki Ansible перестанут поддерживать вывод camelCase в Ansible 2.13. Пожалуйста, обновите свои playbook.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправит изменения в 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 словарь	Данные, возвращённые панелью управления Meraki. Возвращаемые данные: информация

Статус

Этот модуль будет удален в версии 3.0.0. [устарел]
Дополнительную информацию см. в разделе УСТАРЕВШИЙ.

Авторы

Kevin Breit (@kbreit)

Ссылки на сборки

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_device_module.html