activation¶

The following methods allow for interaction with the ZTW Activation Management API endpoints.

Methods are accessible via ztw.activation

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 ActivationAPI¶

Bases: APIClient

A Client object for the Activation resource.

activate(force=False, **kwargs)¶

Activate the configuration.

Parameters:: force (bool) – If set to True, forces the activation. Default is False.
Returns:: The status code of the operation.
Return type:: Tuple

Examples

Activate the configuration without forcing:

ztw.config.activate()

Forcefully activate the configuration:

ztw.config.activate(force=True)

get_status()¶

Get the status of the configuration.

Returns:: The status of the configuration.
Return type:: Tuple

Examples

Get the status of the configuration:

print(ztw.config.get_status())