operations

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: 8 Imported by: 0

Documentation

Overview

Module dataprotection.v4.operations of Nutanix Data Protection APIs

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BaseRecoveryPlanActionSpec

type BaseRecoveryPlanActionSpec struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.
	*/
	FailoverDirections []import1.FailoverDirection `json:"failoverDirections"`
	/*
	  Name of the Recovery Plan Job.
	*/
	Name *string `json:"name"`
}

Recovery plan action is a specification describing the recovery plan to be executed, failover directions and type of failover.

func NewBaseRecoveryPlanActionSpec

func NewBaseRecoveryPlanActionSpec() *BaseRecoveryPlanActionSpec

func (*BaseRecoveryPlanActionSpec) MarshalJSON

func (p *BaseRecoveryPlanActionSpec) MarshalJSON() ([]byte, error)

func (*BaseRecoveryPlanActionSpec) UnmarshalJSON

func (p *BaseRecoveryPlanActionSpec) UnmarshalJSON(b []byte) error

type CleanupRecoveryPlanResourcesApiResponse

type CleanupRecoveryPlanResourcesApiResponse struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*

	 */
	DataItemDiscriminator_ *string `json:"$dataItemDiscriminator,omitempty"`

	Data *OneOfCleanupRecoveryPlanResourcesApiResponseData `json:"data,omitempty"`

	Metadata *import4.ApiResponseMetadata `json:"metadata,omitempty"`
}

REST response for all response codes in API path /dataprotection/v4.2/operations/recovery-plans/{recoveryPlanExtId}/$actions/clean-up-resources Post operation

func NewCleanupRecoveryPlanResourcesApiResponse

func NewCleanupRecoveryPlanResourcesApiResponse() *CleanupRecoveryPlanResourcesApiResponse

func (*CleanupRecoveryPlanResourcesApiResponse) GetData

func (p *CleanupRecoveryPlanResourcesApiResponse) GetData() interface{}

func (*CleanupRecoveryPlanResourcesApiResponse) MarshalJSON

func (p *CleanupRecoveryPlanResourcesApiResponse) MarshalJSON() ([]byte, error)

func (*CleanupRecoveryPlanResourcesApiResponse) SetData

func (p *CleanupRecoveryPlanResourcesApiResponse) SetData(v interface{}) error

func (*CleanupRecoveryPlanResourcesApiResponse) UnmarshalJSON

func (p *CleanupRecoveryPlanResourcesApiResponse) UnmarshalJSON(b []byte) error

type FileDetail

type FileDetail struct {
	Path        *string `json:"-"`
	ObjectType_ *string `json:"-"`
}

func NewFileDetail

func NewFileDetail() *FileDetail

type OneOfCleanupRecoveryPlanResourcesApiResponseData

type OneOfCleanupRecoveryPlanResourcesApiResponseData struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func NewOneOfCleanupRecoveryPlanResourcesApiResponseData

func NewOneOfCleanupRecoveryPlanResourcesApiResponseData() *OneOfCleanupRecoveryPlanResourcesApiResponseData

func (*OneOfCleanupRecoveryPlanResourcesApiResponseData) GetValue

func (p *OneOfCleanupRecoveryPlanResourcesApiResponseData) GetValue() interface{}

func (*OneOfCleanupRecoveryPlanResourcesApiResponseData) MarshalJSON

func (*OneOfCleanupRecoveryPlanResourcesApiResponseData) SetValue

func (p *OneOfCleanupRecoveryPlanResourcesApiResponseData) SetValue(v interface{}) error

func (*OneOfCleanupRecoveryPlanResourcesApiResponseData) UnmarshalJSON

type OneOfPlannedFailoverRecoveryPlanApiResponseData

type OneOfPlannedFailoverRecoveryPlanApiResponseData struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func NewOneOfPlannedFailoverRecoveryPlanApiResponseData

func NewOneOfPlannedFailoverRecoveryPlanApiResponseData() *OneOfPlannedFailoverRecoveryPlanApiResponseData

func (*OneOfPlannedFailoverRecoveryPlanApiResponseData) GetValue

func (p *OneOfPlannedFailoverRecoveryPlanApiResponseData) GetValue() interface{}

func (*OneOfPlannedFailoverRecoveryPlanApiResponseData) MarshalJSON

func (*OneOfPlannedFailoverRecoveryPlanApiResponseData) SetValue

func (p *OneOfPlannedFailoverRecoveryPlanApiResponseData) SetValue(v interface{}) error

func (*OneOfPlannedFailoverRecoveryPlanApiResponseData) UnmarshalJSON

type OneOfTestFailoverRecoveryPlanApiResponseData

