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

Constraints: minimum: 0 maximum: 59999

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

Constraints: minimum: 0

A position in the current recovery steps list.

Zero-based.

Authentication

This operation uses the following authentication methods.

SessionHeader

Responses

202

Task to monitor the operation progress.

Returns TaskDrResponseEntity of type(s) application/json

This response body class contains all of the following: InlineTaskDrResponseEntity0 , InlineTaskDrResponseEntity1

"TaskDrResponseEntity Object"

400

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

Returns ResponseError of type(s) application/json

"ResponseError Object"

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

"ResponseError Object"

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

"ResponseError Object"

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.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"callout_type:"string","content:"string","name:"string","position:"integer","timeout_seconds:"integer"}' https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/recovery-steps/{view_mode}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Recovery Operations

GET

Get All Plan History Records