Validate
POST v1/volume_collections/id/actions/validate
Description
Validate a volume collection with either Microsoft VSS or VMware application synchronization.
Normal Response Codes
200
HTTP Error Codes
400 401 403 404 409 500 503
Detail Codes
Request
| Parameter | Type | JSON Type | Description | Mandatory |
|---|---|---|---|---|
| id | NsObjectID | string | ID of the volume collection that is to be validated. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | true |
JSON Request
{}
Response
Type: NsAppServerResp
| Member | Type | JSON Type | Description |
|---|---|---|---|
| general_error | NsErrorCode | string | Error code from app server. Non-negative integer in range [0,9000]. |
| app_sync | NsAppSyncType | string | Type of app server. Possible values: 'none', 'vss', 'vmware', 'generic'. |
| has_assoc_vols | NsBoolean | boolean | Indicates if there are associated volumes. Possible values: 'true', 'false'. |
| vss_response | NsVssResp | object | Response from vss app server. Response from VSS app server. |
| vmw_response | NsVmwareResp | object | Response from vmware app server. Response from Vmware app server. |
| generic_response | NsVmwareResp | object | Response from generic app server. Response from Vmware app server. |
JSON Response
{
"data": {
"general_error":0,
"app_sync":"vmware",
"has_assoc_vols":true,
"vss_response":{
"vss_error":0,
"vss_error_message":""
},
"vmw_response":{
"vmware_error":77,
"vmware_error_message":"Some vmware error message",
"conn_status_ok":false,
"conn_message":"Some vmware connection message",
"user_role_permission_ok":true,
"num_vms_for_volcoll":3,
"warning_vm_tools_status":[
"Sample Warning Message",
"Sample Warning Message",
"Sample Warning Message"
]
},
"generic_response":{
"generic_error":0,
"generic_error_message":"",
"conn_status_ok":true,
"conn_message":""
}
}
}