type OneOfTestFailoverRecoveryPlanApiResponseData struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func NewOneOfTestFailoverRecoveryPlanApiResponseData

func NewOneOfTestFailoverRecoveryPlanApiResponseData() *OneOfTestFailoverRecoveryPlanApiResponseData

func (*OneOfTestFailoverRecoveryPlanApiResponseData) GetValue

func (p *OneOfTestFailoverRecoveryPlanApiResponseData) GetValue() interface{}

func (*OneOfTestFailoverRecoveryPlanApiResponseData) MarshalJSON

func (*OneOfTestFailoverRecoveryPlanApiResponseData) SetValue

func (p *OneOfTestFailoverRecoveryPlanApiResponseData) SetValue(v interface{}) error

func (*OneOfTestFailoverRecoveryPlanApiResponseData) UnmarshalJSON

type OneOfUnplannedFailoverRecoveryPlanApiResponseData

type OneOfUnplannedFailoverRecoveryPlanApiResponseData struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func NewOneOfUnplannedFailoverRecoveryPlanApiResponseData

func NewOneOfUnplannedFailoverRecoveryPlanApiResponseData() *OneOfUnplannedFailoverRecoveryPlanApiResponseData

func (*OneOfUnplannedFailoverRecoveryPlanApiResponseData) GetValue

func (p *OneOfUnplannedFailoverRecoveryPlanApiResponseData) GetValue() interface{}

func (*OneOfUnplannedFailoverRecoveryPlanApiResponseData) MarshalJSON

func (*OneOfUnplannedFailoverRecoveryPlanApiResponseData) SetValue

func (p *OneOfUnplannedFailoverRecoveryPlanApiResponseData) SetValue(v interface{}) error

func (*OneOfUnplannedFailoverRecoveryPlanApiResponseData) UnmarshalJSON

type OneOfValidateRecoveryPlanApiResponseData

type OneOfValidateRecoveryPlanApiResponseData struct {
	Discriminator *string `json:"-"`
	ObjectType_   *string `json:"-"`
	// contains filtered or unexported fields
}

func NewOneOfValidateRecoveryPlanApiResponseData

func NewOneOfValidateRecoveryPlanApiResponseData() *OneOfValidateRecoveryPlanApiResponseData

func (*OneOfValidateRecoveryPlanApiResponseData) GetValue

func (p *OneOfValidateRecoveryPlanApiResponseData) GetValue() interface{}

func (*OneOfValidateRecoveryPlanApiResponseData) MarshalJSON

func (p *OneOfValidateRecoveryPlanApiResponseData) MarshalJSON() ([]byte, error)

func (*OneOfValidateRecoveryPlanApiResponseData) SetValue

func (p *OneOfValidateRecoveryPlanApiResponseData) SetValue(v interface{}) error

func (*OneOfValidateRecoveryPlanApiResponseData) UnmarshalJSON

func (p *OneOfValidateRecoveryPlanApiResponseData) UnmarshalJSON(b []byte) error

type PlannedFailoverRecoveryPlanApiResponse

type PlannedFailoverRecoveryPlanApiResponse struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*

	 */
	DataItemDiscriminator_ *string `json:"$dataItemDiscriminator,omitempty"`

	Data *OneOfPlannedFailoverRecoveryPlanApiResponseData `json:"data,omitempty"`

	Metadata *import4.ApiResponseMetadata `json:"metadata,omitempty"`
}

REST response for all response codes in API path /dataprotection/v4.2/operations/recovery-plans/{recoveryPlanExtId}/$actions/planned-failover Post operation

func NewPlannedFailoverRecoveryPlanApiResponse

func NewPlannedFailoverRecoveryPlanApiResponse() *PlannedFailoverRecoveryPlanApiResponse

func (*PlannedFailoverRecoveryPlanApiResponse) GetData

func (p *PlannedFailoverRecoveryPlanApiResponse) GetData() interface{}

func (*PlannedFailoverRecoveryPlanApiResponse) MarshalJSON

func (p *PlannedFailoverRecoveryPlanApiResponse) MarshalJSON() ([]byte, error)

func (*PlannedFailoverRecoveryPlanApiResponse) SetData

func (p *PlannedFailoverRecoveryPlanApiResponse) SetData(v interface{}) error

func (*PlannedFailoverRecoveryPlanApiResponse) UnmarshalJSON

func (p *PlannedFailoverRecoveryPlanApiResponse) UnmarshalJSON(b []byte) error

type PlannedFailoverSpec

