Create Recovery Steps Callout

Create Recovery Steps Callout

Add 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
URI
POST
https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/recovery-steps/{view_mode}
COPY
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.


Request Body

Spec describing the new callout settings.

CalloutCreateSpec of type(s) application/json
Required
{
    "name": "string",
    "content": "string",
    "callout_type": "string",
    "timeout_seconds": 0,
    "position": 0
}
string
name
Required

Name of the callout.

string
content
Required

Content of the callout.

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 : PROMPT, RUN_ON_VM, RUN_ON_SRM_SERVER,
integer As int32 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.

integer As int32 As int32
position
Required

A position in the current recovery steps list.

Zero-based.

Authentication
This operation uses the following authentication methods.
Responses
202

Task to monitor the operation progress.

Returns TaskDrResponseEntity of type(s) application/json
This response body class contains all of the following: Task
{
    "id": "string",
    "description": "string",
    "description_id": "string",
    "entity": "string",
    "entity_name": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "progress": 0,
    "queued_time": 0,
    "start_time": 0,
    "complete_time": 0,
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
_meta
Optional

_meta


400

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

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


401

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

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

The code of the error.

string
message
Optional

The message of the error.

string As uuid As uuid
op_id
Optional

The ID of the operation.


Recovery Operations
POST
Cancel Recovery Plan
POST
Create Plan
POST
Create Recovery Plan Folder
POST
Create Recovery Steps Callout
DELETE
Delete Recovery Plan
DELETE
Delete Recovery Plan Folder
DELETE
Delete Recovery Step
POST
Dismiss Recovery Steps Recovery Plan Prompt
POST
Edit Recovery Steps Callout
GET
Get All Plan History Records
GET
Get All Recovery Plans
GET
Get Plan History Record
GET
Get Plan History Records
GET
Get Plan Related Protection Groups
GET
Get Plan Related Test Networks
GET
Get Plan Virtual Machine
GET
Get Plan Virtual Machine Dependent Vms
GET
Get Plan Virtual Machine Ip Customization
GET
Get Plan Virtual Machine Recovery Priority
GET
Get Plan Virtual Machine Recovery Settings
GET
Get Plan Virtual Machines
GET
Get Plan Virtual Machine Summarized Recovery Settings
GET
Get Recovery Plan
GET
Get Recovery Plan Folder
GET
Get Recovery Plan Folder Children
GET
Get Recovery Plan Folders
GET
Get Recovery Plan Issues
GET
Get Recovery Step
GET
Get Recovery Steps
GET
Get Recovery Steps Callout Details
GET
Get Recovery Steps User Prompt
GET
Get Recovery Steps User Prompts
POST
Move Recovery Plan Folder
POST
Plan Virtual Machine Check Dependent Vms
POST
Reconfigure Recovery Plan
POST
Rename Recovery Plan Folder
POST
Run Cleanup Test Recovery
POST
Run Recovery
POST
Run Reprotect
POST
Run Test Recovery
POST
Update Plan Virtual Machine Dependent Vms
POST
Update Plan Virtual Machine Ip Customization
PUT
Update Plan Virtual Machine Recovery Priority
POST
Update Plan Virtual Machine Recovery Settings