PbmCapabilityProfile

PbmCapabilityProfile
PbmCapabilityProfile

The PbmCapabilityProfile data object defines capability-based profiles.

A capability-based profile is derived from tag-based storage capabilities or from vSAN storage capabilities.

This structure may be used only with operations rendered under /pbm.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "profileId": {
        "_typeName": "string",
        "uniqueId": "string"
    },
    "name": "string",
    "description": "string",
    "creationTime": "string",
    "createdBy": "string",
    "lastUpdatedTime": "string",
    "lastUpdatedBy": "string",
    "profileCategory": "string",
    "resourceType": {
        "_typeName": "string",
        "resourceType": "string"
    },
    "constraints": {
        "_typeName": "string"
    },
    "generationId": 0,
    "isDefault": false,
    "systemCreatedProfileType": "string",
    "lineOfService": "string"
}
string
profileCategory
Required

Indicates whether the profile is requirement profile, a resource profile or a data service profile.

The profileCategory is a string value that corresponds to one of the PbmProfileCategoryEnumEnum values.

  • REQUIREMENT profile - Defines the storage constraints applied to virtual machine placement. Requirements are defined by the user and can be associated with virtual machines and virtual disks. During provisioning, you can use a requirements profile for compliance and placement checking to support selection and configuration of resources.
  • RESOURCE profile - Specifies system-defined storage capabilities. You cannot modify a resource profile. You cannot associate a resource profile with vSphere entities, use it during provisioning, or target entities for resource selection or configuration. This type of profile gives the user visibility into the capabilities supported by the storage provider.
  • DATA_SERVICE_POLICY - Indicates a data service policy that can be embedded into another storage policy. Policies of this type can't be assigned to Virtual Machines or Virtual Disks. This policy cannot be used for compliance checking.
resourceType
Required

The PbmProfileResourceType data object defines the vSphere resource type that is supported for profile management.

This structure may be used only with operations rendered under /pbm.

constraints
Required

The PbmCapabilityConstraints data object is the base object for capability subprofile constraints.

This structure may be used only with operations rendered under /pbm.

integer As int64 As int64
generationId
Optional

Generation ID is used to communicate the current version of the profile to VASA providers.

It is only applicable to REQUIREMENT profile types. Every time a requirement profile is edited, the Server will increment the generationId. You do not need to set the generationID. When an object is created (or reconfigured), the Server will send the requirement profile content, profile ID and the generationID to VASA provider.

boolean
isDefault
Required

Deprecated since it is not supported.

Not supported in this release.

string
systemCreatedProfileType
Optional

Indicates the type of system pre-created default profile.

This will be set only for system pre-created default profiles. And this is not set for RESOURCE profiles.

string
lineOfService
Optional

This property is set only for data service policy.

Indicates the line of service PbmLineOfServiceInfoLineOfServiceEnumEnum of the data service policy.