Create Recovery Steps Callout
DescriptionAdd 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.
Request
URLURL
Path Parameters
Path Parameters
The ID of a pairing between this Site Recovery Manager server and remote one.
The ID of a recovery plan defined within current pairing.
The view mode of the recovery steps. Possible values are: test
, recovery
, cleanup
, reprotect
.
Request Body
{
"callout_type": "PROMPT",
"content": "string",
"name": "string",
"position": 0,
"timeout_seconds": 0
}
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: PROMPT , RUN_ON_VM , RUN_ON_SRM_SERVER
Content of the callout.
Name of the callout.
A position in the current recovery steps list.
Zero-based.
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
Response
Response BodyResponse Body
202 Accepted
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"
}
Errors
Bad request - the server could not understand the request due to invalid syntax or invalid request body content
Unauthorized - the client must authenticate itself to get the requested response
Forbidden - not sufficient access rights to fulfill the request
Not Found - server cannot find the requested in URL resource
Internal server error - unexpected condition prevents fulfilling the request