Skip to content

Commit 7869ca8

Browse files
Automatically regenerated library. (#237)
Co-authored-by: GitHub Action <support@meraki.com> Includes mid-cycle release 1.41.0.
1 parent 6339e54 commit 7869ca8

File tree

6 files changed

+232
-4
lines changed

6 files changed

+232
-4
lines changed

meraki/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
)
4444
from meraki.rest_session import *
4545

46-
__version__ = '1.40.1'
46+
__version__ = '1.41.0'
4747

4848

4949
class DashboardAPI(object):

meraki/aio/api/appliance.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2180,7 +2180,7 @@ def updateNetworkApplianceVpnBgp(self, networkId: str, enabled: bool, **kwargs):
21802180
- networkId (string): Network ID
21812181
- enabled (boolean): Boolean value to enable or disable the BGP configuration. When BGP is enabled, the asNumber (ASN) will be autopopulated with the preconfigured ASN at other Hubs or a default value if there is no ASN configured.
21822182
- asNumber (integer): An Autonomous System Number (ASN) is required if you are to run BGP and peer with another BGP Speaker outside of the Auto VPN domain. This ASN will be applied to the entire Auto VPN domain. The entire 4-byte ASN range is supported. So, the ASN must be an integer between 1 and 4294967295. When absent, this field is not updated. If no value exists then it defaults to 64512.
2183-
- ibgpHoldTimer (integer): The IBGP holdtimer in seconds. The IBGP holdtimer must be an integer between 12 and 240. When absent, this field is not updated. If no value exists then it defaults to 240.
2183+
- ibgpHoldTimer (integer): The iBGP holdtimer in seconds. The iBGP holdtimer must be an integer between 12 and 240. When absent, this field is not updated. If no value exists then it defaults to 240.
21842184
- neighbors (array): List of BGP neighbors. This list replaces the existing set of neighbors. When absent, this field is not updated.
21852185
"""
21862186

meraki/aio/api/licensing.py

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,120 @@ def __init__(self, session):
88

99

1010

11+
def getAdministeredLicensingSubscriptionSubscriptions(self, total_pages=1, direction='next', **kwargs):
12+
"""
13+
**List available subscriptions**
14+
https://developer.cisco.com/meraki/api-v1/#!get-administered-licensing-subscription-subscriptions
15+
16+
- total_pages (integer or string): use with perPage to get total results up to total_pages*perPage; -1 or "all" for all pages
17+
- direction (string): direction to paginate, either "next" (default) or "prev" page
18+
- perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.
19+
- startingAfter (string): 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.
20+
- endingBefore (string): 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.
21+
- subscriptionIds (array): List of subscription ids to fetch
22+
- organizationIds (array): Organizations to get associated subscriptions for
23+
- startDate (string): Filter subscriptions by start date, ISO 8601 format. To filter with a range of dates, use 'startDate[<option>]=?' in the request. Accepted options include lt, gt, lte, gte.
24+
- endDate (string): Filter subscriptions by end date, ISO 8601 format. To filter with a range of dates, use 'endDate[<option>]=?' in the request. Accepted options include lt, gt, lte, gte.
25+
- statuses (array): List of statuses that returned subscriptions can have
26+
- productTypes (array): List of product types that returned subscriptions need to have entitlements for.
27+
"""
28+
29+
kwargs.update(locals())
30+
31+
metadata = {
32+
'tags': ['licensing', 'configure', 'subscription', 'subscriptions'],
33+
'operation': 'getAdministeredLicensingSubscriptionSubscriptions'
34+
}
35+
resource = f'/administered/licensing/subscription/subscriptions'
36+
37+
query_params = ['perPage', 'startingAfter', 'endingBefore', 'subscriptionIds', 'organizationIds', 'startDate', 'endDate', 'statuses', 'productTypes', ]
38+
params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params}
39+
40+
array_params = ['subscriptionIds', 'organizationIds', 'statuses', 'productTypes', ]
41+
for k, v in kwargs.items():
42+
if k.strip() in array_params:
43+
params[f'{k.strip()}[]'] = kwargs[f'{k}']
44+
params.pop(k.strip())
45+
46+
return self._session.get_pages(metadata, resource, params, total_pages, direction)
47+
48+
49+
50+
def claimAdministeredLicensingSubscriptionSubscriptions(self, claimKey: str, organizationId: str, **kwargs):
51+
"""
52+
**Claim a subscription into an organization.**
53+
https://developer.cisco.com/meraki/api-v1/#!claim-administered-licensing-subscription-subscriptions
54+
55+
- claimKey (string): The subscription's claim key
56+
- organizationId (string): The id of the organization claiming the subscription
57+
- name (string): Friendly name to identify the subscription
58+
- description (string): Extra details or notes about the subscription
59+
"""
60+
61+
kwargs.update(locals())
62+
63+
metadata = {
64+
'tags': ['licensing', 'configure', 'subscription', 'subscriptions'],
65+
'operation': 'claimAdministeredLicensingSubscriptionSubscriptions'
66+
}
67+
resource = f'/administered/licensing/subscription/subscriptions/claim'
68+
69+
body_params = ['claimKey', 'organizationId', 'name', 'description', ]
70+
payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
71+
72+
return self._session.post(metadata, resource, payload)
73+
74+
75+
76+
def validateAdministeredLicensingSubscriptionSubscriptionsClaimKey(self, claimKey: str):
77+
"""
78+
**Find a subscription by claim key**
79+
https://developer.cisco.com/meraki/api-v1/#!validate-administered-licensing-subscription-subscriptions-claim-key
80+
81+
- claimKey (string): The subscription's claim key
82+
"""
83+
84+
kwargs = locals()
85+
86+
metadata = {
87+
'tags': ['licensing', 'configure', 'subscription', 'subscriptions', 'claimKey'],
88+
'operation': 'validateAdministeredLicensingSubscriptionSubscriptionsClaimKey'
89+
}
90+
resource = f'/administered/licensing/subscription/subscriptions/claimKey/validate'
91+
92+
body_params = ['claimKey', ]
93+
payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
94+
95+
return self._session.post(metadata, resource, payload)
96+
97+
98+
99+
def bindAdministeredLicensingSubscriptionSubscription(self, subscriptionId: str, networkIds: list, **kwargs):
100+
"""
101+
**Bind networks to a subscription**
102+
https://developer.cisco.com/meraki/api-v1/#!bind-administered-licensing-subscription-subscription
103+
104+
- subscriptionId (string): Subscription ID
105+
- networkIds (array): List of network ids to bind to the subscription
106+
- validate (boolean): Check if the provided networks can be bound to the subscription. Returns any licensing problems and does not commit the results.
107+
"""
108+
109+
kwargs.update(locals())
110+
111+
metadata = {
112+
'tags': ['licensing', 'configure', 'subscription', 'subscriptions'],
113+
'operation': 'bindAdministeredLicensingSubscriptionSubscription'
114+
}
115+
subscriptionId = urllib.parse.quote(str(subscriptionId), safe='')
116+
resource = f'/administered/licensing/subscription/subscriptions/{subscriptionId}/bind'
117+
118+
body_params = ['networkIds', ]
119+
payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
120+
121+
return self._session.post(metadata, resource, payload)
122+
123+
124+
11125
def getOrganizationLicensingCotermLicenses(self, organizationId: str, total_pages=1, direction='next', **kwargs):
12126
"""
13127
**List the licenses in a coterm organization**

