cisco.meraki.meraki_device 模块 – 管理 Meraki 云中的设备

注意

此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。

如果您使用的是 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 字符串	设备位置的邮政地址。
auth_key 字符串 / 必需	仪表盘提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
host 字符串	Meraki 仪表盘的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
hostname 别名：name 字符串	要搜索的网络设备的主机名。
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
lat 别名：latitude 浮点数	设备地理位置的纬度。 南半球使用负数。
lldp_cdp_timespan 整数	用于查询 LLDP 和 CDP 信息的时间跨度（秒）。 必须小于 1 个月。
lng 别名：longitude 浮点数	设备地理位置的经度。 西半球使用负数。
model 字符串	要搜索的网络设备的型号。
move_map_marker 布尔值	是否根据新地址设置设备的纬度和经度。 仅当未指定 lat 和 lng 时适用。 选项 false true
net_id 字符串	网络 ID。
net_name 别名：network 字符串	网络名称。
note 字符串	关于设备的信息性备注。 限制为 255 个字符。
org_id 字符串	组织 ID。
org_name 别名：organization 字符串	组织名称。
output_format 字符串	指示模块响应键应该是蛇形命名法 (例如 net_id) 还是驼峰命名法 (例如 netId)。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
query 字符串	指定应查询哪些信息。 选项 "lldp_cdp" "uplink"
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
serial 字符串	要查询的设备的序列号。
state 字符串	查询组织。 选项 "absent" "present" "query" ← (默认)
tags 列表 / 元素=字符串	要分配给设备的以空格分隔的标签列表。
timeout 整数	HTTP 请求的超时时间。 默认值： 30
use_https 布尔值	如果为 no，则使用 HTTP。否则，将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为 no，则即使在目标主机上定义了环境变量中的代理，也不会使用代理。 选项 false ← (默认) true
validate_certs 布尔值	是否验证HTTP证书。 选项 false true ← (默认)

备注

注意

• 此模块不支持将设备或许可证添加到Meraki组织。

• 有关Meraki API的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供Meraki内部开发人员使用。

• 有关Meraki API的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供Meraki内部开发人员使用。

• 从Ansible 2.9开始，Meraki模块将键输出为蛇形命名法。若要使用驼峰命名法，请将ANSIBLE_MERAKI_FORMAT环境变量设置为camelcase。

• Ansible的Meraki模块将在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仪表板返回的数据。 返回： info

状态

• 此模块将在3.0.0版本中删除。[已弃用]

• 更多信息请参见已弃用。

作者

• Kevin Breit (@kbreit)

资源链接

• 问题跟踪器
• 代码库（源代码）