controllers_v2.protection_groups_controller module¶

class controllers_v2.protection_groups_controller.ProtectionGroupsController(config=None, client=None, call_back=None)[source]¶

Bases: cohesity_management_sdk.controllers_v2.base_controller.BaseController

A Controller to access Endpoints in the cohesity_management_sdk API.

cancel_protection_group_run(id, run_id, body)[source]¶

Does a POST request to /data-protect/protection-groups/{id}/runs/{runId}/cancel.

Cancel protection run for a given protection group ID and run ID.

Args:

id (string): Specifies a unique id of the Protection Group. run_id (string): Specifies a unique run id of the Protection Group

run.

body (CancelProtectionRunRequest): Specifies the parameters to: cancel a protection run.

Returns:

void: Response from the API. OK

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.

create_protection_group(body)[source]¶

Does a POST request to /data-protect/protection-groups.

Create a Protection Group.

Args:

body (CreateOrUpdateProtectionGroupRequest): Specifies the: parameters to create a Protection Group.

Returns:

ProtectionGroup: 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.

create_protection_group_run(id, body)[source]¶

Does a POST request to /data-protect/protection-groups/{id}/runs.

Create a new protection run. This can be used to start a run for a Protection Group on demand, ignoring the schedule and retention specified in the protection policy.

Args:

id (string): Specifies a unique id of the Protection Group. body (CreateProtectionGroupRunRequest): Specifies the parameters

to start a protection run.

Returns:

CreateProtectionRunResponse: Response from the API. Accepted

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_protection_group(id, delete_snapshots=None)[source]¶

Does a DELETE request to /data-protect/protection-groups/{id}.

Returns Success if the Protection Group is deleted.

Args:

id (string): Specifies a unique id of the Protection Group. delete_snapshots (bool, optional): Specifies if Snapshots

generated by the Protection Group should also be deleted when the Protection Group is deleted.

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_protection_group_by_id(id, include_last_run_info=None, prune_excluded_source_ids=None)[source]¶

Does a GET request to /data-protect/protection-groups/{id}.

Returns the Protection Group corresponding to the specified Group id.

Args:

id (string): Specifies a unique id of the Protection Group. include_last_run_info (bool, optional): If true, the response will

include last run info. If it is false or not specified, the last run info won’t be returned.

prune_excluded_source_ids (bool, optional): If true, the response: will not include the list of excluded source IDs in groups that contain this field. This can be set to true in order to improve performance if excluded source IDs are not needed by the user.

Returns:

ProtectionGroup: 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_protection_group_run(id, run_id, tenant_ids=None, include_tenants=None, include_object_details=None)[source]¶

Does a GET request to /data-protect/protection-groups/{id}/runs/{runId}.

Get a run for a particular Protection Group.

Args:

id (string): Specifies a unique id of the Protection Group. run_id (string): Specifies a unique run id of the Protection Group

run.

tenant_ids (list of string, optional): TenantIds contains ids of: the tenants for which the run is to be returned.
include_tenants (bool, optional): If true, the response will: include Protection Group Runs which were created by all tenants which the current user has permission to see. If false, then only Protection Groups created by the current user will be returned. If it’s not specified, it is true by default.
include_object_details (bool, optional): Specifies if the result: includes the object details for a protection run. If set to true, details of the protected object will be returned. If set to false or not specified, details will not be returned.

Returns:

CommonProtectionGroupRunResponseParameters: 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_protection_group_runs(id, run_id=None, start_time_usecs=None, end_time_usecs=None, tenant_ids=None, include_tenants=None, run_types=None, include_object_details=None, local_backup_run_status=None, replication_run_status=None, archival_run_status=None, cloud_spin_run_status=None, num_runs=None, exclude_non_restorable_runs=False, run_tags=None)[source]¶

Does a GET request to /data-protect/protection-groups/{id}/runs.

Get the runs for a particular Protection Group.

Args:

