Pbm Profile Profile Manager Pbm 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 (PbmBuiltinTypeEnum) 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

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/pbm/PbmProfileProfileManager/{moId}/PbmCreate

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 PbmProfileProfileManager/{moId}.

string

release

Required

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

Request Body

PbmCreateRequestType of type(s) application/json

Required

Show optional properties

{
    "createSpec": {
        "name": "string",
        "resourceType": {
            "resourceType": "string"
        },
        "constraints": {}
    }
}

{
    "createSpec": {
        "_typeName": "string",
        "name": "string",
        "description": "string",
        "category": "string",
        "resourceType": {
            "_typeName": "string",
            "resourceType": "string"
        },
        "constraints": {
            "_typeName": "string"
        }
    }
}

PbmCapabilityProfileCreateSpec

createSpec

Required

The PbmCapabilityProfileCreateSpec describes storage requirements.

Use this data object to create a PbmCapabilityProfile.

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

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Identifier for the new profile.

Returns PbmProfileId of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "uniqueId": "string"
}

string

uniqueId

Required

Unique identifier of the profile.

500

InvalidArgument: if PbmCapabilityProfileCreateSpec is invalid.

PbmFaultProfileStorageFault: if there is an error in persisting the profile.

PbmDuplicateName: if a profile with the same name already exists.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

MethodFault

faultCause

Optional

The base data object type for all the object model faults that an application might handle.

array of LocalizableMessage

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

On This Page

Description

Request

Path Parameters