Documentation
¶
Overview ¶
Api classes for dataprotection's golang SDK
Index ¶
- type DataProtectionClusterCapabilitiesApi
- type DataProtectionClusterCapabilitiesServiceApi
- type ProtectedResourcesApi
- func (api *ProtectedResourcesApi) GetProtectedResourceById(extId *string, args ...map[string]interface{}) (*import1.GetProtectedResourceApiResponse, error)
- func (api *ProtectedResourcesApi) PromoteProtectedResource(extId *string, args ...map[string]interface{}) (*import1.ProtectedResourcePromoteApiResponse, error)
- func (api *ProtectedResourcesApi) RestoreProtectedResource(extId *string, body *import1.ProtectedResourceRestoreSpec, ...) (*import1.ProtectedResourceRestoreApiResponse, error)
- type ProtectedResourcesServiceApi
- func (api *ProtectedResourcesServiceApi) GetProtectedResourceById(ctx context.Context, request *import3.GetProtectedResourceByIdRequest, ...) (*import1.GetProtectedResourceApiResponse, error)
- func (api *ProtectedResourcesServiceApi) PromoteProtectedResource(ctx context.Context, request *import3.PromoteProtectedResourceRequest, ...) (*import1.ProtectedResourcePromoteApiResponse, error)
- func (api *ProtectedResourcesServiceApi) RestoreProtectedResource(ctx context.Context, request *import3.RestoreProtectedResourceRequest, ...) (*import1.ProtectedResourceRestoreApiResponse, error)
- type RecoveryPlanActionsApi
- func (api *RecoveryPlanActionsApi) CleanupRecoveryPlanResources(recoveryPlanExtId *string, args ...map[string]interface{}) (*import4.CleanupRecoveryPlanResourcesApiResponse, error)
- func (api *RecoveryPlanActionsApi) PlannedFailoverRecoveryPlan(recoveryPlanExtId *string, body *import4.PlannedFailoverSpec, ...) (*import4.PlannedFailoverRecoveryPlanApiResponse, error)
- func (api *RecoveryPlanActionsApi) ResumeProtection(recoveryPlanExtId *string, args ...map[string]interface{}) (*import4.ResumeProtectionApiResponse, error)
- func (api *RecoveryPlanActionsApi) TestFailoverRecoveryPlan(recoveryPlanExtId *string, body *import4.TestFailoverSpec, ...) (*import4.TestFailoverRecoveryPlanApiResponse, error)
- func (api *RecoveryPlanActionsApi) UnplannedFailoverRecoveryPlan(recoveryPlanExtId *string, body *import4.UnplannedFailoverSpec, ...) (*import4.UnplannedFailoverRecoveryPlanApiResponse, error)
- func (api *RecoveryPlanActionsApi) ValidateRecoveryPlan(recoveryPlanExtId *string, body *import4.BaseRecoveryPlanActionSpec, ...) (*import4.ValidateRecoveryPlanApiResponse, error)
- type RecoveryPlanActionsServiceApi
- func (api *RecoveryPlanActionsServiceApi) CleanupRecoveryPlanResources(ctx context.Context, request *import5.CleanupRecoveryPlanResourcesRequest, ...) (*import4.CleanupRecoveryPlanResourcesApiResponse, error)
- func (api *RecoveryPlanActionsServiceApi) PlannedFailoverRecoveryPlan(ctx context.Context, request *import5.PlannedFailoverRecoveryPlanRequest, ...) (*import4.PlannedFailoverRecoveryPlanApiResponse, error)
- func (api *RecoveryPlanActionsServiceApi) ResumeProtection(ctx context.Context, request *import5.ResumeProtectionRequest, ...) (*import4.ResumeProtectionApiResponse, error)
- func (api *RecoveryPlanActionsServiceApi) TestFailoverRecoveryPlan(ctx context.Context, request *import5.TestFailoverRecoveryPlanRequest, ...) (*import4.TestFailoverRecoveryPlanApiResponse, error)
- func (api *RecoveryPlanActionsServiceApi) UnplannedFailoverRecoveryPlan(ctx context.Context, request *import5.UnplannedFailoverRecoveryPlanRequest, ...) (*import4.UnplannedFailoverRecoveryPlanApiResponse, error)
- func (api *RecoveryPlanActionsServiceApi) ValidateRecoveryPlan(ctx context.Context, request *import5.ValidateRecoveryPlanRequest, ...) (*import4.ValidateRecoveryPlanApiResponse, error)
- type RecoveryPlanJobsApi
- func (api *RecoveryPlanJobsApi) DeleteRecoveryPlanJobById(extId *string, args ...map[string]interface{}) (*import1.DeleteRecoveryPlanJobApiResponse, error)
- func (api *RecoveryPlanJobsApi) GetRecoveryPlanJobById(extId *string, args ...map[string]interface{}) (*import1.GetRecoveryPlanJobApiResponse, error)
- func (api *RecoveryPlanJobsApi) ListExecutionStepsByRecoveryPlanJobId(recoveryPlanJobExtId *string, page_ *int, limit_ *int, filter_ *string, ...) (*import1.ListRecoveryPlanJobExecutionStepsApiResponse, error)
- func (api *RecoveryPlanJobsApi) ListRecoveryPlanJobs(page_ *int, limit_ *int, filter_ *string, orderby_ *string, apply_ *string, ...) (*import1.ListRecoveryPlanJobsApiResponse, error)
- func (api *RecoveryPlanJobsApi) ListValidationErrorsByRecoveryPlanJobId(recoveryPlanJobExtId *string, page_ *int, limit_ *int, filter_ *string, ...) (*import1.ListRecoveryPlanJobValidationErrorsApiResponse, error)
- type RecoveryPlanJobsServiceApi
- func (api *RecoveryPlanJobsServiceApi) DeleteRecoveryPlanJobById(ctx context.Context, request *import6.DeleteRecoveryPlanJobByIdRequest, ...) (*import1.DeleteRecoveryPlanJobApiResponse, error)
- func (api *RecoveryPlanJobsServiceApi) GetRecoveryPlanJobById(ctx context.Context, request *import6.GetRecoveryPlanJobByIdRequest, ...) (*import1.GetRecoveryPlanJobApiResponse, error)
- func (api *RecoveryPlanJobsServiceApi) ListExecutionStepsByRecoveryPlanJobId(ctx context.Context, ...) (*import1.ListRecoveryPlanJobExecutionStepsApiResponse, error)
- func (api *RecoveryPlanJobsServiceApi) ListRecoveryPlanJobs(ctx context.Context, request *import6.ListRecoveryPlanJobsRequest, ...) (*import1.ListRecoveryPlanJobsApiResponse, error)
- func (api *RecoveryPlanJobsServiceApi) ListValidationErrorsByRecoveryPlanJobId(ctx context.Context, ...) (*import1.ListRecoveryPlanJobValidationErrorsApiResponse, error)
- type RecoveryPointStoresApi
- func (api *RecoveryPointStoresApi) GetRecoveryPointStoreById(extId *string, args ...map[string]interface{}) (*import1.GetRecoveryPointStoreApiResponse, error)
- func (api *RecoveryPointStoresApi) ListRecoveryPointStores(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, ...) (*import1.ListRecoveryPointStoresApiResponse, error)
- type RecoveryPointStoresServiceApi
- func (api *RecoveryPointStoresServiceApi) GetRecoveryPointStoreById(ctx context.Context, request *import7.GetRecoveryPointStoreByIdRequest, ...) (*import1.GetRecoveryPointStoreApiResponse, error)
- func (api *RecoveryPointStoresServiceApi) ListRecoveryPointStores(ctx context.Context, request *import7.ListRecoveryPointStoresRequest, ...) (*import1.ListRecoveryPointStoresApiResponse, error)
- type RecoveryPointsApi
- func (api *RecoveryPointsApi) CreateRecoveryPoint(body *import1.RecoveryPoint, args ...map[string]interface{}) (*import1.CreateRecoveryPointApiResponse, error)
- func (api *RecoveryPointsApi) DeleteRecoveryPointById(extId *string, args ...map[string]interface{}) (*import1.DeleteRecoveryPointApiResponse, error)
- func (api *RecoveryPointsApi) DiscoverClusterForRecoveryPointId(extId *string, body *import8.ClusterDiscoverSpec, ...) (*import1.ClusterInfoApiResponse, error)
- func (api *RecoveryPointsApi) GetRecoveryPointById(extId *string, args ...map[string]interface{}) (*import1.GetRecoveryPointApiResponse, error)
- func (api *RecoveryPointsApi) GetVmRecoveryPointById(recoveryPointExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetVmRecoveryPointApiResponse, error)
- func (api *RecoveryPointsApi) GetVssMetadataByVmRecoveryPointId(recoveryPointExtId *string, vmRecoveryPointExtId *string, ...) (*import8.GetVssMetadataApiResponse, error)
- func (api *RecoveryPointsApi) ListRecoveryPoints(xClusterId *string, xRecoveryPointStoreId *string, page_ *int, limit_ *int, ...) (*import1.ListRecoveryPointsApiResponse, error)
- func (api *RecoveryPointsApi) ReplicateRecoveryPoint(extId *string, body *import1.RecoveryPointReplicationSpec, ...) (*import1.RecoveryPointReplicateApiResponse, error)
- func (api *RecoveryPointsApi) RestoreRecoveryPoint(extId *string, body *import1.RecoveryPointRestorationSpec, ...) (*import1.RecoveryPointRestoreApiResponse, error)
- func (api *RecoveryPointsApi) SetRecoveryPointExpirationTime(extId *string, body *import1.ExpirationTimeSpec, ...) (*import1.UpdateRecoveryPointExpirationTimeApiResponse, error)
- func (api *RecoveryPointsApi) VmRecoveryPointComputeChangedRegions(recoveryPointExtId *string, vmRecoveryPointExtId *string, extId *string, ...) (*import8.ChangedVmRegionsApiResponse, error)
- func (api *RecoveryPointsApi) VolumeGroupRecoveryPointComputeChangedRegions(recoveryPointExtId *string, volumeGroupRecoveryPointExtId *string, ...) (*import8.ChangedVolumeGroupRegionsApiResponse, error)
- type RecoveryPointsServiceApi
- func (api *RecoveryPointsServiceApi) CreateRecoveryPoint(ctx context.Context, request *import11.CreateRecoveryPointRequest, ...) (*import1.CreateRecoveryPointApiResponse, error)
- func (api *RecoveryPointsServiceApi) DeleteRecoveryPointById(ctx context.Context, request *import11.DeleteRecoveryPointByIdRequest, ...) (*import1.DeleteRecoveryPointApiResponse, error)
- func (api *RecoveryPointsServiceApi) DiscoverClusterForRecoveryPointId(ctx context.Context, ...) (*import1.ClusterInfoApiResponse, error)
- func (api *RecoveryPointsServiceApi) GetRecoveryPointById(ctx context.Context, request *import11.GetRecoveryPointByIdRequest, ...) (*import1.GetRecoveryPointApiResponse, error)
- func (api *RecoveryPointsServiceApi) GetVmRecoveryPointById(ctx context.Context, request *import11.GetVmRecoveryPointByIdRequest, ...) (*import1.GetVmRecoveryPointApiResponse, error)
- func (api *RecoveryPointsServiceApi) GetVssMetadataByVmRecoveryPointId(ctx context.Context, ...) (*import8.GetVssMetadataApiResponse, error)
- func (api *RecoveryPointsServiceApi) ListRecoveryPoints(ctx context.Context, request *import11.ListRecoveryPointsRequest, ...) (*import1.ListRecoveryPointsApiResponse, error)
- func (api *RecoveryPointsServiceApi) ReplicateRecoveryPoint(ctx context.Context, request *import11.ReplicateRecoveryPointRequest, ...) (*import1.RecoveryPointReplicateApiResponse, error)
- func (api *RecoveryPointsServiceApi) RestoreRecoveryPoint(ctx context.Context, request *import11.RestoreRecoveryPointRequest, ...) (*import1.RecoveryPointRestoreApiResponse, error)
- func (api *RecoveryPointsServiceApi) SetRecoveryPointExpirationTime(ctx context.Context, request *import11.SetRecoveryPointExpirationTimeRequest, ...) (*import1.UpdateRecoveryPointExpirationTimeApiResponse, error)
- func (api *RecoveryPointsServiceApi) VmRecoveryPointComputeChangedRegions(ctx context.Context, ...) (*import8.ChangedVmRegionsApiResponse, error)
- func (api *RecoveryPointsServiceApi) VolumeGroupRecoveryPointComputeChangedRegions(ctx context.Context, ...) (*import8.ChangedVolumeGroupRegionsApiResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DataProtectionClusterCapabilitiesApi ¶ added in v4.2.1
type DataProtectionClusterCapabilitiesApi struct {
ApiClient *client.ApiClient
ServiceClient *DataProtectionClusterCapabilitiesServiceApi
// contains filtered or unexported fields
}
func NewDataProtectionClusterCapabilitiesApi ¶ added in v4.2.1
func NewDataProtectionClusterCapabilitiesApi(apiClient *client.ApiClient) *DataProtectionClusterCapabilitiesApi
func (*DataProtectionClusterCapabilitiesApi) ListDataProtectionClusterCapabilities ¶ added in v4.2.1
func (api *DataProtectionClusterCapabilitiesApi) ListDataProtectionClusterCapabilities(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListDPClusterCapabilitiesApiResponse, error)
List the data protection capabilities for all the underlying clusters.
type DataProtectionClusterCapabilitiesServiceApi ¶ added in v4.3.1
type DataProtectionClusterCapabilitiesServiceApi struct {
ApiClient *client.ApiClient
// contains filtered or unexported fields
}
func NewDataProtectionClusterCapabilitiesServiceApi ¶ added in v4.3.1
func NewDataProtectionClusterCapabilitiesServiceApi(apiClient *client.ApiClient) *DataProtectionClusterCapabilitiesServiceApi
func (*DataProtectionClusterCapabilitiesServiceApi) ListDataProtectionClusterCapabilities ¶ added in v4.3.1
func (api *DataProtectionClusterCapabilitiesServiceApi) ListDataProtectionClusterCapabilities(ctx context.Context, request *import2.ListDataProtectionClusterCapabilitiesRequest, args ...map[string]interface{}) (*import1.ListDPClusterCapabilitiesApiResponse, error)
List the data protection capabilities for all the underlying clusters.
type ProtectedResourcesApi ¶
type ProtectedResourcesApi struct {
ApiClient *client.ApiClient
ServiceClient *ProtectedResourcesServiceApi
// contains filtered or unexported fields
}
func NewProtectedResourcesApi ¶
func NewProtectedResourcesApi(apiClient *client.ApiClient) *ProtectedResourcesApi
func (*ProtectedResourcesApi) GetProtectedResourceById ¶
func (api *ProtectedResourcesApi) GetProtectedResourceById(extId *string, args ...map[string]interface{}) (*import1.GetProtectedResourceApiResponse, error)
Retrieves the details of the specified protection resource, including available restorable time ranges on the local Prism Central and the replication status to targets defined in the applied protection policies. This is applicable only if the entity is protected with a minutely or synchronous schedule. Other protection schedules are not currently supported by this endpoint and are considered unprotected.
func (*ProtectedResourcesApi) PromoteProtectedResource ¶
func (api *ProtectedResourcesApi) PromoteProtectedResource(extId *string, args ...map[string]interface{}) (*import1.ProtectedResourcePromoteApiResponse, error)
Promotes a specified synced entity at the target site. This is only relevant if the synced entity is protected in a synchronous schedule.
func (*ProtectedResourcesApi) RestoreProtectedResource ¶
func (api *ProtectedResourcesApi) RestoreProtectedResource(extId *string, body *import1.ProtectedResourceRestoreSpec, args ...map[string]interface{}) (*import1.ProtectedResourceRestoreApiResponse, error)
Restores the specified protected resource from its state at the given timestamp on the given cluster. This is only relevant if the entity is protected in a minutely schedule at the given timestamp.
type ProtectedResourcesServiceApi ¶ added in v4.3.1
type ProtectedResourcesServiceApi struct {
ApiClient *client.ApiClient
// contains filtered or unexported fields
}
func NewProtectedResourcesServiceApi ¶ added in v4.3.1
func NewProtectedResourcesServiceApi(apiClient *client.ApiClient) *ProtectedResourcesServiceApi
func (*ProtectedResourcesServiceApi) GetProtectedResourceById ¶ added in v4.3.1
func (api *ProtectedResourcesServiceApi) GetProtectedResourceById(ctx context.Context, request *import3.GetProtectedResourceByIdRequest, args ...map[string]interface{}) (*import1.GetProtectedResourceApiResponse, error)
Retrieves the details of the specified protection resource, including available restorable time ranges on the local Prism Central and the replication status to targets defined in the applied protection policies. This is applicable only if the entity is protected with a minutely or synchronous schedule. Other protection schedules are not currently supported by this endpoint and are considered unprotected.
func (*ProtectedResourcesServiceApi) PromoteProtectedResource ¶ added in v4.3.1
func (api *ProtectedResourcesServiceApi) PromoteProtectedResource(ctx context.Context, request *import3.PromoteProtectedResourceRequest, args ...map[string]interface{}) (*import1.ProtectedResourcePromoteApiResponse, error)
Promotes a specified synced entity at the target site. This is only relevant if the synced entity is protected in a synchronous schedule.
func (*ProtectedResourcesServiceApi) RestoreProtectedResource ¶ added in v4.3.1
func (api *ProtectedResourcesServiceApi) RestoreProtectedResource(ctx context.Context, request *import3.RestoreProtectedResourceRequest, args ...map[string]interface{}) (*import1.ProtectedResourceRestoreApiResponse, error)
Restores the specified protected resource from its state at the given timestamp on the given cluster. This is only relevant if the entity is protected in a minutely schedule at the given timestamp.
type RecoveryPlanActionsApi ¶ added in v4.2.1
type RecoveryPlanActionsApi struct {
ApiClient *client.ApiClient
ServiceClient *RecoveryPlanActionsServiceApi
// contains filtered or unexported fields
}
func NewRecoveryPlanActionsApi ¶ added in v4.2.1
func NewRecoveryPlanActionsApi(apiClient *client.ApiClient) *RecoveryPlanActionsApi
func (*RecoveryPlanActionsApi) CleanupRecoveryPlanResources ¶ added in v4.2.1
func (api *RecoveryPlanActionsApi) CleanupRecoveryPlanResources(recoveryPlanExtId *string, args ...map[string]interface{}) (*import4.CleanupRecoveryPlanResourcesApiResponse, error)
Delete entities recovered in the last test failover action on recovery plan.<br> #### Task Completion Details <br> The external identifier for the cleaned recovery plan job is available in the task completion details under the key `recoveryPlanJobExtId`, as well as in the `entitiesAffected` section.
func (*RecoveryPlanActionsApi) PlannedFailoverRecoveryPlan ¶ added in v4.2.1
func (api *RecoveryPlanActionsApi) PlannedFailoverRecoveryPlan(recoveryPlanExtId *string, body *import4.PlannedFailoverSpec, args ...map[string]interface{}) (*import4.PlannedFailoverRecoveryPlanApiResponse, error)
Perform a planned failover on the recovery plan extID. VMs are powered off on the source before migrating it to the target domain manager.<br> #### Task Completion Details <br> The external identifier for the created recovery plan job is available in the task completion details under the key `recoveryPlanJobExtId`, as well as in the `entitiesAffected` section.
func (*RecoveryPlanActionsApi) ResumeProtection ¶ added in v4.4.1
func (api *RecoveryPlanActionsApi) ResumeProtection(recoveryPlanExtId *string, args ...map[string]interface{}) (*import4.ResumeProtectionApiResponse, error)
Resume protection on a Recovery Plan after a planned or unplanned failover operation. This operation re-enables data protection policies that may have been paused during the failover process, ensuring ongoing replication and backup of recovered workloads.<br> #### Task Completion Details <br> The external identifier for the task is available in the task completion details under the key `taskExtId`, as well as in the `entitiesAffected` section.
func (*RecoveryPlanActionsApi) TestFailoverRecoveryPlan ¶ added in v4.2.1
func (api *RecoveryPlanActionsApi) TestFailoverRecoveryPlan(recoveryPlanExtId *string, body *import4.TestFailoverSpec, args ...map[string]interface{}) (*import4.TestFailoverRecoveryPlanApiResponse, error)
Perform a test failover on the recovery plan extId.<br> #### Task Completion Details <br> The external identifier for the created recovery plan job is available in the task completion details under the key `recoveryPlanJobExtId`, as well as in the `entitiesAffected` section.
func (*RecoveryPlanActionsApi) UnplannedFailoverRecoveryPlan ¶ added in v4.2.1
func (api *RecoveryPlanActionsApi) UnplannedFailoverRecoveryPlan(recoveryPlanExtId *string, body *import4.UnplannedFailoverSpec, args ...map[string]interface{}) (*import4.UnplannedFailoverRecoveryPlanApiResponse, error)
Perform an unplanned failover on the recovery plan extId. Restore the entity from the recovery points on the target domain manager.<br> #### Task Completion Details <br> The external identifier for the created recovery plan job is available in the task completion details under the key `recoveryPlanJobExtId`, as well as in the `entitiesAffected` section.
func (*RecoveryPlanActionsApi) ValidateRecoveryPlan ¶ added in v4.2.1
func (api *RecoveryPlanActionsApi) ValidateRecoveryPlan(recoveryPlanExtId *string, body *import4.BaseRecoveryPlanActionSpec, args ...map[string]interface{}) (*import4.ValidateRecoveryPlanApiResponse, error)
Performs the validation of the recovery plan. The validation includes checks for the presence of entities, networks, categories, etc. referenced in the recovery plan.<br> #### Task Completion Details <br> The external identifier for the created recovery plan job is available in the task completion details under the key `recoveryPlanJobExtId`, as well as in the `entitiesAffected` section.
type RecoveryPlanActionsServiceApi ¶ added in v4.3.1
type RecoveryPlanActionsServiceApi struct {
ApiClient *client.ApiClient
// contains filtered or unexported fields
}
func NewRecoveryPlanActionsServiceApi ¶ added in v4.3.1
func NewRecoveryPlanActionsServiceApi(apiClient *client.ApiClient) *RecoveryPlanActionsServiceApi
func (*RecoveryPlanActionsServiceApi) CleanupRecoveryPlanResources ¶ added in v4.3.1
func (api *RecoveryPlanActionsServiceApi) CleanupRecoveryPlanResources(ctx context.Context, request *import5.CleanupRecoveryPlanResourcesRequest, args ...map[string]interface{}) (*import4.CleanupRecoveryPlanResourcesApiResponse, error)
Delete entities recovered in the last test failover action on recovery plan.<br> #### Task Completion Details <br> The external identifier for the cleaned recovery plan job is available in the task completion details under the key `recoveryPlanJobExtId`, as well as in the `entitiesAffected` section.
func (*RecoveryPlanActionsServiceApi) PlannedFailoverRecoveryPlan ¶ added in v4.3.1
func (api *RecoveryPlanActionsServiceApi) PlannedFailoverRecoveryPlan(ctx context.Context, request *import5.PlannedFailoverRecoveryPlanRequest, args ...map[string]interface{}) (*import4.PlannedFailoverRecoveryPlanApiResponse, error)
Perform a planned failover on the recovery plan extID. VMs are powered off on the source before migrating it to the target domain manager.<br> #### Task Completion Details <br> The external identifier for the created recovery plan job is available in the task completion details under the key `recoveryPlanJobExtId`, as well as in the `entitiesAffected` section.
func (*RecoveryPlanActionsServiceApi) ResumeProtection ¶ added in v4.4.1
func (api *RecoveryPlanActionsServiceApi) ResumeProtection(ctx context.Context, request *import5.ResumeProtectionRequest, args ...map[string]interface{}) (*import4.ResumeProtectionApiResponse, error)
Resume protection on a Recovery Plan after a planned or unplanned failover operation. This operation re-enables data protection policies that may have been paused during the failover process, ensuring ongoing replication and backup of recovered workloads.<br> #### Task Completion Details <br> The external identifier for the task is available in the task completion details under the key `taskExtId`, as well as in the `entitiesAffected` section.
func (*RecoveryPlanActionsServiceApi) TestFailoverRecoveryPlan ¶ added in v4.3.1
func (api *RecoveryPlanActionsServiceApi) TestFailoverRecoveryPlan(ctx context.Context, request *import5.TestFailoverRecoveryPlanRequest, args ...map[string]interface{}) (*import4.TestFailoverRecoveryPlanApiResponse, error)
Perform a test failover on the recovery plan extId.<br> #### Task Completion Details <br> The external identifier for the created recovery plan job is available in the task completion details under the key `recoveryPlanJobExtId`, as well as in the `entitiesAffected` section.
func (*RecoveryPlanActionsServiceApi) UnplannedFailoverRecoveryPlan ¶ added in v4.3.1
func (api *RecoveryPlanActionsServiceApi) UnplannedFailoverRecoveryPlan(ctx context.Context, request *import5.UnplannedFailoverRecoveryPlanRequest, args ...map[string]interface{}) (*import4.UnplannedFailoverRecoveryPlanApiResponse, error)
Perform an unplanned failover on the recovery plan extId. Restore the entity from the recovery points on the target domain manager.<br> #### Task Completion Details <br> The external identifier for the created recovery plan job is available in the task completion details under the key `recoveryPlanJobExtId`, as well as in the `entitiesAffected` section.
func (*RecoveryPlanActionsServiceApi) ValidateRecoveryPlan ¶ added in v4.3.1
func (api *RecoveryPlanActionsServiceApi) ValidateRecoveryPlan(ctx context.Context, request *import5.ValidateRecoveryPlanRequest, args ...map[string]interface{}) (*import4.ValidateRecoveryPlanApiResponse, error)
Performs the validation of the recovery plan. The validation includes checks for the presence of entities, networks, categories, etc. referenced in the recovery plan.<br> #### Task Completion Details <br> The external identifier for the created recovery plan job is available in the task completion details under the key `recoveryPlanJobExtId`, as well as in the `entitiesAffected` section.
type RecoveryPlanJobsApi ¶ added in v4.2.1
type RecoveryPlanJobsApi struct {
ApiClient *client.ApiClient
ServiceClient *RecoveryPlanJobsServiceApi
// contains filtered or unexported fields
}
func NewRecoveryPlanJobsApi ¶ added in v4.2.1
func NewRecoveryPlanJobsApi(apiClient *client.ApiClient) *RecoveryPlanJobsApi
func (*RecoveryPlanJobsApi) DeleteRecoveryPlanJobById ¶ added in v4.2.1
func (api *RecoveryPlanJobsApi) DeleteRecoveryPlanJobById(extId *string, args ...map[string]interface{}) (*import1.DeleteRecoveryPlanJobApiResponse, error)
Delete the Recovery Plan Job for the provided {extId}.
func (*RecoveryPlanJobsApi) GetRecoveryPlanJobById ¶ added in v4.2.1
func (api *RecoveryPlanJobsApi) GetRecoveryPlanJobById(extId *string, args ...map[string]interface{}) (*import1.GetRecoveryPlanJobApiResponse, error)
Get the recovery plan job for the provided {extId}.
func (*RecoveryPlanJobsApi) ListExecutionStepsByRecoveryPlanJobId ¶ added in v4.2.1
func (api *RecoveryPlanJobsApi) ListExecutionStepsByRecoveryPlanJobId(recoveryPlanJobExtId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import1.ListRecoveryPlanJobExecutionStepsApiResponse, error)
Status of the steps executed in a recovery plan job.
func (*RecoveryPlanJobsApi) ListRecoveryPlanJobs ¶ added in v4.2.1
func (api *RecoveryPlanJobsApi) ListRecoveryPlanJobs(page_ *int, limit_ *int, filter_ *string, orderby_ *string, apply_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListRecoveryPlanJobsApiResponse, error)
List recovery plan jobs.
func (*RecoveryPlanJobsApi) ListValidationErrorsByRecoveryPlanJobId ¶ added in v4.2.1
func (api *RecoveryPlanJobsApi) ListValidationErrorsByRecoveryPlanJobId(recoveryPlanJobExtId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import1.ListRecoveryPlanJobValidationErrorsApiResponse, error)
Status of the validation errors that occurred in a recovery plan job. It returns the list of validation errors and warnings. Each error includes an error code (e.g., DP-303001) that can be used to identify the specific issue and resolution steps.<br><br> The error guide is present in the Recovery Plan Validation Errors Guide. For detailed error code descriptions, causes, impacts, and resolution steps, refer to <a href='https://portal.nutanix.com/page/documents/list?type=software&filterKey=software&filterVal=Nutanix%20Disaster%20Recovery' target='_blank'>Nutanix Disaster Recovery Documentation</a>.
type RecoveryPlanJobsServiceApi ¶ added in v4.3.1
type RecoveryPlanJobsServiceApi struct {
ApiClient *client.ApiClient
// contains filtered or unexported fields
}
func NewRecoveryPlanJobsServiceApi ¶ added in v4.3.1
func NewRecoveryPlanJobsServiceApi(apiClient *client.ApiClient) *RecoveryPlanJobsServiceApi
func (*RecoveryPlanJobsServiceApi) DeleteRecoveryPlanJobById ¶ added in v4.3.1
func (api *RecoveryPlanJobsServiceApi) DeleteRecoveryPlanJobById(ctx context.Context, request *import6.DeleteRecoveryPlanJobByIdRequest, args ...map[string]interface{}) (*import1.DeleteRecoveryPlanJobApiResponse, error)
Delete the Recovery Plan Job for the provided {extId}.
func (*RecoveryPlanJobsServiceApi) GetRecoveryPlanJobById ¶ added in v4.3.1
func (api *RecoveryPlanJobsServiceApi) GetRecoveryPlanJobById(ctx context.Context, request *import6.GetRecoveryPlanJobByIdRequest, args ...map[string]interface{}) (*import1.GetRecoveryPlanJobApiResponse, error)
Get the recovery plan job for the provided {extId}.
func (*RecoveryPlanJobsServiceApi) ListExecutionStepsByRecoveryPlanJobId ¶ added in v4.3.1
func (api *RecoveryPlanJobsServiceApi) ListExecutionStepsByRecoveryPlanJobId(ctx context.Context, request *import6.ListExecutionStepsByRecoveryPlanJobIdRequest, args ...map[string]interface{}) (*import1.ListRecoveryPlanJobExecutionStepsApiResponse, error)
Status of the steps executed in a recovery plan job.
func (*RecoveryPlanJobsServiceApi) ListRecoveryPlanJobs ¶ added in v4.3.1
func (api *RecoveryPlanJobsServiceApi) ListRecoveryPlanJobs(ctx context.Context, request *import6.ListRecoveryPlanJobsRequest, args ...map[string]interface{}) (*import1.ListRecoveryPlanJobsApiResponse, error)
List recovery plan jobs.
func (*RecoveryPlanJobsServiceApi) ListValidationErrorsByRecoveryPlanJobId ¶ added in v4.3.1
func (api *RecoveryPlanJobsServiceApi) ListValidationErrorsByRecoveryPlanJobId(ctx context.Context, request *import6.ListValidationErrorsByRecoveryPlanJobIdRequest, args ...map[string]interface{}) (*import1.ListRecoveryPlanJobValidationErrorsApiResponse, error)
Status of the validation errors that occurred in a recovery plan job. It returns the list of validation errors and warnings. Each error includes an error code (e.g., DP-303001) that can be used to identify the specific issue and resolution steps.<br><br> The error guide is present in the Recovery Plan Validation Errors Guide. For detailed error code descriptions, causes, impacts, and resolution steps, refer to <a href='https://portal.nutanix.com/page/documents/list?type=software&filterKey=software&filterVal=Nutanix%20Disaster%20Recovery' target='_blank'>Nutanix Disaster Recovery Documentation</a>.
type RecoveryPointStoresApi ¶ added in v4.4.1
type RecoveryPointStoresApi struct {
ApiClient *client.ApiClient
ServiceClient *RecoveryPointStoresServiceApi
// contains filtered or unexported fields
}
func NewRecoveryPointStoresApi ¶ added in v4.4.1
func NewRecoveryPointStoresApi(apiClient *client.ApiClient) *RecoveryPointStoresApi
func (*RecoveryPointStoresApi) GetRecoveryPointStoreById ¶ added in v4.4.1
func (api *RecoveryPointStoresApi) GetRecoveryPointStoreById(extId *string, args ...map[string]interface{}) (*import1.GetRecoveryPointStoreApiResponse, error)
Retrieve a recovery point store by its external identifier.
func (*RecoveryPointStoresApi) ListRecoveryPointStores ¶ added in v4.4.1
func (api *RecoveryPointStoresApi) ListRecoveryPointStores(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListRecoveryPointStoresApiResponse, error)
List all recovery point stores with support for pagination, filtering, sorting, and field selection.
type RecoveryPointStoresServiceApi ¶ added in v4.4.1
type RecoveryPointStoresServiceApi struct {
ApiClient *client.ApiClient
// contains filtered or unexported fields
}
func NewRecoveryPointStoresServiceApi ¶ added in v4.4.1
func NewRecoveryPointStoresServiceApi(apiClient *client.ApiClient) *RecoveryPointStoresServiceApi
func (*RecoveryPointStoresServiceApi) GetRecoveryPointStoreById ¶ added in v4.4.1
func (api *RecoveryPointStoresServiceApi) GetRecoveryPointStoreById(ctx context.Context, request *import7.GetRecoveryPointStoreByIdRequest, args ...map[string]interface{}) (*import1.GetRecoveryPointStoreApiResponse, error)
Retrieve a recovery point store by its external identifier.
func (*RecoveryPointStoresServiceApi) ListRecoveryPointStores ¶ added in v4.4.1
func (api *RecoveryPointStoresServiceApi) ListRecoveryPointStores(ctx context.Context, request *import7.ListRecoveryPointStoresRequest, args ...map[string]interface{}) (*import1.ListRecoveryPointStoresApiResponse, error)
List all recovery point stores with support for pagination, filtering, sorting, and field selection.
type RecoveryPointsApi ¶
type RecoveryPointsApi struct {
ApiClient *client.ApiClient
ServiceClient *RecoveryPointsServiceApi
// contains filtered or unexported fields
}
func NewRecoveryPointsApi ¶
func NewRecoveryPointsApi(apiClient *client.ApiClient) *RecoveryPointsApi
func (*RecoveryPointsApi) CreateRecoveryPoint ¶
func (api *RecoveryPointsApi) CreateRecoveryPoint(body *import1.RecoveryPoint, args ...map[string]interface{}) (*import1.CreateRecoveryPointApiResponse, error)
Create a new recovery point.<br> #### Task Completion Details <br> External identifier of the created recovery point can be found in the task completion details under the key `recoveryPointExtId`.
func (*RecoveryPointsApi) DeleteRecoveryPointById ¶
func (api *RecoveryPointsApi) DeleteRecoveryPointById(extId *string, args ...map[string]interface{}) (*import1.DeleteRecoveryPointApiResponse, error)
Delete the recovery point identified by {extId}.
func (*RecoveryPointsApi) DiscoverClusterForRecoveryPointId ¶
func (api *RecoveryPointsApi) DiscoverClusterForRecoveryPointId(extId *string, body *import8.ClusterDiscoverSpec, args ...map[string]interface{}) (*import1.ClusterInfoApiResponse, error)
It returns cluster details where the given recovery point is located, and a certificate to access the endpoint. The certificate must be set as a NTNX_IGW_SESSION cookie in the header. For example, Cookie: NTNX_IGW_SESSION='certificate'
func (*RecoveryPointsApi) GetRecoveryPointById ¶
func (api *RecoveryPointsApi) GetRecoveryPointById(extId *string, args ...map[string]interface{}) (*import1.GetRecoveryPointApiResponse, error)
Query the recovery point identified by {extId}.
func (*RecoveryPointsApi) GetVmRecoveryPointById ¶
func (api *RecoveryPointsApi) GetVmRecoveryPointById(recoveryPointExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetVmRecoveryPointApiResponse, error)
Query the VM recovery point identified by {extId}.
func (*RecoveryPointsApi) GetVssMetadataByVmRecoveryPointId ¶
func (api *RecoveryPointsApi) GetVssMetadataByVmRecoveryPointId(recoveryPointExtId *string, vmRecoveryPointExtId *string, args ...map[string]interface{}) (*import8.GetVssMetadataApiResponse, error)
The metadata documents of Volume Shadow Copy Service (VSS) writers and requesters are called VSS metadata. During a VSS backup operation, the VSS metadata is compressed into a cabinet file, which is in a .cab file format designed to store compressed files. This cabinet file must be saved to the backup media during a backup operation, as it is required during a restore operation. This API returns the VSS metadata (cabinet file) of a VM recovery point under a composite recovery point that is identified by an external identifier. This external identifier was saved during the recovery point creation operation.
func (*RecoveryPointsApi) ListRecoveryPoints ¶
func (api *RecoveryPointsApi) ListRecoveryPoints(xClusterId *string, xRecoveryPointStoreId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListRecoveryPointsApiResponse, error)
List of recovery points.
func (*RecoveryPointsApi) ReplicateRecoveryPoint ¶
func (api *RecoveryPointsApi) ReplicateRecoveryPoint(extId *string, body *import1.RecoveryPointReplicationSpec, args ...map[string]interface{}) (*import1.RecoveryPointReplicateApiResponse, error)
Replicate the recovery point identified by {extId}.<br> #### Task Completion Details <br> External identifier of the replicated recovery point can be found in the task completion details under the key `recoveryPointExtId`.
func (*RecoveryPointsApi) RestoreRecoveryPoint ¶
func (api *RecoveryPointsApi) RestoreRecoveryPoint(extId *string, body *import1.RecoveryPointRestorationSpec, args ...map[string]interface{}) (*import1.RecoveryPointRestoreApiResponse, error)
Restore a recovery point identified by {extId}.<br> #### Task Completion Details <br> A comma separated list of the created VM and volume group external identifiers can be found in the task completion details under the keys `vmExtIds` and `volumeGroupExtIds` respectively.
func (*RecoveryPointsApi) SetRecoveryPointExpirationTime ¶
func (api *RecoveryPointsApi) SetRecoveryPointExpirationTime(extId *string, body *import1.ExpirationTimeSpec, args ...map[string]interface{}) (*import1.UpdateRecoveryPointExpirationTimeApiResponse, error)
Set the expiration time for the recovery point identified by {extId}.
func (*RecoveryPointsApi) VmRecoveryPointComputeChangedRegions ¶
func (api *RecoveryPointsApi) VmRecoveryPointComputeChangedRegions(recoveryPointExtId *string, vmRecoveryPointExtId *string, extId *string, body *import8.VmRecoveryPointChangedRegionsComputeSpec, args ...map[string]interface{}) (*import8.ChangedVmRegionsApiResponse, error)
Displays the calculated metadata with the changed region details between any two VM disk recovery points of a file. This API can be used for incremental and differential backups, as well as for a full backup, because it indicates the regions that are zeros, helping to avoid copying zero regions.
func (*RecoveryPointsApi) VolumeGroupRecoveryPointComputeChangedRegions ¶
func (api *RecoveryPointsApi) VolumeGroupRecoveryPointComputeChangedRegions(recoveryPointExtId *string, volumeGroupRecoveryPointExtId *string, extId *string, body *import8.VolumeGroupRecoveryPointChangedRegionsComputeSpec, args ...map[string]interface{}) (*import8.ChangedVolumeGroupRegionsApiResponse, error)
Displays the calculated metadata with the changed region details between any two volume group disk recovery points of a file. This API can be used for incremental and differential backups, as well as for a full backup, because it indicates the regions that are zeros, helping to avoid copying zero regions.
type RecoveryPointsServiceApi ¶ added in v4.3.1
type RecoveryPointsServiceApi struct {
ApiClient *client.ApiClient
// contains filtered or unexported fields
}
func NewRecoveryPointsServiceApi ¶ added in v4.3.1
func NewRecoveryPointsServiceApi(apiClient *client.ApiClient) *RecoveryPointsServiceApi
func (*RecoveryPointsServiceApi) CreateRecoveryPoint ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) CreateRecoveryPoint(ctx context.Context, request *import11.CreateRecoveryPointRequest, args ...map[string]interface{}) (*import1.CreateRecoveryPointApiResponse, error)
Create a new recovery point.<br> #### Task Completion Details <br> External identifier of the created recovery point can be found in the task completion details under the key `recoveryPointExtId`.
func (*RecoveryPointsServiceApi) DeleteRecoveryPointById ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) DeleteRecoveryPointById(ctx context.Context, request *import11.DeleteRecoveryPointByIdRequest, args ...map[string]interface{}) (*import1.DeleteRecoveryPointApiResponse, error)
Delete the recovery point identified by {extId}.
func (*RecoveryPointsServiceApi) DiscoverClusterForRecoveryPointId ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) DiscoverClusterForRecoveryPointId(ctx context.Context, request *import11.DiscoverClusterForRecoveryPointIdRequest, args ...map[string]interface{}) (*import1.ClusterInfoApiResponse, error)
It returns cluster details where the given recovery point is located, and a certificate to access the endpoint. The certificate must be set as a NTNX_IGW_SESSION cookie in the header. For example, Cookie: NTNX_IGW_SESSION='certificate'
func (*RecoveryPointsServiceApi) GetRecoveryPointById ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) GetRecoveryPointById(ctx context.Context, request *import11.GetRecoveryPointByIdRequest, args ...map[string]interface{}) (*import1.GetRecoveryPointApiResponse, error)
Query the recovery point identified by {extId}.
func (*RecoveryPointsServiceApi) GetVmRecoveryPointById ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) GetVmRecoveryPointById(ctx context.Context, request *import11.GetVmRecoveryPointByIdRequest, args ...map[string]interface{}) (*import1.GetVmRecoveryPointApiResponse, error)
Query the VM recovery point identified by {extId}.
func (*RecoveryPointsServiceApi) GetVssMetadataByVmRecoveryPointId ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) GetVssMetadataByVmRecoveryPointId(ctx context.Context, request *import11.GetVssMetadataByVmRecoveryPointIdRequest, args ...map[string]interface{}) (*import8.GetVssMetadataApiResponse, error)
The metadata documents of Volume Shadow Copy Service (VSS) writers and requesters are called VSS metadata. During a VSS backup operation, the VSS metadata is compressed into a cabinet file, which is in a .cab file format designed to store compressed files. This cabinet file must be saved to the backup media during a backup operation, as it is required during a restore operation. This API returns the VSS metadata (cabinet file) of a VM recovery point under a composite recovery point that is identified by an external identifier. This external identifier was saved during the recovery point creation operation.
func (*RecoveryPointsServiceApi) ListRecoveryPoints ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) ListRecoveryPoints(ctx context.Context, request *import11.ListRecoveryPointsRequest, args ...map[string]interface{}) (*import1.ListRecoveryPointsApiResponse, error)
List of recovery points.
func (*RecoveryPointsServiceApi) ReplicateRecoveryPoint ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) ReplicateRecoveryPoint(ctx context.Context, request *import11.ReplicateRecoveryPointRequest, args ...map[string]interface{}) (*import1.RecoveryPointReplicateApiResponse, error)
Replicate the recovery point identified by {extId}.<br> #### Task Completion Details <br> External identifier of the replicated recovery point can be found in the task completion details under the key `recoveryPointExtId`.
func (*RecoveryPointsServiceApi) RestoreRecoveryPoint ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) RestoreRecoveryPoint(ctx context.Context, request *import11.RestoreRecoveryPointRequest, args ...map[string]interface{}) (*import1.RecoveryPointRestoreApiResponse, error)
Restore a recovery point identified by {extId}.<br> #### Task Completion Details <br> A comma separated list of the created VM and volume group external identifiers can be found in the task completion details under the keys `vmExtIds` and `volumeGroupExtIds` respectively.
func (*RecoveryPointsServiceApi) SetRecoveryPointExpirationTime ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) SetRecoveryPointExpirationTime(ctx context.Context, request *import11.SetRecoveryPointExpirationTimeRequest, args ...map[string]interface{}) (*import1.UpdateRecoveryPointExpirationTimeApiResponse, error)
Set the expiration time for the recovery point identified by {extId}.
func (*RecoveryPointsServiceApi) VmRecoveryPointComputeChangedRegions ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) VmRecoveryPointComputeChangedRegions(ctx context.Context, request *import11.VmRecoveryPointComputeChangedRegionsRequest, args ...map[string]interface{}) (*import8.ChangedVmRegionsApiResponse, error)
Displays the calculated metadata with the changed region details between any two VM disk recovery points of a file. This API can be used for incremental and differential backups, as well as for a full backup, because it indicates the regions that are zeros, helping to avoid copying zero regions.
func (*RecoveryPointsServiceApi) VolumeGroupRecoveryPointComputeChangedRegions ¶ added in v4.3.1
func (api *RecoveryPointsServiceApi) VolumeGroupRecoveryPointComputeChangedRegions(ctx context.Context, request *import11.VolumeGroupRecoveryPointComputeChangedRegionsRequest, args ...map[string]interface{}) (*import8.ChangedVolumeGroupRegionsApiResponse, error)
Displays the calculated metadata with the changed region details between any two volume group disk recovery points of a file. This API can be used for incremental and differential backups, as well as for a full backup, because it indicates the regions that are zeros, helping to avoid copying zero regions.