Local Methods
Managed Object Types	Data Object Types	All Properties	All Methods

Managed Object - PbmProfileProfileManager(pbm.profile.ProfileManager)

Property of

PbmServiceInstanceContent

See also

PbmCapabilityMetadataPerCategory, PbmCapabilityProfileCreateSpec, PbmCapabilityProfileUpdateSpec, PbmCapabilitySchema, PbmCapabilityVendorResourceTypeInfo, PbmDatastoreSpaceStatistics, PbmDefaultProfileInfo, PbmPlacementHub, PbmProfile, PbmProfileId, PbmProfileOperationOutcome, PbmProfileResourceType, PbmQueryProfileResult, PbmServerObjectRef

Since

1.0

Managed Object Description

The PbmProfileProfileManager supports operations on virtual machine storage profiles. A Storage Policy API profile consists of a set of subprofiles. A subprofile corresponds to a rule set in the vSphere Web Client.

Virtual machine storage profiles specify the storage requirements for virtual machine files. You use the vSphere Web Client to define virtual machine storage profiles. The requirements (PbmCapabilityProfile.constraints) impose constraints on the placement of virtual machine files.

The Storage Policy Server also supports datastore profiles. Datastore profiles define storage capabilities. Storage capabilities are resources defined by storage providers. Storage requirements are based on storage capabilities. When you associate a storage profile with a virtual machine or virtual disk, the Server sends the profile to the storage provider. When you perform compliance checking (PbmComplianceManager), the storage provider compares the requirements with the capabilities.

The PbmProfileProfileManager supports the following operations on virtual machine storage profiles.

• Create, update, and delete storage profiles.
• Retrieve profile data based on specified criteria.
• Retrieve storage vendor data.

The following figure shows the set of data objects that comprise a storage profile specification (PbmCapabilityProfileCreateSpec). You pass a storage profile specification to the Storage Policy Server when you call the following methods:

• PbmProfileProfileManager.PbmCreate
• PbmPlacementSolver.PbmCheckCompatibilityWithSpec
• PbmPlacementSolver.PbmQueryMatchingHubWithSpec

 +---------------------------------+
 |  PbmCapabilityProfileCreateSpec |
 |                            name |     +-------------------------+
 |                     description |     |  PbmProfileResourceType |
 |                    resourceType ------|    resourceType=STORAGE |
 |                     constraints ---   +-------------------------+
 +---------------------------------+ |
                                     |
                                     |
        +------------------------------------+
        | PbmCapabilitySubProfileConstraints |
        |                        subprofiles ---
        +------------------------------------+ |
                                               | 1..n
                                               |
                          +-------------------------+
                          | PbmCapabilitySubProfile |
                          |                    name |
                          |          forceProvision |
                          |              capability ---
                          +-------------------------+ |
                                                      | 1..n            +-------------------------------+
                                                      |                 | PbmCapabilityMetadataUniqueId |
                                    +-----------------------+           |                            id |
                                    | PbmCapabilityInstance |           |                     namespace |
                                    |                    id ------------+-------------------------------+
                                    |            constraint ---
                                    +-----------------------+ |
                                                              | 1..n
                                                              |                +-------------------------------+
                                   +---------------------------------+         | PbmCapabilityPropertyInstance |
                                   | PbmCapabilityConstraintInstance |  1..n   |                            id |
                                   |                propertyInstance ----------|                         value |
                                   +---------------------------------+         +-------------------------------+
 

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object

PbmAssignDefaultRequirementProfile, PbmCreate, PbmDelete, PbmFetchCapabilityMetadata, PbmFetchCapabilitySchema, PbmFetchResourceType, PbmFetchVendorInfo, PbmFindApplicableDefaultProfile, PbmQueryAssociatedEntities, PbmQueryAssociatedEntity, PbmQueryAssociatedProfile, PbmQueryAssociatedProfiles, PbmQueryDefaultRequirementProfile, PbmQueryDefaultRequirementProfiles, PbmQueryProfile, PbmQuerySpaceStatsForStorageContainer, PbmResetDefaultRequirementProfile, PbmResetVSanDefaultProfile, PbmRetrieveContent, PbmUpdate

PbmAssignDefaultRequirementProfile(assignDefaultRequirementProfile)

Assign the given profile as the default profile for the given datastores. This is an atomic operation. Either all the datastores will be assigned the default profile or none will be. In addition to StorageProfile.Update privilege, it requires Datastore.UpdateVirtualMachineFiles privilege on the given datastores to change the default profile for the datastores. Otherwise a NoPermission fault is thrown.

