Test Search VMware Storage Policy API

A reference to the PbmPlacementSolver used to make the method call.

hubsToSearch*

PbmPlacementCompatibilityResult[]

Candidate list of hubs, either datastores or storage pods or a mix. If this parameter is not specified, the Server uses all of the datastores and storage pods for placement compatibility checking.

Since 1.0

profile

PbmProfileId

Storage requirement profile.

Since 1.0

*Need not be set

Return Value

Type Description

Type	Description
PbmPlacementCompatibilityResult[]	Array of compatibility result objects. The results array contains one entry for each entry in the `hubsToSearch` list. If a hubs list is not specified, the results array contains one entry for each datastore and storage pod in your vSphere environment. Any errors are described in the results array. If there is an invalid argument error, the compatibility results will contain `InvalidArgument` faults indicating that the profile does not exist or that it does not match the requirement type. If there are errors or warnings during compatibility checking, the compatibility results will contain faults derived from PbmCompatibilityCheckFault. If this method is invoked for pbm.profile.CapabilityBasedProfile.SystemCreatedProfileType#VVolDefaultProfile then the compatibility results will contain faults derived from PbmCompatibilityCheckFault for non-vvol datastores.

Array of compatibility result objects. The results array contains one entry for each entry in the hubsToSearch list. If a hubs list is not specified, the results array contains one entry for each datastore and storage pod in your vSphere environment. Any errors are described in the results array.

If there is an invalid argument error, the compatibility results will contain InvalidArgument faults indicating that the profile does not exist or that it does not match the requirement type.
If there are errors or warnings during compatibility checking, the compatibility results will contain faults derived from PbmCompatibilityCheckFault.
If this method is invoked for pbm.profile.CapabilityBasedProfile.SystemCreatedProfileType#VVolDefaultProfile then the compatibility results will contain faults derived from PbmCompatibilityCheckFault for non-vvol datastores.

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="PbmCheckCompatibility" type="pbm:PbmCheckCompatibilityRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="PbmCheckCompatibilityResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm:PbmPlacementCompatibilityResult" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

PbmCheckCompatibilityWithSpec(checkCompatibilityWithSpec)

Deprecated. As of vSphere 2016, use ServerObjectRef, Requirement[]) instead in order to retrieve compatibility status for both compute and storage location.

Performs placement compatibility checking based on a storage profile specification. If compatibility checking for a hub does not produce any errors, the hub is considered a viable candidate for virtual machine file storage.

Required Privileges: StorageProfile.View

Parameters

Name

Type

Description

_this

A reference to the PbmPlacementSolver used to make the method call.

hubsToSearch*

PbmCapabilityProfileCreateSpec

Candidate list of hubs, either datastores or storage pods or a mix. If this parameter is not specified, the Server uses all of the datastores and storage pods for placement compatibility checking.

Since 1.0

profileSpec

Specification for a capability based profile.

Since 1.0

*Need not be set

Return Value

Type Description

Type	Description
PbmPlacementCompatibilityResult[]	Array of compatibility result objects. The results array contains one entry for each entry in the `hubsToSearch` list. If a hubs list is not specified, the results array contains one entry for each datastore and storage pod in your vSphere environment. Any errors are described in the results array. If there is an invalid argument error, the compatibility results will contain `InvalidArgument` faults indicating that the profile does not exist or that it does not match the requirement type. If there are errors or warnings during compatibility checking, the compatibility results will contain faults derived from PbmCompatibilityCheckFault.

PbmPlacementCompatibilityResult[]

If there is an invalid argument error, the compatibility results will contain InvalidArgument faults indicating that the profile does not exist or that it does not match the requirement type.
If there are errors or warnings during compatibility checking, the compatibility results will contain faults derived from PbmCompatibilityCheckFault.

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

PbmPlacementCompatibilityResult[]

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="PbmCheckCompatibilityWithSpec" type="pbm:PbmCheckCompatibilityWithSpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="PbmCheckCompatibilityWithSpecResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm:PbmPlacementCompatibilityResult" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

PbmCheckRequirements(checkRequirements)

Performs placement compatibility checking for the specified object to be placed based on its specified set of requirements. If compatibility checking for a hub does not produce any errors, the hub is considered a viable candidate for virtual machine storage.

