controllers.cluster_partitions_controller module

class controllers.cluster_partitions_controller.ClusterPartitionsController(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.

get_cluster_partition_by_id(id)

Does a GET request to /public/clusterPartitions/{id}.

Returns the Cluster Partition corresponding to the specified Cluster Partition Id.

Args:

id (long|int): Specifies a unique id of the Cluster Partition to

return.

Returns:

ClusterPartition: Response from the API. Success

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_cluster_partitions(ids=None, names=None)

Does a GET request to /public/clusterPartitions.

If no parameters are specified, all Cluster Partitions currently on the Cohesity Cluster are returned. Specifying parameters filters the results that are returned.

Args:

ids (list of long|int, optional): Array of Cluster Partition Ids.

Filter by a list of Cluster Partition ids. If empty, the Cluster Partitions are not filtered by id.

names (list of string, optional): Array of Cluster Partition

Names. Filter by a list of Cluster Partition Names. If empty, the Cluster Partitions are not filtered by names.

Returns:

list of ClusterPartition: Response from the API. Success

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.