Required Privileges

StorageProfile.Update

Since

2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
profile	PbmProfileId	The profile that needs to be made default profile. Since 2.0
datastores	PbmPlacementHub[]	The datastores for which the profile needs to be made as default profile. Since 2.0

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if one of the hub is not a datastore or profile cannot be used as default requirement profile for any of the hub.
PbmFault	Internal service error
PbmLegacyHubsNotSupported	Thrown if any of the hub in datastores argument is legacy (VMFS or NFS) datastores.
PbmNonExistentHubs	Thrown if any of the hub in datastores argument is non existent.
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

Show WSDL type definition

PbmCreate(create)

Creates a capability-based storage profile. A capability-based profile contains requirements that are derived from tag-defined capabilities or from VMware VSAN capabilities.

• Use the vSphere Web Client to define tags for capabilities.
• VSAN storage capabilities are system-defined.

A profile is a collection of subprofiles (PbmCapabilitySubProfile). A subprofile references storage capabilities and defines requirements based on those capabilities.

To define a storage requirement, you specify constraint property instance values (PbmCapabilityPropertyInstance) that use Storage Policy API builtin types (PbmBuiltinType) to create expressions for compliance checking.

The profile specification contains lists of constraint property instances (PbmCapabilityProfileCreateSpec.constraints.subProfiles[].capability[].constraint[].propertyInstance[]). The constraints are based on storage capabilities described in metadata (PbmCapabilityPropertyMetadata) and in the datastore profiles.

Required Privileges

StorageProfile.Update

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
createSpec	PbmCapabilityProfileCreateSpec	Capability-based profile specification. Since 1.0

Return Value

Type	Description
PbmProfileId	Identifier for the new profile.

Faults

Type	Description
InvalidArgument	Thrown if PbmCapabilityProfileCreateSpec is invalid.
PbmDuplicateName	Thrown if a profile with the same name already exists.
PbmFaultProfileStorageFault	Thrown if there is an error in persisting the profile.
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

Show WSDL type definition

PbmDelete(delete)

Deletes one or more profiles. If the method successfully deletes a profile, its identifier is no longer valid.

Required Privileges

StorageProfile.Update

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
profileId	PbmProfileId[]	Array of profile identifiers. Since 1.0

Return Value

Type

Description

PbmProfileOperationOutcome[]

Array of result objects, one for each profile specified in the call to the PbmDelete method. The result object contains the profile ID and, if an error occurred, it also describes the fault. The method can return one of the following faults if the profile cannot be deleted: InvalidArgument - Profile is not recognized by the system. PbmFaultProfileStorageFault - Internal service error. PbmResourceInUse - Profile is still associated with an entity.

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

Show WSDL type definition

PbmFetchCapabilityMetadata(fetchCapabilityMetadata)

Retrieves capability metadata.

Each capability metadata object has a unique identifier (PbmCapabilityMetadata.id). The identifier object (PbmCapabilityMetadataUniqueId) contains the unique ID and it identifies the namespace to which the capability metadata object belongs.

Each registered namespace is required to be globally unique. You can associate a capability metadata object with a unique vendor and resource type by using the namespace and the PbmCapabilityVendorResourceTypeInfo data returned by the PbmFetchVendorInfo method.

Required Privileges

StorageProfile.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
resourceType*	PbmProfileResourceType	Type of profile resource. The Server supports the "STORAGE" resource type only. If not specified, this method will return capability metadata for the storage resources. Any other resourceType is considered invalid. Since 1.0
vendorUuid*	xsd:string	Unique identifier for the vendor/owner of capability metadata. The specified vendor ID must match PbmCapabilitySchemaVendorInfo.vendorUuid. If omitted, the Server searchs all capability metadata registered with the system. If a vendorUuid unknown to the Server is specified, empty results will be returned. Since 1.0

*Need not be set

Return Value

Type	Description
PbmCapabilityMetadataPerCategory[]	Array of capability metadata objects, classified by category (PbmCapabilityMetadataPerCategory.subCategory).

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

Show WSDL type definition

PbmFetchCapabilitySchema(fetchCapabilitySchema)

Returns the capability schema objects registered in the system.

Required Privileges

StorageProfile.View

Since

