Vsan Performance Manager Vsan Perf Set Stats Object Policy
Set the policy of the vSAN object/directory containing the vSAN Perf Stats DB.
The cluster parameter is ignored if called on ESXi. Profile can be 3 formats:
- 1. VirtualMachineEmptyProfileSpec means to use the empty vSAN policy. This is not the default policy, but a policy where all fields have default values.
- 2. VirtualMachineDefinedProfileSpec where profileId is set, in which case this profileId will be looked up in SPBM for the detailed policy information.
- 3. 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.
When this method returns successfully, the profile has been applied, but vSAN may still be remediating in order to implement the new policy. The health state of the object and resync information should be monitored to check on the progress.
Only the third option is available when called on ESXi, other formats will raise InvalidArgument exception.
Exception:
- 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 vCenter, but no ESXi host could be contacted to perform the operation NotFound exception will be raised.
Python code example:
spec = vim.vm.DefinedProfileSpec()
VsanPerfSetStatsObjectPolicy(self.clusterRef, spec)
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}
.
The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.
"VsanPerfSetStatsObjectPolicyRequestType Object"
vSAN cluster. Ignored if called against host.
Required privileges: Host.Inventory.EditCluster
See above description for all possible options.
True
NotFound: if no ESXi host could be contacted to perform the operation when called against vCenter.
VsanFault: if the caller doesn't have the required privilege
"MethodFault Object"
Fault which is the cause of this fault.
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.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanPerformanceManager/{moId}/VsanPerfSetStatsObjectPolicy