Pbm Profile Profile Manager Pbm Assign Default Requirement Profile

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

Request

URI

POST

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

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

PbmAssignDefaultRequirementProfileRequestType of type(s) application/json

Required

Show optional properties

{
    "profile": {
        "uniqueId": "string"
    },
    "datastores": [
        {
            "hubType": "string",
            "hubId": "string"
        }
    ]
}

{
    "profile": {
        "_typeName": "string",
        "uniqueId": "string"
    },
    "datastores": [
        {
            "_typeName": "string",
            "hubType": "string",
            "hubId": "string"
        }
    ]
}

PbmProfileId

profile

Required

Profile unique identifier.

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

array of PbmPlacementHub

datastores

Required

The datastores for which the profile needs to be made as default profile.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidArgument: If one of the hub is not a datastore or profile cannot be used as default requirement profile for any of the hub.

PbmLegacyHubsNotSupported: If any of the hub in datastores argument is legacy (VMFS or NFS) datastores.

PbmNonExistentHubs: If any of the hub in datastores argument is non existent.

PbmFault: Internal service error

PbmFaultNoPermission: If user does not have Datastore.UpdateVirtualMachineFiles privilege on the given datastores.

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