provisioning_url¶

The following methods allow for interaction with the ZTW Provisioning URL API endpoints.

Methods are accessible via ztw.provisioning_url

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class ProvisioningURLAPI¶

Bases: APIClient

A Client object for the ProvisioningURLAPI resource.

get_provisioning_url(provision_id)¶

Get details for a provisioning template by ID.

Parameters:: provision_id (str) – ID of Cloud & Branch Connector provisioning template.
Returns:: The provisiong template url details.
Return type:: Tuple

Examples

Print the details of a provisioning template url:

print(ztw.provisioning.get_provisioning_url(“123456789”)

list_provisioning_url(query_params=None)¶

List all provisioning URLs.

Keyword Arguments:

{dict} (query_params) –

Optional query parameters.

[query_params.page] {int}: Specifies the page offset.

[query_params.page_size] {int}: Specifies the page size. The default size is 250.

Returns:

The list of provisioning URLs.

Return type:

Tuple

Examples

Print all provisioning URLs:

roles = ztw.provisioning.list_provisioning_url()
for role in roles:
    print(role)