meraki/api/appliance.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2180,7 +2180,7 @@ def updateNetworkApplianceVpnBgp(self, networkId: str, enabled: bool, **kwargs):
21802180
- networkId (string): Network ID
21812181
- enabled (boolean): Boolean value to enable or disable the BGP configuration. When BGP is enabled, the asNumber (ASN) will be autopopulated with the preconfigured ASN at other Hubs or a default value if there is no ASN configured.
21822182
- asNumber (integer): An Autonomous System Number (ASN) is required if you are to run BGP and peer with another BGP Speaker outside of the Auto VPN domain. This ASN will be applied to the entire Auto VPN domain. The entire 4-byte ASN range is supported. So, the ASN must be an integer between 1 and 4294967295. When absent, this field is not updated. If no value exists then it defaults to 64512.
2183-
- ibgpHoldTimer (integer): The IBGP holdtimer in seconds. The IBGP holdtimer must be an integer between 12 and 240. When absent, this field is not updated. If no value exists then it defaults to 240.
2183+
- ibgpHoldTimer (integer): The iBGP holdtimer in seconds. The iBGP holdtimer must be an integer between 12 and 240. When absent, this field is not updated. If no value exists then it defaults to 240.
21842184
- neighbors (array): List of BGP neighbors. This list replaces the existing set of neighbors. When absent, this field is not updated.
21852185
"""
21862186

meraki/api/batch/appliance.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -912,7 +912,7 @@ def updateNetworkApplianceVpnBgp(self, networkId: str, enabled: bool, **kwargs):
912912
- networkId (string): Network ID
913913
- enabled (boolean): Boolean value to enable or disable the BGP configuration. When BGP is enabled, the asNumber (ASN) will be autopopulated with the preconfigured ASN at other Hubs or a default value if there is no ASN configured.
914914
- asNumber (integer): An Autonomous System Number (ASN) is required if you are to run BGP and peer with another BGP Speaker outside of the Auto VPN domain. This ASN will be applied to the entire Auto VPN domain. The entire 4-byte ASN range is supported. So, the ASN must be an integer between 1 and 4294967295. When absent, this field is not updated. If no value exists then it defaults to 64512.
915-
- ibgpHoldTimer (integer): The IBGP holdtimer in seconds. The IBGP holdtimer must be an integer between 12 and 240. When absent, this field is not updated. If no value exists then it defaults to 240.
915+
- ibgpHoldTimer (integer): The iBGP holdtimer in seconds. The iBGP holdtimer must be an integer between 12 and 240. When absent, this field is not updated. If no value exists then it defaults to 240.
916916
- neighbors (array): List of BGP neighbors. This list replaces the existing set of neighbors. When absent, this field is not updated.
917917
"""
918918

