Vsan Performance Manager Vsan Perf Create Stats Object

Create the vSAN object/directory containing the vSAN Perf Stats DB.

Creation of the object also starts the collection of statistics as a side effect, i.e., it effectively enables the vSAN performance service. Profile can be 3 formats:

VirtualMachineEmptyProfileSpec means to use the empty vSAN policy. This is not the default policy, but a policy where all fields have default values.
VirtualMachineDefinedProfileSpec where profileId is set, in which case this profileId will be looked up in SPBM for the detailed policy information.
VirtualMachineDefinedProfileSpec where profileId is an empty string and instead the profileData is set for extensionKey 'com.vmware.vim.sps'. In this case the objectData field can be either the vSAN expression format, or a SPBM XML string.

If no profile is supplied, and the call is executed against vCenter, then SPBM will be consulted for the vSAN datastore's default profile.

Profile is ignored if executed against ESXi host.

If the vSAN object is already exist, return directly.
If vSAN is disabled, DestinationVsanDisabled exception will be raised.
If SPBM needs to be contacted, but SPBM is not available, RuntimeFault exception will be raised.
If the profileId can not be resolved with SPBM, InvalidArgument exception will be raised.
If objectData was provided but is neither of the two supported formats, InvalidArgument exception will be raised.
If the statsDB object can not be found, FileNotFound exception will be raised.
If the statsDB object failed to set the policy, e.g. because it is not accessible, FileNotWritable exception will be raised.
If called against VC, but no ESX host could be contacted to perform the operation NotFound exception will be raised.

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfCreateStatsObject

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

string

release

Required

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

Request Body

VsanPerfCreateStatsObjectRequestType of type(s) application/json

Required

"VsanPerfCreateStatsObjectRequestType Object"

cluster

Optional

vSAN cluster. Ignored if called against host.

Required privileges: Host.Inventory.EditCluster

profile

Optional

Profile to be used for the stats object, see above.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

mounted path of the vSAN stats object (using "/" as path separator) i.e. /vmfs/volumes/vsan:525218c52dce3d62-e51a774ec7aef712/

Returns string of type(s) application/json

Operation doesn't return any data structure

500

VsanFault: if the pre-check tests failed.

FileAlreadyExists: if the stats object already exists.

CannotCreateFile: if it cannot complete file creation operation.

NotFound: if no ESXi host could be contacted to perform the operation when called against vCenter.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: InlineMethodFault0

"MethodFault Object"

faultCause

Optional

Fault which is the cause of this fault.

array of object

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfCreateStatsObject

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan Performance Manager Vsan Perf Create Stats Object