6.5

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
vendorUuid*	xsd:string	Unique identifier for the vendor/owner of capability metadata. If omitted, the server searchs all capability metadata registered with the system. The specified vendor ID must match PbmCapabilitySchemaVendorInfo.vendorUuid. Since 6.5
lineOfService*	xsd:string[]	Optional line of service that must match PbmLineOfServiceInfoLineOfServiceEnum. If specified, the capability schema objects are returned for the given lineOfServices. If null, then all capability schema objects that may or may not have data service capabilities are returned. Since 6.5

*Need not be set

Return Value

Type	Description
PbmCapabilitySchema[]	Array of PbmCapabilitySchema

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

Show WSDL type definition

PbmFetchResourceType(fetchResourceType)

Retrieves information about various resource types registered with the system.

Required Privileges

StorageProfile.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.

Return Value

Type	Description
PbmProfileResourceType[]	Array of resource types.

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

Show WSDL type definition

PbmFetchVendorInfo(fetchVendorInfo)

Retrieve information about various capability metadata owners/vendors registered with the system, the resource type for which they are registered, and schema namespaces to which they belong.

Required Privileges

StorageProfile.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
resourceType*	PbmProfileResourceType	Specifies the resource type. The Server supports the STORAGE resource type only. If not specified, server defaults to STORAGE resource type. Any other resourceType is considered invalid. Since 1.0

*Need not be set

Return Value

Type	Description
PbmCapabilityVendorResourceTypeInfo[]	Vendor and namespace information.

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

Show WSDL type definition

PbmFindApplicableDefaultProfile(findApplicableDefaultProfile)

Returns the profiles that can be made as default profile for all the given datastores. A profile can be made as a default profile for a datastore only if it contains a ruleset from the namespace the datastore belongs to.

Required Privileges

StorageProfile.View

Since

2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
datastores	PbmPlacementHub[]	Datastores for which the default profile is found out. Note that the datastore pods/clusters are not supported. Since 2.0

Return Value

Type	Description
PbmProfile[]	Profile[] Returns all the requirements profiles that can be made as default profile for the given datastores. If no profile can be made as default for all datastores, then an empty array is returned. Note that the profiles returned may or may not be compatible with the datastores.

Faults

Type	Description
InvalidArgument	Thrown if the datastores argument contains a non-datastore, example storage pod.
PbmFault	Internal service error.
PbmLegacyHubsNotSupported	Thrown if any of the hubs in datastores argument are legacy (VMFS or NFS) datastores.
PbmNonExistentHubs	Thrown if any of the hubs in datastores argument are non existent.
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

Show WSDL type definition

PbmQueryAssociatedEntities(queryAssociatedEntities)

Returns the virtual machine and disks that are associated with the given storage policies. If the profiles parameter is empty, then this API returns all the virtual machine and disks that are associated with some storage policy.

Required Privileges

StorageProfile.View

Since

6.5

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
profiles*	PbmProfileId[]	Storage policy array. Since 6.5

*Need not be set

Return Value

Type	Description
PbmQueryProfileResult[]	Array of QueryProfileResult

Faults

Type	Description
PbmFault	Thrown if there is an internal service 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

Show WSDL type definition

PbmQueryAssociatedEntity(queryAssociatedEntity)

Retrieves entities associated with the specified profile.

Required Privileges

StorageProfile.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
profile	PbmProfileId	Profile identifier. Since 1.0
entityType*	xsd:string	If specified, the method returns only those entities which match the type. The entityType string value must match one of the PbmObjectType values. If not specified, the method returns all entities associated with the profile. Since 1.0

*Need not be set

Return Value

Type	Description
PbmServerObjectRef[]	Array of entities associated with the profile.

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

Show WSDL type definition

PbmQueryAssociatedProfile(queryAssociatedProfile)

Returns identifiers for profiles associated with a virtual machine, virtual disk, or datastore.

Required Privileges

StorageProfile.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
entity	PbmServerObjectRef	Reference to a virtual machine, virtual disk, or datastore. Since 1.0

Return Value

Type	Description
PbmProfileId[]	Array of profiles associated with the entity.

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

Show WSDL type definition

PbmQueryAssociatedProfiles(queryAssociatedProfiles)

Returns profiles associated with the specified entities.

Required Privileges

StorageProfile.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
entities	PbmServerObjectRef[]	Array of server object references. Since 1.0

Return Value

Type	Description
PbmQueryProfileResult[]	Array of query result objects. Each PbmQueryProfileResult object identifies a virtual machine, virtual disk, or datastore and it contains a list of the profiles associated with that entity. It also describes the fault, if there is an error associated with one of the profiles.

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

Show WSDL type definition

PbmQueryDefaultRequirementProfile(queryDefaultRequirementProfile)

