controllers.kms_configuration_controller module

class controllers.kms_configuration_controller.KmsConfigurationController(config=None, client=None, call_back=None)

Bases: cohesity_management_sdk.controllers.base_controller.BaseController

A Controller to access Endpoints in the cohesity_management_sdk API.

create_kms_config(body=None)

Does a POST request to /public/kmsConfig.

Returns the created KMS config.

Args:

body (KmsCreateRequestParameters, optional): TODO: type description here.

Example:

Returns:

KmsConfigurationResponse: Response from the API. Response after

KMS has been created.

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

delete_kms_config(id, body)

Does a DELETE request to /public/kmsConfig/{id}.

Specifies a unique id of the KMS config.

Args:

id (long|int): Specifies a unique id of the Protection Job. body (KmsDeleteParams): Request to delete kms config.

Returns:

void: Response from the API. No Content

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

get_kms_config(id=None)

Does a GET request to /public/kmsConfig.

List KMS configurations in the cluster.

Args:

id (int, optional): The Id of a KMS server.

Returns:

list of KmsConfigurationResponse: Response from the API. Specifies

a list of KMS configurations.

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

update_kms_config(body=None)

Does a PUT request to /public/kmsConfig.

Update KMS configurations in the cluster.

Args:

body (KmsUpdateRequestParameters, optional): TODO: type description here.

Example:

Returns:

KmsConfigurationResponse: Response from the API. Response after

KMS has been updated.

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.