Vsan File Service System Vsan Download File Service Ovf

Downloads a file service OVF file of the specified version from VMware website and install it to the OVF repository in vCenter.

Required privileges: Global.VCServer

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanDownloadFileServiceOvf

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 VsanFileServiceSystem/{moId}.

string

release

Required

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

Request Body

VsanDownloadFileServiceOvfRequestType of type(s) application/json

Required

{
    "downloadUrl": "string"
}

string

downloadUrl

Required

URL to download the vSAN file service OVF, only HTTPS URL is supported.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Task for tracking the OVF installation.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

InvalidArgument: Exception if the OVF of the specified version does not exist as specified in the source URL.

Returns InvalidArgument of type(s) application/json

This response body class contains all of the following: RuntimeFault

{
    "_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"
        }
    ],
    "invalidProperty": "string"
}

string

invalidProperty

Optional

Optional name of the invalid property.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"downloadUrl":"string"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanFileServiceSystem/{moId}/VsanDownloadFileServiceOvf

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan File Service System Vsan Cluster Create Fs Domain