Vsan Remote Datastore System Vsan Precheck Datastore Source

Run prechecks for a Datastore Source.

This can be used before creating, updating, destroying a Datastore Source or other places needing to verify a Datastore Source.

Required privileges: Host.Config.Storage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanRemoteDatastoreSystem/{moId}/VsanPrecheckDatastoreSource

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanRemoteDatastoreSystem/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.

Request Body

VsanPrecheckDatastoreSourceRequestType of type(s) application/json

Required

Show optional properties

{
    "datastoreSource": {}
}

{
    "datastoreSource": {
        "_typeName": "string",
        "vcInfo": {
            "_typeName": "string",
            "linkType": "string",
            "vcHost": "string"
        }
    },
    "operation": "string"
}

datastoreSource

Required

The information of the Datastore Source to be prechecked.

string

operation

Optional

The hint of the operation which the precheck is performed against, see PrecheckDatastoreSourceOperationEnum.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Pre-check results of the specified Datastore Source.

Returns VsanDatastoreSourcePrecheckResult of type(s) application/json

This response body class contains all of the following: VsanMountPrecheckResult

{
    "_typeName": "string",
    "result": [
        {
            "_typeName": "string",
            "type": "string",
            "description": {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            },
            "status": "string",
            "reason": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ],
            "ignoreMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    ]
}

500

VsanSslVerifyCertFault: SSL verification fault for remote vCenter such as certificate not verified.

VsanFault: Other vSAN related faults.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"datastoreSource":"{}"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanRemoteDatastoreSystem/{moId}/VsanPrecheckDatastoreSource

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan Remote Datastore System Vsan Create Datastore Source