Check Storage Profiles
Returns the compatible management storage profiles for enabling a WCP Supervisor across a given set of zones. A storage profile is compatible if it results in at least one datastore in each of the specified zones.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/storage/profiles?action=check_compatibility
Header Parameters
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
Request Body
NamespaceManagementStorageProfilesFilterSpec of mimetype application/json
Required
Specification of the zones to consider when finding compatible storage profiles. The Profiles.FilterSpec must contain at least 1 zone.
{
"zones": [
"string"
]
}
array of
string
zones
Required
Zone compatibility criteria. The common storage profiles across the given zones will be returned. A storage profile is considered compatible if it results in at least one datastore in each of the given zones. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.consumption_domains.Zone. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.consumption_domains.Zone.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementStorageProfilesSummary
of type application/json
List of storage profiles compatible across the given Profiles.FilterSpec. The profiles returned will each result in at least one datastore in each zone.
[
{
"compatible": false,
"incompatibility_reasons": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"items": [
{
"datastores": [
"string"
],
"zone": "string"
}
],
"profile": "string",
"profile_name": "string"
}
]
boolean
compatible
Required
Compatibility of this storage profile with the specified vSphere Zones.
array of
StdLocalizableMessage
incompatibility_reasons
Required
The reason for incompatibility. If empty, this profile is compatible with the given vSphere Zones specified in the Profiles.FilterSpec.
items
Required
The list of Profiles.Item wich correspond to the storage profile.
string
profile
Required
Identifier of the compatible storage profile. A storage profile is compatible if it results in at least one datastore in each of the specified zones. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: SpsStorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: SpsStorageProfile.
string
profile_name
Required
Human-readable identifier of the storage profile.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if one or more fields of the Profiles.FilterSpec is incorrect.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege on all of the Cluster Compute Resources in the specified vSphere Zones.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
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
$NamespaceManagementStorageProfilesFilterSpec = Initialize-NamespaceManagementStorageProfilesFilterSpec -Zones "MyZones"
Invoke-CheckCompatibilityStorageProfiles -NamespaceManagementStorageProfilesFilterSpec $NamespaceManagementStorageProfilesFilterSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"zones":["string"]}' https://{api_host}/api/vcenter/namespace-management/storage/profiles?action=check_compatibility
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: check
Availability
Added in 8.0.0.1
