Update Clusters Software Reports Hardware Compatibility Storage Device Overrides Compliance Status Task

Updates the Compliance staus overrides for storage devices in a cluster. This operation also updates the existing CheckResult if any, based on the device reclassification specified in ComplianceStatus.UpdateSpec The storage device categorization based on the compliance status from the last check result will remain the same until a HardwareCompatibility.check operation is invoked.

Request

URL

PATCH

https://{api_host}/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/storage-device-overrides/compliance-status?vmw-task=true

Copy

Path Parameters

string

cluster Required

Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Header Parameters

string

vmware-api-session-id Required

Required session ID, acquired from Create Session API under CIS product

vmware-api-session-id example

"b00db39f948d13ea1e59b4d6fce56389"

Request Body

SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusUpdateSpec of mimetype application/json Required

Specification for updating the compliance status overrides for storage devices in a cluster.

Show optional properties

{
	"device_reclassifications": [
		{
			"key": {
				"capacity": 0,
				"model": "string",
				"vendor": "string"
			}
		}
	]
}

{
	"device_reclassifications": [
		{
			"key": {
				"capacity": 0,
				"driver_name": "string",
				"driver_version": "string",
				"firmware_version": "string",
				"model": "string",
				"part_number": "string",
				"release": "string",
				"validated_features_in_use": {
					"key": "string"
				},
				"vendor": "string"
			},
			"override": "MARK_AS_VERIFIED"
		}
	]
}

array of SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusReclassificationSpec

device_reclassifications Required

List of compatibility overrides to be applied for the storage devices in a cluster.

Authentication

This operation uses the following authentication methods.

api_key

Response

Response Body

202 Accepted returns string of type application/json

An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists.

Errors

Error

400

com.vmware.vapi.std.errors.invalid_argument : if one of the values in the update specification is invalid.

Error

401

com.vmware.vapi.std.errors.unauthenticated : if the user cannot be authenticated.

Error

403

com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.

Error

404

com.vmware.vapi.std.errors.not_found : if there is no cluster associated with the cluster

Error

500

com.vmware.vapi.std.errors.error : if there is an unknown error. The accompanying error message will give more details about the failure.

Error

default

‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.

Code Samples

PowerCLI Client SDK Example

Show example with all parameters

$SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusReclassificationSpec = Initialize-SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusReclassificationSpec -Key $SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusKey

$SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusUpdateSpec = Initialize-SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusUpdateSpec -DeviceReclassifications $SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusReclassificationSpec

Invoke-UpdateClusterStorageDeviceOverridesComplianceStatusAsync -Cluster "MyCluster" -SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusUpdateSpec $SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusUpdateSpec

PowerCLI Client SDK All Parameters Example

$SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusKey = Initialize-SettingsClustersSoftwareReportsHardwareCompatibilityStorageDeviceOverridesComplianceStatusKey -Model "MyModel" -Vendor "MyVendor" -Capacity 0 -PartNumber "MyPartNumber" -FirmwareVersion "MyFirmwareVersion" -DriverName "MyDriverName" -DriverVersion "MyDriverVersion" -Release "MyRelease" -ValidatedFeaturesInUse @{ key_example = "MyInner" }

cURL Command

curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"device_reclassifications":[{"key":{"capacity":0,"driver_name":"string","driver_version":"string","firmware_version":"string","model":"string","part_number":"string","release":"string","validated_features_in_use":{"key":"string"},"vendor":"string"},"override":"MARK_AS_VERIFIED"}]}' https://{api_host}/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/storage-device-overrides/compliance-status?vmw-task=true

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmw-doc-operation: update_task

Availability

Added in 7.0.2.1

Update Clusters Software Reports Hardware Compatibility Storage Device Overrides Compliance Status Task

On This Page

Request

URL

Path Parameters

Header Parameters

vmware-api-session-id example

Request Body

Authentication

api_key

Response

Response Body

Errors

Code Samples

PowerCLI Client SDK Example

PowerCLI Client SDK All Parameters Example

cURL Command

Vendor Extensions

Availability

On This Page

Was this page helpful?