Required Privileges: StorageProfile.View
Since: 6.5

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmPlacementSolver used to make the method call.
hubsToSearch*	PbmPlacementHub[]	Candidate list of hubs, either datastores or storage pods or a mix. If this parameter is not specified, the Server uses all of the datastores and storage pods for placement compatibility checking. *Since* 6.5
placementSubjectRef*	PbmServerObjectRef	reference to the object being placed. Should be null when a new object is being provisioned. Should be specified when placement compatibility is being checked for an existing object. Supported objects are pbm.ServerObjectRef.ObjectType#virtualMachine, pbm.ServerObjectRef.ObjectType#virtualMachineAndDisks, pbm.ServerObjectRef.ObjectType#virtualDiskId, pbm.ServerObjectRef.ObjectType#virtualDiskUUID *Since* 6.5
placementSubjectRequirement*	PbmPlacementRequirement[]	Requirements including the policy requirements, compute requirements and capacity requirements. It is invalid to specify no requirements. It is also invalid to specify duplicate requirements or multiple conflicting requirements such as specifying both PbmPlacementCapabilityConstraintsRequirement and PbmPlacementCapabilityProfileRequirement. *Since* 6.5

*Need not be set

Return Value

Type Description

Type	Description
PbmPlacementCompatibilityResult[]	Array of compatibility result objects. The results array contains one entry for each entry in the `hubsToSearch` list. If hubs list is not specified, the results array contains one entry for each datastore and storage pod in your vSphere environment. Any errors are returned in the results array. If there is an invalid argument error, the compatibility results will contain `InvalidArgument` faults indicating that the profile does not exist or that it does not match the requirement type. If there are errors or warnings during compatibility checking, the compatibility results will contain faults derived from PbmCompatibilityCheckFault.

Array of compatibility result objects. The results array contains one entry for each entry in the hubsToSearch list. If hubs list is not specified, the results array contains one entry for each datastore and storage pod in your vSphere environment. Any errors are returned in the results array.

If there is an invalid argument error, the compatibility results will contain InvalidArgument faults indicating that the profile does not exist or that it does not match the requirement type.
If there are errors or warnings during compatibility checking, the compatibility results will contain faults derived from PbmCompatibilityCheckFault.

Faults

Type	Description
PbmFault	Thrown if there is an internal server error.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="PbmCheckRequirements" type="pbm:PbmCheckRequirementsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="PbmCheckRequirementsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm:PbmPlacementCompatibilityResult" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

PbmQueryMatchingHub(queryMatchingHub)

Deprecated. As of vSphere 2016, use ServerObjectRef, Requirement[]) instead in order to retrieve both compatible compute and storage location.

Finds matching placement hubs for the specified requirements profile. This method returns only those hubs that match the profile. If this method is invoked for pbm.profile.CapabilityBasedProfile.SystemCreatedProfileType#VVolDefaultProfile profile, then all the VVOL containers are returned as matching.

Required Privileges: StorageProfile.View

Parameters

Name

Type

Description

_this

A reference to the PbmPlacementSolver used to make the method call.

hubsToSearch*

Candidate list of hubs, either datastores or storage pods or a mix. If this parameter is not specified, the Server uses all of the datastores and storage pods.

Since 1.0

profile

PbmProfileId

Storage requirement profile.

Since 1.0

*Need not be set

Return Value

Type	Description
PbmPlacementHub[]	Subset of the `hubsToSearch` list that satisfies the profile requirements. A storage pod is returned if and only if all its member datastores satisfy the profile requirements, whether the hubs list contains any of the member datastores or not. If a datastore and its storage pod are in the hubs list, and both satisfy the requirements, both are returned.

Faults

Type	Description
PbmFault	Thrown if there is an internal server error.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="PbmQueryMatchingHub" type="pbm:PbmQueryMatchingHubRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="PbmQueryMatchingHubResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm:PbmPlacementHub" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

PbmQueryMatchingHubWithSpec(queryMatchingHubWithSpec)

Deprecated. As of vSphere 2016, use ServerObjectRef, Requirement[]) instead in order to retrieve both compatible compute and storage location.

Finds matching placement hubs based on a profile creation specification. This method returns only those hubs that match the specification.

Required Privileges: StorageProfile.View

Parameters

Name

Type

Description

_this

A reference to the PbmPlacementSolver used to make the method call.

hubsToSearch*

PbmCapabilityProfileCreateSpec

Candidate list of hubs, either datastores or storage pods or a mix. If this parameter is not specified, the Server uses all of the datastores and storage pods for placement compatibility checking.

Since 1.0

createSpec

Storage profile creation specification.

Since 1.0

*Need not be set

Return Value

Type	Description
PbmPlacementHub[]	Subset of the `hubsToSearch` list that satisfies the profile requirements. A storage pod is returned if and only if all its member datastores satisfy the profile requirements, whether the hubs list contains any of the member datastores or not. If a datastore and its storage pod are in the hubs list, and both satisfy the requirements, both are returned.

Faults

Type	Description
PbmFault	Thrown if there is an internal server error.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None