type PlannedFailoverSpec struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.
	*/
	FailoverDirections []import1.FailoverDirection `json:"failoverDirections"`
	/*
	  Name of the Recovery Plan Job.
	*/
	Name *string `json:"name"`
	/*
	  Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing `shouldIgnoreWarnings` as `true`. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan.
	*/
	ShouldIgnoreWarnings *bool `json:"shouldIgnoreWarnings,omitempty"`
	/*
	  Indicates whether to perform a live migration of virtual machines (VMs) during a `PLANNED_FAILOVER` operation. When not specified or specified as false, the migration is performed for all virtual machines (VMs) in offline mode. When specified as true, the migration is performed for all virtual machines (VMs) in a running state.
	*/
	ShouldLiveMigrateVMs *bool `json:"shouldLiveMigrateVMs,omitempty"`
}

The planned failover recovery plan action is used to perform a planned failover on the recovery plan.

func NewPlannedFailoverSpec

func NewPlannedFailoverSpec() *PlannedFailoverSpec

func (*PlannedFailoverSpec) MarshalJSON

func (p *PlannedFailoverSpec) MarshalJSON() ([]byte, error)

func (*PlannedFailoverSpec) UnmarshalJSON

func (p *PlannedFailoverSpec) UnmarshalJSON(b []byte) error

type TestFailoverRecoveryPlanApiResponse

type TestFailoverRecoveryPlanApiResponse struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*

	 */
	DataItemDiscriminator_ *string `json:"$dataItemDiscriminator,omitempty"`

	Data *OneOfTestFailoverRecoveryPlanApiResponseData `json:"data,omitempty"`

	Metadata *import4.ApiResponseMetadata `json:"metadata,omitempty"`
}

REST response for all response codes in API path /dataprotection/v4.2/operations/recovery-plans/{recoveryPlanExtId}/$actions/test-failover Post operation

func NewTestFailoverRecoveryPlanApiResponse

func NewTestFailoverRecoveryPlanApiResponse() *TestFailoverRecoveryPlanApiResponse

func (*TestFailoverRecoveryPlanApiResponse) GetData

func (p *TestFailoverRecoveryPlanApiResponse) GetData() interface{}

func (*TestFailoverRecoveryPlanApiResponse) MarshalJSON

func (p *TestFailoverRecoveryPlanApiResponse) MarshalJSON() ([]byte, error)

func (*TestFailoverRecoveryPlanApiResponse) SetData

func (p *TestFailoverRecoveryPlanApiResponse) SetData(v interface{}) error

func (*TestFailoverRecoveryPlanApiResponse) UnmarshalJSON

func (p *TestFailoverRecoveryPlanApiResponse) UnmarshalJSON(b []byte) error

type TestFailoverSpec

type TestFailoverSpec struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.
	*/
	FailoverDirections []import1.FailoverDirection `json:"failoverDirections"`
	/*
	  Name of the Recovery Plan Job.
	*/
	Name *string `json:"name"`
	/*
	  Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing `shouldIgnoreWarnings` as `true`. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan.
	*/
	ShouldIgnoreWarnings *bool `json:"shouldIgnoreWarnings,omitempty"`
}

The test failover recovery plan action is used to perform a test failover on the recovery plan.

func NewTestFailoverSpec

func NewTestFailoverSpec() *TestFailoverSpec

func (*TestFailoverSpec) MarshalJSON

func (p *TestFailoverSpec) MarshalJSON() ([]byte, error)

func (*TestFailoverSpec) UnmarshalJSON

func (p *TestFailoverSpec) UnmarshalJSON(b []byte) error

type UnplannedFailoverRecoveryPlanApiResponse

type UnplannedFailoverRecoveryPlanApiResponse struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*

	 */
	DataItemDiscriminator_ *string `json:"$dataItemDiscriminator,omitempty"`

	Data *OneOfUnplannedFailoverRecoveryPlanApiResponseData `json:"data,omitempty"`

	Metadata *import4.ApiResponseMetadata `json:"metadata,omitempty"`
}

REST response for all response codes in API path /dataprotection/v4.2/operations/recovery-plans/{recoveryPlanExtId}/$actions/unplanned-failover Post operation

func NewUnplannedFailoverRecoveryPlanApiResponse

func NewUnplannedFailoverRecoveryPlanApiResponse() *UnplannedFailoverRecoveryPlanApiResponse

func (*UnplannedFailoverRecoveryPlanApiResponse) GetData

func (p *UnplannedFailoverRecoveryPlanApiResponse) GetData() interface{}

func (*UnplannedFailoverRecoveryPlanApiResponse) MarshalJSON

func (p *UnplannedFailoverRecoveryPlanApiResponse) MarshalJSON() ([]byte, error)

func (*UnplannedFailoverRecoveryPlanApiResponse) SetData

func (p *UnplannedFailoverRecoveryPlanApiResponse) SetData(v interface{}) error

func (*UnplannedFailoverRecoveryPlanApiResponse) UnmarshalJSON

