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
|
#!/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: organizations_info
short_description: Information module for organizations
description:
- Get all organizations.
- Get organizations by id.
- List the organizations that the user has privileges on.
- Return an organization.
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
perPage:
description:
- PerPage query parameter. The number of entries per page returned. Acceptable range is 3 - 9000. Default is 9000.
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
organizationId:
description:
- OrganizationId path parameter. Organization ID.
type: str
requirements:
- meraki >= 2.4.9
- python >= 3.5
seealso:
- name: Cisco Meraki documentation for organizations getOrganization
description: Complete reference of the getOrganization API.
link: https://developer.cisco.com/meraki/api-v1/#!get-organization
- name: Cisco Meraki documentation for organizations getOrganizations
description: Complete reference of the getOrganizations API.
link: https://developer.cisco.com/meraki/api-v1/#!get-organizations
notes:
- SDK Method used are
organizations.Organizations.get_organization,
organizations.Organizations.get_organizations,
- Paths used are
get /organizations,
get /organizations/{organizationId},
"""
EXAMPLES = r"""
- name: Get all organizations
cisco.meraki.organizations_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}}"
perPage: 0
startingAfter: string
endingBefore: string
total_pages: -1
direction: next
register: result
- name: Get organizations by id
cisco.meraki.organizations_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}}"
organizationId: 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: >
{
"api": {
"enabled": true
},
"cloud": {
"region": {
"name": "string"
}
},
"id": "string",
"licensing": {
"model": "string"
},
"management": {
"details": [
{
"name": "string",
"value": "string"
}
]
},
"name": "string",
"url": "string"
}
"""
|
