Direct Path Profile Manager Direct Path Profile Manager Query Capacity

Direct Path Profile Manager Direct Path Profile Manager Query Capacity

Query capacity of DirectPath profiles against a compute resource.

Since: vSphere API Release 9.0.0.0

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/DirectPathProfileManager/{moId}/DirectPathProfileManagerQueryCapacity
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 DirectPathProfileManager/{moId}.

string
release
Required

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

Request Body
DirectPathProfileManagerQueryCapacityRequestType of type(s) application/json
Required 
"DirectPathProfileManagerQueryCapacityRequestType Object"
target
Required

specifies the compute resource for which the capacity needs to be computed. See DirectPathProfileManagerTargetEntity. A null or an invalid target will cause an exception.

array of object
querySpec
Optional

specifies a list of DirectPathProfileManagerCapacityQuerySpec, where each of them specifies the information about the DirectPath profile for which capacity needs to be computed.

Authentication
This operation uses the following authentication methods.
Responses
200

List of DirectPathProfileManagerCapacityResult when target is valid. The content of the list is subjected to the following conditions: - Content of the return list will be in the same order as content of the list in querySpec argument, except when querySpec is a null or empty list. - If the query specification is of type DirectPathProfileManagerCapacityQueryById, then the capacity of a DirectPath profile with the matching ID is returned. - If the query specification is of type DirectPathProfileManagerCapacityQueryByName, then the capacity of a DirectPath profile with the matching name is returned. - If the query specification is of type DirectPathProfileManagerCapacityQueryByDeviceConfig, then the capacity of a device with the specified configuration in the specified Target will be returned. - When querySpec is null or an empty list, the returned list contains DirectPathProfileManagerCapacityInfo of all the DirectPath profiles available in the specified target.

[
    "DirectPathProfileManagerCapacityResult Object"
]
array of DirectPathProfileManagerCapacityResult
Optional

500

InvalidArgument: when target is null or contains invalid content such as invalid host or cluster.

Returns InvalidArgument of type(s) application/json 
"InvalidArgument Object"
string
invalidProperty
Optional

Optional name of the invalid property.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/DirectPathProfileManager/{moId}/DirectPathProfileManagerQueryCapacity
Availability
Added in vSphere API Release 9.0.0.0
On This Page
Virtual Infrastructure Operations
POST
Direct Path Profile Manager Direct Path Profile Manager Create
POST
Direct Path Profile Manager Direct Path Profile Manager Delete
POST
Direct Path Profile Manager Direct Path Profile Manager List
POST
Direct Path Profile Manager Direct Path Profile Manager Query Capacity
POST
Direct Path Profile Manager Direct Path Profile Manager Update