func (p *UnplannedFailoverRecoveryPlanApiResponse) UnmarshalJSON(b []byte) error

type UnplannedFailoverSpec

type UnplannedFailoverSpec struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.
	*/
	FailoverDirections []import1.FailoverDirection `json:"failoverDirections"`
	/*
	  Name of the Recovery Plan Job.
	*/
	Name *string `json:"name"`
	/*
	  Point in time from which to restore the entities during an `UNPLANNED_FAILOVER` operation. Only ISO-8601 formatted timestamps are supported. For example, `2023-01-02T03:04:05Z`.<br> When specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the specified timestamp. If not specified, virtual machines (VMs) and volume groups are restored from the latest recovery points created on or before the start of the Recovery plan job.
	*/
	RecoveryReferenceTime *time.Time `json:"recoveryReferenceTime,omitempty"`
	/*
	  Indicates whether to continue the recovery plan action despite validation warnings. For example, if the IP of some virtual machines (VMs) cannot be preserved after recovery, the Recovery Plan action can still be initiated by passing `shouldIgnoreWarnings` as `true`. This value allows the recovery operations to continue despite the validation warnings. Alternatively, the user can choose to resolve the validation warnings and trigger another failover action on recovery plan.
	*/
	ShouldIgnoreWarnings *bool `json:"shouldIgnoreWarnings,omitempty"`
}

The unplanned failover recovery plan action is used to perform an unplanned failover on the recovery plan.

func NewUnplannedFailoverSpec

func NewUnplannedFailoverSpec() *UnplannedFailoverSpec

func (*UnplannedFailoverSpec) MarshalJSON

func (p *UnplannedFailoverSpec) MarshalJSON() ([]byte, error)

func (*UnplannedFailoverSpec) UnmarshalJSON

func (p *UnplannedFailoverSpec) UnmarshalJSON(b []byte) error

type ValidateRecoveryPlanApiResponse

type ValidateRecoveryPlanApiResponse struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*

	 */
	DataItemDiscriminator_ *string `json:"$dataItemDiscriminator,omitempty"`

	Data *OneOfValidateRecoveryPlanApiResponseData `json:"data,omitempty"`

	Metadata *import4.ApiResponseMetadata `json:"metadata,omitempty"`
}

REST response for all response codes in API path /dataprotection/v4.2/operations/recovery-plans/{recoveryPlanExtId}/$actions/validate Post operation

func NewValidateRecoveryPlanApiResponse

func NewValidateRecoveryPlanApiResponse() *ValidateRecoveryPlanApiResponse

func (*ValidateRecoveryPlanApiResponse) GetData

func (p *ValidateRecoveryPlanApiResponse) GetData() interface{}

func (*ValidateRecoveryPlanApiResponse) MarshalJSON

func (p *ValidateRecoveryPlanApiResponse) MarshalJSON() ([]byte, error)

func (*ValidateRecoveryPlanApiResponse) SetData

func (p *ValidateRecoveryPlanApiResponse) SetData(v interface{}) error

func (*ValidateRecoveryPlanApiResponse) UnmarshalJSON

func (p *ValidateRecoveryPlanApiResponse) UnmarshalJSON(b []byte) error

type ValidateSpec

type ValidateSpec struct {
	ObjectType_ *string `json:"$objectType,omitempty"`

	Reserved_ map[string]interface{} `json:"$reserved,omitempty"`

	UnknownFields_ map[string]interface{} `json:"$unknownFields,omitempty"`
	/*
	  List of failover directions from source disaster recovery location to target disaster recovery location.<br> For example, when failing over virtual machines (VMs) and volume groups from clusters C1, C2 registered to domain manager PC1 on source location to cluster C3 registered to domain manager PC1 on target location, there must be one direction between source location (PC1, C1) to target location (PC1, C3) and another mapping between source location (PC1, C2) and target location (PC1, C3).<br> Domain manager is a required parameter while describing disaster recovery location in failover directions.<br> When creating a Recovery Plan Job across two domain managers, the source clusters are not required.<br> Failover direction contains clusters only when failing over between primary and secondary clusters registered to the same domain manager.
	*/
	FailoverDirections []import1.FailoverDirection `json:"failoverDirections"`
	/*
	  Name of the Recovery Plan Job.
	*/
	Name *string `json:"name"`
}

func NewValidateSpec

func NewValidateSpec() *ValidateSpec

func (*ValidateSpec) MarshalJSON

func (p *ValidateSpec) MarshalJSON() ([]byte, error)

func (*ValidateSpec) UnmarshalJSON

func (p *ValidateSpec) UnmarshalJSON(b []byte) error

Jump to

Keyboard shortcuts

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