id (string): Specifies a unique id of the Protection Group. run_id (string, optional): Specifies the protection run id. start_time_usecs (long|int, optional): Filter by a start time.

Specify the start time as a Unix epoch Timestamp (in microseconds).

end_time_usecs (long|int, optional): Filter by a end time. Specify: the start time as a Unix epoch Timestamp (in microseconds).
tenant_ids (list of string, optional): TenantIds contains ids of: the tenants for which objects are to be returned.
include_tenants (bool, optional): If true, the response will: include Protection Group Runs which were created by all tenants which the current user has permission to see. If false, then only Protection Group Runs created by the current user will be returned.
run_types (list of RunType5Enum, optional): Filter by run type.: Only protection run matching the specified types will be returned.
include_object_details (bool, optional): Specifies if the result: includes the object details for each protection run. If set to true, details of the protected object will be returned. If set to false or not specified, details will not be returned.
local_backup_run_status (list of LocalBackupRunStatusEnum,: optional): Specifies a list of local backup status, runs matching the status will be returned. ‘Running’ indicates that the run is still running. ‘Canceled’ indicates that the run has been canceled. ‘Canceling’ indicates that the run is in the process of being canceled. ‘Failed’ indicates that the run has failed. ‘Missed’ indicates that the run was unable to take place at the scheduled time because the previous run was still happening. ‘Succeeded’ indicates that the run has finished successfully. ‘SucceededWithWarning’ indicates that the run finished successfully, but there were some warning messages.
replication_run_status (list of ReplicationRunStatusEnum,: optional): Specifies a list of replication status, runs matching the status will be returned. ‘Running’ indicates that the run is still running. ‘Canceled’ indicates that the run has been canceled. ‘Canceling’ indicates that the run is in the process of being canceled. ‘Failed’ indicates that the run has failed. ‘Missed’ indicates that the run was unable to take place at the scheduled time because the previous run was still happening. ‘Succeeded’ indicates that the run has finished successfully. ‘SucceededWithWarning’ indicates that the run finished successfully, but there were some warning messages.
archival_run_status (list of ArchivalRunStatusEnum, optional):: Specifies a list of archival status, runs matching the status will be returned. ‘Running’ indicates that the run is still running. ‘Canceled’ indicates that the run has been canceled. ‘Canceling’ indicates that the run is in the process of being canceled. ‘Failed’ indicates that the run has failed. ‘Missed’ indicates that the run was unable to take place at the scheduled time because the previous run was still happening. ‘Succeeded’ indicates that the run has finished successfully. ‘SucceededWithWarning’ indicates that the run finished successfully, but there were some warning messages.
cloud_spin_run_status (list of CloudSpinRunStatusEnum, optional):: Specifies a list of cloud spin status, runs matching the status will be returned. ‘Running’ indicates that the run is still running. ‘Canceled’ indicates that the run has been canceled. ‘Canceling’ indicates that the run is in the process of being canceled. ‘Failed’ indicates that the run has failed. ‘Missed’ indicates that the run was unable to take place at the scheduled time because the previous run was still happening. ‘Succeeded’ indicates that the run has finished successfully. ‘SucceededWithWarning’ indicates that the run finished successfully, but there were some warning messages.
num_runs (long|int, optional): Specifies the max number of runs.: If not specified, at most 100 runs will be returned.
exclude_non_restorable_runs (bool, optional): Specifies whether to: exclude non restorable runs. Run is treated restorable only if there is atleast one object snapshot (which may be either a local or an archival snapshot) which is not deleted or expired. Default value is false.
run_tags (list of string): Specifies a list of tags for protection: runs. If this is specified, only the runs which match these tags will be returned.

Returns:

ProtectionGroupRuns: 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_protection_groups(ids=None, names=None, policy_ids=None, environments=None, is_active=None, is_deleted=None, is_paused=None, last_run_local_backup_status=None, last_run_replication_status=None, last_run_archival_status=None, last_run_cloud_spin_status=None, is_last_run_sla_violated=None, tenant_ids=None, include_tenants=None, include_last_run_info=None, prune_excluded_source_ids=None)[source]¶

