Changed1
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api

Edit Recovery Steps Callout

Description

Modify a callout/prompt to the list of recovery steps in a given recovery view mode.

Will fail if cannot retrieve recovery steps in the desired mode in the current recovery plan state or the recovery step is not callout/prompt-related.

Request

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/recovery-steps/{view_mode}/{recovery_step_id}/callout-data/actions/edit
Copy

Path Parameters

Path Parameters

string
pairing_id Required

The ID of a pairing between this Site Recovery Manager server and remote one.


string
plan_id Required

The ID of a recovery plan defined within current pairing.


string
view_mode Required

The view mode of the recovery steps. Possible values are: test, recovery, cleanup, reprotect.


string
recovery_step_id Required

Id of a recovery step.


Request Body

Request Body

CalloutModifySpec of mimetype application/json Required

Spec describing the new callout settings.

{
	"callout_type": "PROMPT",
	"content": "string",
	"name": "string",
	"timeout_seconds": 0
}
string
callout_type Required

Callout type.

  • PROMPT - If the callout is a prompt, it will pause the execution of the recovery script and will display a message until the user acknowledges it.
  • RUN_ON_VM - The callout must run inside the recovered VM.
  • RUN_ON_SRM_SERVER - The callout must run inside the Site Recovery Manager virtual machine.

Possible values are: PROMPTRUN_ON_VMRUN_ON_SRM_SERVER


string
content Required

Content of the callout.


string
name Required

Name of the callout.


integer as int32
timeout_seconds Required

Time in seconds to wait until the command completes.

If the command is not complete when the timeout occurs, the child process will be stopped.

Applicable only when parameter callout_type is RUN_ON_VM or RUN_ON_SRM_SERVER.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns TaskDrResponseEntity of type application/json

Task to monitor the operation progress.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"complete_time": 0,
	"description": "string",
	"description_id": "string",
	"entity": "string",
	"entity_name": "string",
	"error": {
		"details": "string",
		"message": "string"
	},
	"id": "string",
	"progress": 0,
	"queued_time": 0,
	"result": {},
	"start_time": 0,
	"status": "QUEUED"
}
_meta Optional

Response meta data. Contains data about the response payload data.

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

PowerCLI Client SDK Example

$CalloutModifySpec = Initialize-SrmCalloutModifySpec -Name "MyName" -Content "MyContent" -CalloutType "PROMPT" -TimeoutSeconds 0
Invoke-SrmEditRecoveryStepsCallout -pairingId "MypairingId" -planId "MyplanId" -viewMode "MyviewMode" -recoveryStepId "MyrecoveryStepId" -calloutModifySpec $calloutModifySpec

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"callout_type":"PROMPT","content":"string","name":"string","timeout_seconds":0}' https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/recovery-steps/{view_mode}/{recovery_step_id}/callout-data/actions/edit


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
What's changed in latest?
INTRODUCED
Recovery Operations
Feedback

Was this page helpful?