Returns the default requirement profile ID for the given datastore. For legacy hub the API returns {@code null}.

Required Privileges

StorageProfile.View

Since

2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
hub	PbmPlacementHub	Placement hub (i.e. datastore). Since 2.0

Return Value

Type	Description
PbmProfileId	Profile Id of the Default Requirement Profile. For legacy hub the API returns {@code null}.

Faults

Type	Description
InvalidArgument	Thrown if hub is invalid (does not denote a datastore).
PbmFault	Internal service error.
PbmNonExistentHubs	Thrown if hub is non existent.
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

Show WSDL type definition

PbmQueryDefaultRequirementProfiles(queryDefaultRequirementProfiles)

Returns the default profiles for the given datastores. For legacy datastores we set {@code DefaultProfileInfo.defaultProfile} to {@code null}.

Required Privileges

StorageProfile.View

Since

2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
datastores	PbmPlacementHub[]	The datastores for which the default profiles are requested. For legacy datastores we set {@code DefaultProfileInfo.defaultProfile} to {@code null}. Since 2.0

Return Value

Type	Description
PbmDefaultProfileInfo[]	DefaultProfileInfo Default profile information.

Faults

Type	Description
InvalidArgument	Thrown if one of the datastore is invalid (does not denote a datastore).
PbmFault	Internal service error.
PbmNonExistentHubs	Thrown if any of the datastore in datastores argument are non existent.
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

Show WSDL type definition

PbmQueryProfile(queryProfile)

Returns requirement profile ids or resource profile ids, or both.

Required Privileges

StorageProfile.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
resourceType	PbmProfileResourceType	Type of resource. You can specify only STORAGE. Since 1.0
profileCategory*	xsd:string	Profile category. The string value must correspond to one of the PbmProfileCategoryEnum values. If you do not specify a profile category, the method returns profiles in all categories. Since 1.0

*Need not be set

Return Value

Type	Description
PbmProfileId[]	Array of storage profile identifiers.

Faults

Type	Description
InvalidArgument	Thrown if the Server does not recognize the specified resourceType or profileCategory.
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

Show WSDL type definition

PbmQuerySpaceStatsForStorageContainer(querySpaceStatsForStorageContainer)

Retrieves space statistics of a datastore.

Required Privileges

StorageProfile.View

Since

2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
datastore	PbmServerObjectRef	Entity for which space statistics are being requested i.e datastore. Since 2.0
capabilityProfileId*	PbmProfileId[]	- capability profile Ids. If omitted, the statistics for the container as a whole would be returned. Since 2.0

*Need not be set

Return Value

Type	Description
PbmDatastoreSpaceStatistics[]	Array of Space stats of datastore for each capabilityProfileId.

Faults

Type	Description
InvalidArgument	- Thrown if the input datastore parameter is null or its type is not datastore or its key is empty.
PbmFault	- Thrown if server internal error occurred or if storage container does not support the profile.
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

Show WSDL type definition

PbmResetDefaultRequirementProfile(resetDefaultRequirementProfile)

Deprecated. since it is not supported.

Not supported in this release.

Required Privileges

StorageProfile.Update

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
profile*	PbmProfileId	Profile to reset. Since 1.0

*Need not be set

Return Value

Type	Description
None

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

Show WSDL type definition

PbmResetVSanDefaultProfile(resetVSanDefaultProfile)

Resets the system pre-created VSAN default profile to factory defaults.

Required Privileges

StorageProfile.Update

Since

2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.

Return Value

Type	Description
None

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

Show WSDL type definition

PbmRetrieveContent(retrieveContent)

Returns one or more storage profiles.

Required Privileges

StorageProfile.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
profileIds	PbmProfileId[]	Array of storage profile identifiers. Since 1.0

Return Value

Type	Description
PbmProfile[]	Array of storage profiles.

Faults

Type	Description
InvalidArgument	Thrown if the Server does not recognize any of the profileIds.
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

Show WSDL type definition

PbmUpdate(update)

Updates a storage profile.

Required Privileges

StorageProfile.Update

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the PbmProfileProfileManager used to make the method call.
profileId	PbmProfileId	Profile identifier. Since 1.0
updateSpec	PbmCapabilityProfileUpdateSpec	Capability-based update specification. Since 1.0

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if the Server does not recognize PbmProfileId.
PbmFaultProfileStorageFault	in case of internal service 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

Show WSDL type definition

Top of page			Local Methods
Managed Object Types	Data Object Types	All Properties	All Methods