Does a GET request to /data-protect/protection-groups.

Get the list of Protection Groups.

Args:

ids (list of string, optional): Filter by a list of Protection: Group ids.
names (list of string, optional): Filter by a list of Protection: Group names.
policy_ids (list of string, optional): Filter by Policy ids that: are associated with Protection Groups. Only Protection Groups associated with the specified Policy ids, are returned.
environments (list of Environment21Enum, optional): Filter by: environment types such as ‘kVMware’, ‘kView’, etc. Only Protection Groups protecting the specified environment types are returned.
is_active (bool, optional): Filter by Inactive or Active: Protection Groups. If not set, all Inactive and Active Protection Groups are returned. If true, only Active Protection Groups are returned. If false, only Inactive Protection Groups are returned. When you create a Protection Group on a Primary Cluster with a replication schedule, the Cluster creates an Inactive copy of the Protection Group on the Remote Cluster. In addition, when an Active and running Protection Group is deactivated, the Protection Group becomes Inactive.
is_deleted (bool, optional): If true, return only Protection: Groups that have been deleted but still have Snapshots associated with them. If false, return all Protection Groups except those Protection Groups that have been deleted and still have Snapshots associated with them. A Protection Group that is deleted with all its Snapshots is not returned for either of these cases.
is_paused (bool, optional): Filter by paused or non paused: Protection Groups, If not set, all paused and non paused Protection Groups are returned. If true, only paused Protection Groups are returned. If false, only non paused Protection Groups are returned.
last_run_local_backup_status (list of: LastRunLocalBackupStatusEnum, optional): Filter by last local backup run status. ‘Running’ indicates that the run is still running. ‘Canceled’ indicates that the run has been canceled. ‘Canceling’ indicates that the run is in the process of being canceled. ‘Failed’ indicates that the run has failed. ‘Missed’ indicates that the run was unable to take place at the scheduled time because the previous run was still happening. ‘Succeeded’ indicates that the run has finished successfully. ‘SucceededWithWarning’ indicates that the run finished successfully, but there were some warning messages.
last_run_replication_status (list of LastRunReplicationStatusEnum,: optional): Filter by last remote replication run status. ‘Running’ indicates that the run is still running. ‘Canceled’ indicates that the run has been canceled. ‘Canceling’ indicates that the run is in the process of being canceled. ‘Failed’ indicates that the run has failed. ‘Missed’ indicates that the run was unable to take place at the scheduled time because the previous run was still happening. ‘Succeeded’ indicates that the run has finished successfully. ‘SucceededWithWarning’ indicates that the run finished successfully, but there were some warning messages.
last_run_archival_status (list of LastRunArchivalStatusEnum,: optional): Filter by last cloud archival run status. ‘Running’ indicates that the run is still running. ‘Canceled’ indicates that the run has been canceled. ‘Canceling’ indicates that the run is in the process of being canceled. ‘Failed’ indicates that the run has failed. ‘Missed’ indicates that the run was unable to take place at the scheduled time because the previous run was still happening. ‘Succeeded’ indicates that the run has finished successfully. ‘SucceededWithWarning’ indicates that the run finished successfully, but there were some warning messages.
last_run_cloud_spin_status (list of LastRunCloudSpinStatusEnum,: optional): Filter by last cloud spin run status. ‘Running’ indicates that the run is still running. ‘Canceled’ indicates that the run has been canceled. ‘Canceling’ indicates that the run is in the process of being canceled. ‘Failed’ indicates that the run has failed. ‘Missed’ indicates that the run was unable to take place at the scheduled time because the previous run was still happening. ‘Succeeded’ indicates that the run has finished successfully. ‘SucceededWithWarning’ indicates that the run finished successfully, but there were some warning messages.
is_last_run_sla_violated (bool, optional): If true, return: Protection Groups for which last run SLA was violated.
tenant_ids (list of string, optional): TenantIds contains ids of: the tenants for which objects are to be returned.
include_tenants (bool, optional): If true, the response will: include Protection Groups which were created by all tenants which the current user has permission to see. If false, then only Protection Groups created by the current user will be returned.
include_last_run_info (bool, optional): If true, the response will: include last run info. If it is false or not specified, the last run info won’t be returned.
prune_excluded_source_ids (bool, optional): If true, the response: will not include the list of excluded source IDs in groups that contain this field. This can be set to true in order to improve performance if excluded source IDs are not needed by the user.

