api

package
v4.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Api classes for dataprotection's golang SDK

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConsistencyGroupsApi added in v4.2.1

type ConsistencyGroupsApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewConsistencyGroupsApi added in v4.2.1

func NewConsistencyGroupsApi(apiClient *client.ApiClient) *ConsistencyGroupsApi

func (*ConsistencyGroupsApi) CreateConsistencyGroup added in v4.2.1

func (api *ConsistencyGroupsApi) CreateConsistencyGroup(body *import1.ConsistencyGroup, args ...map[string]interface{}) (*import1.CreateConsistencyGroupApiResponse, error)

Create a new consistency group with provided specification.

func (*ConsistencyGroupsApi) DeleteConsistencyGroupById added in v4.2.1

func (api *ConsistencyGroupsApi) DeleteConsistencyGroupById(extId *string, args ...map[string]interface{}) (*import1.DeleteConsistencyGroupApiResponse, error)

Deletes a consistency group for the provided external identifier.

func (*ConsistencyGroupsApi) GetConsistencyGroupById added in v4.2.1

func (api *ConsistencyGroupsApi) GetConsistencyGroupById(extId *string, args ...map[string]interface{}) (*import1.GetConsistencyGroupApiResponse, error)

Fetches the details of the consistency group for the provided external identifier.

func (*ConsistencyGroupsApi) ListConsistencyGroups added in v4.2.1

func (api *ConsistencyGroupsApi) ListConsistencyGroups(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListConsistencyGroupsApiResponse, error)

Lists the consistency groups defined on the system. List of consistency groups can be further filtered out using various filtering options.

func (*ConsistencyGroupsApi) UpdateConsistencyGroupById added in v4.2.1

func (api *ConsistencyGroupsApi) UpdateConsistencyGroupById(extId *string, body *import1.ConsistencyGroup, args ...map[string]interface{}) (*import1.UpdateConsistencyGroupApiResponse, error)

Updates the details of a consistency group for the provided external identifier.

type DataProtectionClusterCapabilitiesApi added in v4.2.1

type DataProtectionClusterCapabilitiesApi struct {
	ApiClient *client.ApiClient
	// 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 ProtectedResourcesApi

type ProtectedResourcesApi struct {
	ApiClient *client.ApiClient
	// 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 RecoveryPlanActionsApi added in v4.2.1

type RecoveryPlanActionsApi struct {
	ApiClient *client.ApiClient
	// 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{}) (*import2.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 *import2.PlannedFailoverSpec, args ...map[string]interface{}) (*import2.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) TestFailoverRecoveryPlan added in v4.2.1

func (api *RecoveryPlanActionsApi) TestFailoverRecoveryPlan(recoveryPlanExtId *string, body *import2.TestFailoverSpec, args ...map[string]interface{}) (*import2.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 *import2.UnplannedFailoverSpec, args ...map[string]interface{}) (*import2.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 *import2.BaseRecoveryPlanActionSpec, args ...map[string]interface{}) (*import2.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
	// 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, 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 RecoveryPointsApi

type RecoveryPointsApi struct {
	ApiClient *client.ApiClient
	// 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 *import3.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{}) (*import3.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, 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 *import3.VmRecoveryPointChangedRegionsComputeSpec, args ...map[string]interface{}) (*import3.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 *import3.VolumeGroupRecoveryPointChangedRegionsComputeSpec, args ...map[string]interface{}) (*import3.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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL