Trigger Lcm Snapshot V2 Using POST

This API is used to take vRSLCM snapshot.

Request

URI

POST

https://{api_host}/lcm/lcops/api/v2/system-snapshot

COPY

Request Body

VCenterRequestDTO of type(s) application/json

Optional

{
    "vCenterHost": "vcenter-1.example.com",
    "vCenterName": "vCenter-1",
    "vcDataCollectionStatus": "SUCCESS",
    "vcPassword": "locker:password:<vmid>:<alias>",
    "vcUsedAs": "MANAGEMENT",
    "vcUsername": "administrator@vsphere.local"
}

string

vCenterHost

Optional

vCenter Server Host

string

vCenterName

Optional

vCenter Server Name

string

vcDataCollectionStatus

Optional

vCenter Data Collection Status

string

vcPassword

Optional

vCenter Server Password

string

vcUsedAs

Optional

vCenter Server Used As

string

vcUsername

Optional

vCenter Server Username

Authentication

This operation uses the following authentication methods.

Authorization

Responses

200

Returns GenericRequestResponse of type(s) application/json

{
    "requestId": "a0d8d8cd-ac87-4b5c-ba8b-7a0173c56b55"
}

string

requestId

Optional

Request ID

201

Created

Operation doesn't return any data structure

400

Bad Request

Returns GenericErrorResponseDTO of type(s) application/json

{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}

string

errorCode

Optional

errorCode

string

errorLabel

Optional

errorLabel

string

message

Optional

message

array of string

recommendations

Optional

recommendations

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json

{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}

string

errorCode

Optional

errorCode

string

errorLabel

Optional

errorLabel

string

message

Optional

message