Returns:

ProtectionGroups: 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_protection_runs(start_time_usecs=None, end_time_usecs=None, run_status=None)[source]¶

Does a GET request to /data-protect/runs/summary.

Get a list of protection runs.

Args:

start_time_usecs (long|int, optional): Filter by a start time.: Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.
end_time_usecs (long|int, optional): Filter by a end time. Specify: the start time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.
run_status (list of RunStatusEnum, optional): Specifies a list of: status, runs matching the status will be returned. ‘Running’ indicates that the run is still running. ‘Canceled’ indicates that the run has been canceled. ‘Canceling’ indicates that the run is in the process of being canceled. ‘Failed’ indicates that the run has failed. ‘Missed’ indicates that the run was unable to take place at the scheduled time because the previous run was still happening. ‘Succeeded’ indicates that the run has finished successfully. ‘SucceededWithWarning’ indicates that the run finished successfully, but there were some warning messages.

Returns:

ProtectionRunsSummary: 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_run_errors_report(id, run_id, object_id)[source]¶

Does a GET request to /data-protect/protection-groups/{id}/runs/{runId}/objects/{objectId}/downloadMessages.

Get an CSV error report for given objectId and run id. Each row in CSV report contains the File Path, error/warning code and error/warning message.

Args:

id (string): Specifies a unique id of the Protection Group. run_id (string): Specifies a unique run id of the Protection Group

run.

object_id (string): Specifies the id of the object for which: errors/warnings are to be returned.

Returns:

void: Response from the API. OK

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_protection_group(id, body)[source]¶

Does a PUT request to /data-protect/protection-groups/{id}.

Update the specified Protection Group.

Args:

id (string): Specifies the id of the Protection Group. body (CreateOrUpdateProtectionGroupRequest): Specifies the

parameters to update a Protection Group.

Returns:

ProtectionGroup: 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.

update_protection_group_run(id, body)[source]¶

Does a PUT request to /data-protect/protection-groups/{id}/runs.

Update runs for a particular Protection Group. A user can perform the following actions: 1. Extend or reduce retention of a local, replication and archival snapshots. 2. Can perform resync operation on failed copy snapshots attempts in this Run. 3. Add new replication and archival snapshot targets to the Run. 4. Add or remove legal hold on the snapshots. Only a user with DSO role can perform this operation. 5. Delete the snapshots that were created as a part of this Run. 6. Apply datalock on existing snapshots where a user cannot manually delete snapshots before the expiry time.

Args:

id (string): Specifies a unique id of the Protection Group. body (UpdateProtectionGroupRunRequestBody): Specifies the

parameters to update a Protection Group Run.

Returns:

UpdateProtectionGroupRunResponseBody: 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.

update_protection_groups_state(body)[source]¶

Does a POST request to /data-protect/protection-groups/states.

Perform an action like pause, resume, active, deactivate on all specified Protection Groups. Note that the pause or resume actions will take effect from next Protection Run. Also, user can specify only one type of action on all the Protection Groups. Deactivate and activate actions are independent of pause and resume state. Deactivate and activate actions are useful in case of failover situations. Returns success if the state of all the Protection Groups state is changed successfully.

Args:

body (UpdateStateOfProtectionGroups): Specifies the parameters to: perform an action of list of Protection Groups.

Returns:

SpecifiesTheResponseOfUpdationOfStateOfMultipleProtectionGroups:: 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.