Execute Site Recovery Health Check

Request a customized site recovery health check execution for the specified Deployment. If no execute required specified, all applicable site recovery info and issue types will be selected for the site recovery health check execution.

Request

URI

POST

https://{api_host}/api/vsr-guardrails/{org_id}/deployments/{deployment_id}/site-recovery:check-health

COPY

Path Parameters

string

org_id

Required

organization identifier

string

deployment_id

Required

Deployment identifier

Request Body

Site recovery health check request

HealthCheckExecuteRequest of type(s) application/json

Optional

Show optional properties

{
    "selected_issue_types": [
        {}
    ]
}

{
    "selected_info_types": [
        "string"
    ],
    "selected_issue_types": [
        "string"
    ]
}

array of string

selected_info_types

Optional

Selected site recovery info types to collect

Possible values are : SITE_RECOVERY_SITE_PAIRS, SITE_RECOVERY_METRICS, REPLICATION_SUMMARY, RECOVERY_PLAN_SUMMARY,

array of string

selected_issue_types

Required

Selected site recovery issue types to check

Possible values are : HMS_ISSUE, HMS_REPLICATION_ISSUE, SRM_DATASTORE_CONFIG_ISSUE, RESOURCE_MAPPING_MISMATCH, REPLICATION_FOLDER_ISSUE, DUPLICATE_CTK_FILE_POINTER, ORPHAN_DATASTORE_PATH_ISSUE, VMDK_SNAPSHOT_ISSUE, FSXN_DATASTORE_REPLICATION,

Responses

201

Created

Returns Operation of type(s) application/json

"Operation Object"

string

Optional

Identifier of the operation

string

org_id

Required

Identifier of the organization

string

operation_type

Required

Type of the operation

string

resource_type

Optional

Resource type to perform the operation

string

resource_id

Optional

Identifier of the resource

string

task_id

Optional

Identifier of scheduler task created for operation

object

operation_config

Optional

Extra config info of the operation

object

output

Optional

Output of the operation

string

state

Optional

Operation state

object

task_details

Optional

Details of scheduler task created for operation

string As date-time As date-time

created_timestamp

Optional

The created timestamp

string As date-time As date-time

updated_timestamp

Optional

The updated timestamp

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"selected_issue_types":["string"]}' https://{api_host}/api/vsr-guardrails/{org_id}/deployments/{deployment_id}/site-recovery:check-health

On This Page

Description

Request

Path Parameters

Request Body

Response

201 Response Body

Errors

Site Recovery Health Report Operations

POST

Execute Site Recovery Health Check

GET