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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
#!/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: networks_info
short_description: Information module for networks
description:
- Get all networks.
- Get networks by id.
- List the networks that the user has privileges on in an organization.
- Return a network.
version_added: '2.16.0'
extends_documentation_fragment:
- cisco.meraki.module_info
- cisco.meraki.module_info_pagination
author: Francisco Munoz (@fmunoz)
options:
headers:
description: Additional headers.
type: dict
networkId:
description:
- NetworkId path parameter. Network ID.
type: str
organizationId:
description:
- OrganizationId path parameter. Organization ID.
type: str
configTemplateId:
description:
- >
ConfigTemplateId query parameter. An optional parameter that is the ID of a config template. Will return all
networks bound to that template.
type: str
isBoundToConfigTemplate:
description:
- >
IsBoundToConfigTemplate query parameter. An optional parameter to filter config template bound networks. If
configTemplateId is set, this cannot be false.
type: bool
tags:
description:
- >
Tags query parameter. An optional parameter to filter networks by tags. The filtering is case-sensitive. If
tags are included, 'tagsFilterType' should also be included (see below).
elements: str
type: list
tagsFilterType:
description:
- >
TagsFilterType query parameter. An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate
whether to return networks which contain ANY or ALL of the included tags. If no type is included,
'withAnyTags' will be selected.
type: str
perPage:
description:
- PerPage query parameter. The number of entries per page returned. Acceptable range is 3 - 100000. Default is 1000.
type: int
startingAfter:
description:
- >
StartingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a
timestamp or an ID but it is not limited to those. This parameter should not be defined by client
applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
type: str
endingBefore:
description:
- >
EndingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a
timestamp or an ID but it is not limited to those. This parameter should not be defined by client
applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
type: str
requirements:
- meraki >= 2.4.9
- python >= 3.5
seealso:
- name: Cisco Meraki documentation for networks getNetwork
description: Complete reference of the getNetwork API.
link: https://developer.cisco.com/meraki/api-v1/#!get-network
- name: Cisco Meraki documentation for networks getOrganizationNetworks
description: Complete reference of the getOrganizationNetworks API.
link: https://developer.cisco.com/meraki/api-v1/#!get-organization-networks
notes:
- SDK Method used are
networks.Networks.get_network,
networks.Networks.get_organization_networks,
- Paths used are
get /networks/{networkId},
get /organizations/{organizationId}/networks,
"""
EXAMPLES = r"""
- name: Get all networks
cisco.meraki.networks_info:
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}}"
configTemplateId: string
isBoundToConfigTemplate: True
tags: []
tagsFilterType: string
perPage: 0
startingAfter: string
endingBefore: string
organizationId: string
total_pages: -1
direction: next
register: result
- name: Get networks by id
cisco.meraki.networks_info:
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}}"
networkId: string
register: result
"""
RETURN = r"""
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki Python SDK
returned: always
type: dict
sample: >
{
"enrollmentString": "string",
"id": "string",
"isBoundToConfigTemplate": true,
"name": "string",
"notes": "string",
"organizationId": "string",
"productTypes": [
"string"
],
"tags": [
"string"
],
"timeZone": "string",
"url": "string"
}
"""
|
