blob: cafc5776319043f79f87e3236a3f2b59c362d9e0 (
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
112
113
114
115
116
117
|
#!/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_claim
short_description: Resource module for organizations _claim
description:
- Manage operation create of the resource organizations _claim.
- >
Claim a list of devices, licenses, and/or orders into an organization inventory. When claiming by order, all
devices and licenses in the order will be claimed; licenses will be added to the organization and devices will be
placed in the organization's inventory. This operation can be used up to ten times within a single five minute
window.
version_added: '2.16.0'
extends_documentation_fragment:
- cisco.meraki.module
author: Francisco Munoz (@fmunoz)
options:
licenses:
description: The licenses that should be claimed.
elements: dict
suboptions:
key:
description: The key of the license.
type: str
mode:
description: Either 'renew' or 'addDevices'. 'addDevices' will increase the
license limit, while 'renew' will extend the amount of time until expiration.
Defaults to 'addDevices'. All licenses must be claimed with the same mode,
and at most one renewal can be claimed at a time. This parameter is legacy
and does not apply to organizations with per-device licensing enabled.
type: str
type: list
orders:
description: The numbers of the orders that should be claimed.
elements: str
type: list
organizationId:
description: OrganizationId path parameter. Organization ID.
type: str
serials:
description: The serials of the devices that should be claimed.
elements: str
type: list
requirements:
- meraki >= 2.4.9
- python >= 3.5
seealso:
- name: Cisco Meraki documentation for organizations claimIntoOrganization
description: Complete reference of the claimIntoOrganization API.
link: https://developer.cisco.com/meraki/api-v1/#!claim-into-organization
notes:
- SDK Method used are
organizations.Organizations.claim_into_organization,
- Paths used are
post /organizations/{organizationId}/claim,
"""
EXAMPLES = r"""
- name: Create
cisco.meraki.organizations_claim:
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}}"
licenses:
- key: Z2XXXXXXXXXX
mode: addDevices
orders:
- 4CXXXXXXX
organizationId: string
serials:
- Q234-ABCD-5678
"""
RETURN = r"""
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki Python SDK
returned: always
type: dict
sample: >
{
"licenses": [
{
"key": "string",
"mode": "string"
}
],
"orders": [
"string"
],
"serials": [
"string"
]
}
"""
|
