Host Profile Manager Composite Host Profile Task

Host Profile Manager Composite Host Profile Task

Composes (merge, replace, delete, disable) the selected configurations into the target host profiles.

Required privileges: Profile.Edit

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/HostProfileManager/{moId}/CompositeHostProfile_Task
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 HostProfileManager/{moId}.

string
release
Required

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

Request Body
CompositeHostProfileRequestType of type(s) application/json
Required 
"CompositeHostProfileRequestType Object"
object
source
Required

Reference to an instance of the Profile managed object.

array of object
targets
Optional

Reference to an instance of the Profile managed object.

object
toBeMerged
Optional

The HostApplyProfile data object provides access to subprofiles that contain configuration data for different host capabilities.

The Profile Engine will use any configuration data that you supply to overwrite the host configuration. See the ExecuteHostProfile and ApplyHostConfig_Task methods.

object
toBeReplacedWith
Optional

The HostApplyProfile data object provides access to subprofiles that contain configuration data for different host capabilities.

The Profile Engine will use any configuration data that you supply to overwrite the host configuration. See the ExecuteHostProfile and ApplyHostConfig_Task methods.

object
toBeDeleted
Optional

The HostApplyProfile data object provides access to subprofiles that contain configuration data for different host capabilities.

The Profile Engine will use any configuration data that you supply to overwrite the host configuration. See the ExecuteHostProfile and ApplyHostConfig_Task methods.

object
enableStatusToBeCopied
Optional

The HostApplyProfile data object provides access to subprofiles that contain configuration data for different host capabilities.

The Profile Engine will use any configuration data that you supply to overwrite the host configuration. See the ExecuteHostProfile and ApplyHostConfig_Task methods.

Authentication
This operation uses the following authentication methods.
Responses
200

This method will returns a Task object with which to monitor the operation. The Task.info.result will contain a HostProfileManagerCompositionResult object containing the status of the operation, and details about any composition errors. The definitions of all the parameters are same as those in ValidateHostProfileComposition_Task.

Returns MoRefTask of type(s) application/json 
"MoRefTask Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/HostProfileManager/{moId}/CompositeHostProfile_Task
On This Page
Host Profile Manager Operations
POST
Host Profile Manager Apply Entities Config Task
POST
Host Profile Manager Apply Host Config Task
POST
Host Profile Manager Check Answer File Status Task
POST
Host Profile Manager Composite Host Profile Task
POST
Host Profile Manager Create Default Profile
POST
Host Profile Manager Create Profile
POST
Host Profile Manager Export Answer File Task
POST
Host Profile Manager Find Associated Profile
POST
Host Profile Manager Generate Config Task List
Deprecated
POST
Host Profile Manager Generate Host Config Task Spec Task
POST
Host Profile Manager Generate Host Profile Task List Task
POST
Host Profile Manager Query Answer File Status
POST
Host Profile Manager Query Policy Metadata
POST
Host Profile Manager Query Host Profile Metadata
POST
Host Profile Manager Query Profile Structure
POST
Host Profile Manager Retrieve Answer File
POST
Host Profile Manager Retrieve Answer File For Profile
POST
Host Profile Manager Retrieve Host Customizations
POST
Host Profile Manager Retrieve Host Customizations For Profile
POST
Host Profile Manager Update Answer File Task
POST
Host Profile Manager Update Host Customizations Task
POST
Host Profile Manager Validate Host Profile Composition Task
GET
Host Profile Manager Get Profile