meraki/api/licensing.py

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,120 @@ def __init__(self, session):
88

99

1010

11+
def getAdministeredLicensingSubscriptionSubscriptions(self, total_pages=1, direction='next', **kwargs):
12+
"""
13+
**List available subscriptions**
14+
https://developer.cisco.com/meraki/api-v1/#!get-administered-licensing-subscription-subscriptions
15+
16+
- total_pages (integer or string): use with perPage to get total results up to total_pages*perPage; -1 or "all" for all pages
17+
- direction (string): direction to paginate, either "next" (default) or "prev" page
18+
- perPage (integer): The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.
19+
- startingAfter (string): 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.
20+
- endingBefore (string): 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.
21+
- subscriptionIds (array): List of subscription ids to fetch
22+
- organizationIds (array): Organizations to get associated subscriptions for
23+
- startDate (string): Filter subscriptions by start date, ISO 8601 format. To filter with a range of dates, use 'startDate[<option>]=?' in the request. Accepted options include lt, gt, lte, gte.
24+
- endDate (string): Filter subscriptions by end date, ISO 8601 format. To filter with a range of dates, use 'endDate[<option>]=?' in the request. Accepted options include lt, gt, lte, gte.
25+
- statuses (array): List of statuses that returned subscriptions can have
26+
- productTypes (array): List of product types that returned subscriptions need to have entitlements for.
27+
"""
28+
29+
kwargs.update(locals())
30+
31+
metadata = {
32+
'tags': ['licensing', 'configure', 'subscription', 'subscriptions'],
33+
'operation': 'getAdministeredLicensingSubscriptionSubscriptions'
34+
}
35+
resource = f'/administered/licensing/subscription/subscriptions'
36+
37+
query_params = ['perPage', 'startingAfter', 'endingBefore', 'subscriptionIds', 'organizationIds', 'startDate', 'endDate', 'statuses', 'productTypes', ]
38+
params = {k.strip(): v for k, v in kwargs.items() if k.strip() in query_params}
39+
40+
array_params = ['subscriptionIds', 'organizationIds', 'statuses', 'productTypes', ]
41+
for k, v in kwargs.items():
42+
if k.strip() in array_params:
43+
params[f'{k.strip()}[]'] = kwargs[f'{k}']
44+
params.pop(k.strip())
45+
46+
return self._session.get_pages(metadata, resource, params, total_pages, direction)
47+
48+
49+
50+
def claimAdministeredLicensingSubscriptionSubscriptions(self, claimKey: str, organizationId: str, **kwargs):
51+
"""
52+
**Claim a subscription into an organization.**
53+
https://developer.cisco.com/meraki/api-v1/#!claim-administered-licensing-subscription-subscriptions
54+
55+
- claimKey (string): The subscription's claim key
56+
- organizationId (string): The id of the organization claiming the subscription
57+
- name (string): Friendly name to identify the subscription
58+
- description (string): Extra details or notes about the subscription
59+
"""
60+
61+
kwargs.update(locals())
62+
63+
metadata = {
64+
'tags': ['licensing', 'configure', 'subscription', 'subscriptions'],
65+
'operation': 'claimAdministeredLicensingSubscriptionSubscriptions'
66+
}
67+
resource = f'/administered/licensing/subscription/subscriptions/claim'
68+
69+
body_params = ['claimKey', 'organizationId', 'name', 'description', ]
70+
payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
71+
72+
return self._session.post(metadata, resource, payload)
73+
74+
75+
76+
def validateAdministeredLicensingSubscriptionSubscriptionsClaimKey(self, claimKey: str):
77+
"""
78+
**Find a subscription by claim key**
79+
https://developer.cisco.com/meraki/api-v1/#!validate-administered-licensing-subscription-subscriptions-claim-key
80+
81+
- claimKey (string): The subscription's claim key
82+
"""
83+
84+
kwargs = locals()
85+
86+
metadata = {
87+
'tags': ['licensing', 'configure', 'subscription', 'subscriptions', 'claimKey'],
88+
'operation': 'validateAdministeredLicensingSubscriptionSubscriptionsClaimKey'
89+
}
90+
resource = f'/administered/licensing/subscription/subscriptions/claimKey/validate'
91+
92+
body_params = ['claimKey', ]
93+
payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
94+
95+
return self._session.post(metadata, resource, payload)
96+
97+
98+
99+
def bindAdministeredLicensingSubscriptionSubscription(self, subscriptionId: str, networkIds: list, **kwargs):
100+
"""
101+
**Bind networks to a subscription**
102+
https://developer.cisco.com/meraki/api-v1/#!bind-administered-licensing-subscription-subscription
103+
104+
- subscriptionId (string): Subscription ID
105+
- networkIds (array): List of network ids to bind to the subscription
106+
- validate (boolean): Check if the provided networks can be bound to the subscription. Returns any licensing problems and does not commit the results.
107+
"""
108+
109+
kwargs.update(locals())
110+
111+
metadata = {
112+
'tags': ['licensing', 'configure', 'subscription', 'subscriptions'],
113+
'operation': 'bindAdministeredLicensingSubscriptionSubscription'
114+
}
115+
subscriptionId = urllib.parse.quote(str(subscriptionId), safe='')
116+
resource = f'/administered/licensing/subscription/subscriptions/{subscriptionId}/bind'
117+
118+
body_params = ['networkIds', ]
119+
payload = {k.strip(): v for k, v in kwargs.items() if k.strip() in body_params}
120+
121+
return self._session.post(metadata, resource, payload)
122+
123+
124+
11125
def getOrganizationLicensingCotermLicenses(self, organizationId: str, total_pages=1, direction='next', **kwargs):
12126
"""
13127
**List the licenses in a coterm organization**

0 commit comments

Comments
 (0)