blob: 2e17ef2cead90d43c091eb4cec4b5853f71c1793 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: devices
short_description: Resource module for devices
description:
- Manage operation update of the resource devices.
- Update the attributes of a device.
version_added: '2.16.0'
extends_documentation_fragment:
- cisco.meraki.module
author: Francisco Munoz (@fmunoz)
options:
address:
description: The address of a device.
type: str
floorPlanId:
description: The floor plan to associate to this device. Null disassociates the
device from the floorplan.
type: str
lat:
description: The latitude of a device.
type: float
lng:
description: The longitude of a device.
type: float
moveMapMarker:
description: Whether or not to set the latitude and longitude of a device based
on the new address. Only applies when lat and lng are not specified.
type: bool
name:
description: The name of a device.
type: str
notes:
description: The notes for the device. String. Limited to 255 characters.
type: str
serial:
description: Devices's serial.
type: str
switchProfileId:
description: The ID of a switch profile to bind to the device (for available switch
profiles, see the 'Switch Profiles' endpoint). Use null to unbind the switch device
from the current profile. For a device to be bindable to a switch profile, it
must (1) be a switch, and (2) belong to a network that is bound to a configuration
template.
type: str
tags:
description: The list of tags of a device.
elements: str
type: list
requirements:
- meraki >= 2.4.9
- python >= 3.5
seealso:
- name: Cisco Meraki documentation for devices updateDevice
description: Complete reference of the updateDevice API.
link: https://developer.cisco.com/meraki/api-v1/#!update-device
notes:
- SDK Method used are
devices.Devices.update_device,
- Paths used are
put /devices/{serial},
"""
EXAMPLES = r"""
- name: Update by id
cisco.meraki.devices:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
lat: 37.4180951010362
lng: -122.098531723022
mac: 00:11:22:33:44:55
name: My AP
serial: Q234-ABCD-5678
tags:
- recently-added
"""
RETURN = r"""
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki Python SDK
returned: always
type: dict
sample: >
{}
"""
|
