Host Profile Execute Host Profile
Run the Profile Engine to determine the list of configuration changes needed for the specified host.
The method generates configuration changes based on the host profile.
You can also specify deferred parameters to verify additional host-specific data. The Profile Engine uses the policy options (HostProfile.config.applyProfile.policy[]) to determine the required parameters (PolicyOption.parameter[]) for host configuration. If you do not provide all of the required parameters, you must call the method again to provide the complete list to the Profile Engine. After successful profile execution, when you apply the profile, the Profile Engine will save the host-specific data in an AnswerFile.
Required privileges: System.View
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostProfile/{moId}/ExecuteHostProfile
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 HostProfile/{moId}.
string
release
Required
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
Request Body
ExecuteHostProfileRequestType of type(s) application/json
Required
{
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"deferredParam": [
{
"_typeName": "string",
"inputPath": {
"_typeName": "string",
"profilePath": "string",
"policyId": "string",
"parameterId": "string",
"policyOptionId": "string"
},
"parameter": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
]
}
]
}array of ProfileDeferredPolicyOptionParameter
deferredParam
Optional
Additional configuration data to be applied to the host. This should contain all of the host-specific data, including data from from previous calls to the method.
Responses
200
Result of the execution. If the operation is successful (ProfileExecuteResult.status=success), the result object includes a valid host configuration specification that you can pass to the HostProfileManager.ApplyHostConfig_Task method.
If the operation is not successful, the object contains error information or information about additional data required for the host configuration. If additional data is required, the required input list (ProfileExecuteResult.requireInput[]) contains both the deferredParam data and paths to missing parameters. After you fill in the missing parameters, pass the complete required input list via the deferredParam parameter in another call to the execute method to finish input verification. After successful profile execution, you can pass the verified required input list to the ApplyHostConfig_Task method.
Returns ProfileExecuteResult of type(s) application/json
This response body class contains all of the following: DataObject
{
"_typeName": "string",
"status": "string",
"configSpec": {
"_typeName": "string",
"nasDatastore": [
{
"_typeName": "string",
"changeOperation": "string",
"spec": {
"_typeName": "string",
"remoteHost": "string",
"remotePath": "string",
"localPath": "string",
"accessMode": "string",
"type": "string",
"userName": "string",
"password": "string",
"remoteHostNames": [
"string"
],
"securityType": "string",
"vmknicToBind": "string",
"vmknicBound": false,
"connections": 0
}
}
],
"network": {
"_typeName": "string",
"vswitch": [
{
"_typeName": "string",
"changeOperation": "string",
"name": "string",
"spec": {
"_typeName": "string",
"numPorts": 0,
"bridge": {
"_typeName": "string"
},
"policy": {
"_typeName": "string",
"security": {
"_typeName": "string",
"allowPromiscuous": false,
"macChanges": false,
"forgedTransmits": false
},
"nicTeaming": {
"_typeName": "string",
"policy": "string",
"reversePolicy": false,
"notifySwitches": false,
"rollingOrder": false,
"failureCriteria": {
"_typeName": "string",
"checkSpeed": "string",
"speed": 0,
"checkDuplex": false,
"fullDuplex": false,
"checkErrorPercent": false,
"percentage": 0,
"checkBeacon": false
},
"nicOrder": {
"_typeName": "string",
"activeNic": [
"string"
],
"standbyNic": [
"string"
]
}
},
"offloadPolicy": {
"_typeName": "string",
"csumOffload": false,
"tcpSegmentation": false,
"zeroCopyXmit": false
},
"shapingPolicy": {
"_typeName": "string",
"enabled": false,
"averageBandwidth": 0,
"peakBandwidth": 0,
"burstSize": 0
}
},
"mtu": 0
}
}
],
"proxySwitch": [
{
"_typeName": "string",
"changeOperation": "string",
"uuid": "string",
"spec": {
"_typeName": "string",
"backing": {
"_typeName": "string"
}
}
}
],
"portgroup": [
{
"_typeName": "string",
"changeOperation": "string",
"spec": {
"_typeName": "string",
"name": "string",
"vlanId": 0,
"vswitchName": "string",
"policy": {
"_typeName": "string",
"security": {
"_typeName": "string",
"allowPromiscuous": false,
"macChanges": false,
"forgedTransmits": false
},
"nicTeaming": {
"_typeName": "string",
"policy": "string",
"reversePolicy": false,
"notifySwitches": false,
"rollingOrder": false,
"failureCriteria": {
"_typeName": "string",
"checkSpeed": "string",
"speed": 0,
"checkDuplex": false,
"fullDuplex": false,
"checkErrorPercent": false,
"percentage": 0,
"checkBeacon": false
},
"nicOrder": {
"_typeName": "string",
"activeNic": [
"string"
],
"standbyNic": [
"string"
]
}
},
"offloadPolicy": {
"_typeName": "string",
"csumOffload": false,
"tcpSegmentation": false,
"zeroCopyXmit": false
},
"shapingPolicy": {
"_typeName": "string",
"enabled": false,
"averageBandwidth": 0,
"peakBandwidth": 0,
"burstSize": 0
}
}
}
}
],
"pnic": [
{
"_typeName": "string",
"device": "string",
"spec": {
"_typeName": "string",
"ip": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
},
"linkSpeed": {
"_typeName": "string",
"speedMb": 0,
"duplex": false
},
"enableEnhancedNetworkingStack": false,
"ensInterruptEnabled": false
}
}
],
"vnic": [
{
"_typeName": "string",
"changeOperation": "string",
"device": "string",
"portgroup": "string",
"spec": {
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"ip": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
},
"mac": "string",
"distributedVirtualPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"portgroup": "string",
"mtu": 0,
"tsoEnabled": false,
"netStackInstanceKey": "string",
"opaqueNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
},
"externalId": "string",
"pinnedPnic": "string",
"ipRouteSpec": {
"_typeName": "string",
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
}
},
"systemOwned": false,
"dpuId": "string"
}
}
],
"consoleVnic": [
{
"_typeName": "string",
"changeOperation": "string",
"device": "string",
"portgroup": "string",
"spec": {
"_typeName": "string",
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"ip": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
},
"mac": "string",
"distributedVirtualPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"portgroup": "string",
"mtu": 0,
"tsoEnabled": false,
"netStackInstanceKey": "string",
"opaqueNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
},
"externalId": "string",
"pinnedPnic": "string",
"ipRouteSpec": {
"_typeName": "string",
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
}
},
"systemOwned": false,
"dpuId": "string"
}
}
],
"dnsConfig": {
"_typeName": "string",
"dhcp": false,
"virtualNicDevice": "string",
"ipv6VirtualNicDevice": "string",
"hostName": "string",
"domainName": "string",
"address": [
"string"
],
"searchDomain": [
"string"
]
},
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
},
"consoleIpRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
},
"routeTableConfig": {
"_typeName": "string",
"ipRoute": [
{
"_typeName": "string",
"changeOperation": "string",
"route": {
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
}
],
"ipv6Route": [
{
"_typeName": "string",
"changeOperation": "string",
"route": {
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
}
]
},
"dhcp": [
{
"_typeName": "string",
"changeOperation": "string",
"key": "string",
"spec": {
"_typeName": "string",
"virtualSwitch": "string",
"defaultLeaseDuration": 0,
"leaseBeginIp": "string",
"leaseEndIp": "string",
"maxLeaseDuration": 0,
"unlimitedLease": false,
"ipSubnetAddr": "string",
"ipSubnetMask": "string"
}
}
],
"nat": [
{
"_typeName": "string",
"changeOperation": "string",
"key": "string",
"spec": {
"_typeName": "string",
"virtualSwitch": "string",
"activeFtp": false,
"allowAnyOui": false,
"configPort": false,
"ipGatewayAddress": "string",
"udpTimeout": 0,
"portForward": [
{
"_typeName": "string",
"type": "string",
"name": "string",
"hostPort": 0,
"guestPort": 0,
"guestIpAddress": "string"
}
],
"nameService": {
"_typeName": "string",
"dnsAutoDetect": false,
"dnsPolicy": "string",
"dnsRetries": 0,
"dnsTimeout": 0,
"dnsNameServer": [
"string"
],
"nbdsTimeout": 0,
"nbnsRetries": 0,
"nbnsTimeout": 0
}
}
}
],
"ipV6Enabled": false,
"netStackSpec": [
{
"_typeName": "string",
"netStackInstance": {
"_typeName": "string",
"key": "string",
"name": "string",
"dnsConfig": {
"_typeName": "string",
"dhcp": false,
"virtualNicDevice": "string",
"ipv6VirtualNicDevice": "string",
"hostName": "string",
"domainName": "string",
"address": [
"string"
],
"searchDomain": [
"string"
]
},
"ipRouteConfig": {
"_typeName": "string",
"defaultGateway": "string",
"gatewayDevice": "string",
"ipV6DefaultGateway": "string",
"ipV6GatewayDevice": "string"
},
"requestedMaxNumberOfConnections": 0,
"congestionControlAlgorithm": "string",
"ipV6Enabled": false,
"routeTableConfig": {
"_typeName": "string",
"ipRoute": [
{
"_typeName": "string",
"changeOperation": "string",
"route": {
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
}
],
"ipv6Route": [
{
"_typeName": "string",
"changeOperation": "string",
"route": {
"_typeName": "string",
"network": "string",
"prefixLength": 0,
"gateway": "string",
"deviceName": "string"
}
}
]
}
},
"operation": "string"
}
],
"migrationStatus": "string"
},
"nicTypeSelection": [
{
"_typeName": "string",
"vnic": {
"_typeName": "string",
"portgroup": "string",
"dvPort": {
"_typeName": "string",
"switchUuid": "string",
"portgroupKey": "string",
"portKey": "string",
"connectionCookie": 0
},
"opNetwork": {
"_typeName": "string",
"opaqueNetworkId": "string",
"opaqueNetworkType": "string"
}
},
"nicType": [
"string"
]
}
],
"service": [
{
"_typeName": "string",
"serviceId": "string",
"startupPolicy": "string"
}
],
"firewall": {
"_typeName": "string",
"rule": [
{
"_typeName": "string",
"rulesetId": "string",
"enabled": false,
"allowedHosts": {
"_typeName": "string",
"ipAddress": [
"string"
],
"ipNetwork": [
{
"_typeName": "string",
"network": "string",
"prefixLength": 0
}
],
"allIp": false
}
}
],
"defaultBlockingPolicy": {
"_typeName": "string",
"incomingBlocked": false,
"outgoingBlocked": false
}
},
"option": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"datastorePrincipal": "string",
"datastorePrincipalPasswd": "string",
"datetime": {
"_typeName": "string",
"timeZone": "string",
"ntpConfig": {
"_typeName": "string",
"server": [
"string"
],
"configFile": [
"string"
]
},
"ptpConfig": {
"_typeName": "string",
"domain": 0,
"port": [
{
"_typeName": "string",
"index": 0,
"deviceType": "string",
"device": "string",
"ipConfig": {
"_typeName": "string",
"dhcp": false,
"ipAddress": "string",
"subnetMask": "string",
"ipV6Config": {
"_typeName": "string",
"ipV6Address": [
{
"_typeName": "string",
"ipAddress": "string",
"prefixLength": 0,
"origin": "string",
"dadState": "string",
"lifetime": "string",
"operation": "string"
}
],
"autoConfigurationEnabled": false,
"dhcpV6Enabled": false
}
}
}
]
},
"protocol": "string",
"enabled": false,
"disableEvents": false,
"disableFallback": false,
"resetToFactoryDefaults": false
},
"storageDevice": {
"_typeName": "string",
"hostBusAdapter": [
{
"_typeName": "string",
"key": "string",
"device": "string",
"bus": 0,
"status": "string",
"model": "string",
"driver": "string",
"pci": "string",
"storageProtocol": "string"
}
],
"scsiLun": [
{
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false
}
],
"scsiTopology": {
"_typeName": "string",
"adapter": [
{
"_typeName": "string",
"key": "string",
"adapter": {
"_typeName": "string",
"key": "string",
"device": "string",
"bus": 0,
"status": "string",
"model": "string",
"driver": "string",
"pci": "string",
"storageProtocol": "string"
},
"target": [
{
"_typeName": "string",
"key": "string",
"target": 0,
"lun": [
{
"_typeName": "string",
"key": "string",
"lun": 0,
"scsiLun": {
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false
}
}
],
"transport": {
"_typeName": "string"
}
}
]
}
]
},
"nvmeTopology": {
"_typeName": "string",
"adapter": [
{
"_typeName": "string",
"key": "string",
"adapter": {
"_typeName": "string",
"key": "string",
"device": "string",
"bus": 0,
"status": "string",
"model": "string",
"driver": "string",
"pci": "string",
"storageProtocol": "string"
},
"connectedController": [
{
"_typeName": "string",
"key": "string",
"controllerNumber": 0,
"subnqn": "string",
"name": "string",
"associatedAdapter": {
"_typeName": "string",
"key": "string",
"device": "string",
"bus": 0,
"status": "string",
"model": "string",
"driver": "string",
"pci": "string",
"storageProtocol": "string"
},
"transportType": "string",
"fusedOperationSupported": false,
"numberOfQueues": 0,
"queueSize": 0,
"attachedNamespace": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"id": 0,
"blockSize": 0,
"capacityInBlocks": 0
}
],
"vendorId": "string",
"model": "string",
"serialNumber": "string",
"firmwareVersion": "string"
}
]
}
]
},
"multipathInfo": {
"_typeName": "string",
"lun": [
{
"_typeName": "string",
"key": "string",
"id": "string",
"lun": {
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false
},
"path": [
"HostMultipathInfoPath Object"
],
"policy": {
"_typeName": "string",
"policy": "string"
},
"storageArrayTypePolicy": {
"_typeName": "string",
"policy": "string"
}
}
]
},
"plugStoreTopology": {
"_typeName": "string",
"adapter": [
{
"_typeName": "string",
"key": "string",
"adapter": {
"_typeName": "string",
"key": "string",
"device": "string",
"bus": 0,
"status": "string",
"model": "string",
"driver": "string",
"pci": "string",
"storageProtocol": "string"
},
"path": [
"HostPlugStoreTopologyPath Object"
]
}
],
"path": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"channelNumber": 0,
"targetNumber": 0,
"lunNumber": 0,
"adapter": "HostPlugStoreTopologyAdapter Object",
"target": {
"_typeName": "string",
"key": "string",
"transport": {
"_typeName": "string"
}
},
"device": "HostPlugStoreTopologyDevice Object"
}
],
"target": [
{
"_typeName": "string",
"key": "string",
"transport": {
"_typeName": "string"
}
}
],
"device": [
{
"_typeName": "string",
"key": "string",
"lun": {
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false
},
"path": [
"HostPlugStoreTopologyPath Object"
]
}
],
"plugin": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"device": [
{
"_typeName": "string",
"key": "string",
"lun": {
"_typeName": "string",
"deviceName": "string",
"deviceType": "string",
"key": "string",
"uuid": "string",
"descriptor": [
{
"_typeName": "string",
"quality": "string",
"id": "string"
}
],
"canonicalName": "string",
"displayName": "string",
"lunType": "string",
"vendor": "string",
"model": "string",
"revision": "string",
"scsiLevel": 0,
"serialNumber": "string",
"durableName": {
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
},
"alternateName": [
{
"_typeName": "string",
"namespace": "string",
"namespaceId": 0,
"data": [
0
]
}
],
"standardInquiry": [
0
],
"queueDepth": 0,
"operationalState": [
"string"
],
"capabilities": {
"_typeName": "string",
"updateDisplayNameSupported": false
},
"vStorageSupport": "string",
"protocolEndpoint": false,
"perenniallyReserved": false,
"clusteredVmdkSupported": false,
"applicationProtocol": "string",
"dispersedNs": false
},
"path": [
"HostPlugStoreTopologyPath Object"
]
}
],
"claimedPath": [
{
"_typeName": "string",
"key": "string",
"name": "string",
"channelNumber": 0,
"targetNumber": 0,
"lunNumber": 0,
"adapter": "HostPlugStoreTopologyAdapter Object",
"target": {
"_typeName": "string",
"key": "string",
"transport": {
"_typeName": "string"
}
},
"device": "HostPlugStoreTopologyDevice Object"
}
]
}
]
},
"softwareInternetScsiEnabled": false
},
"license": {
"_typeName": "string",
"source": {
"_typeName": "string"
},
"editionKey": "string",
"disabledFeatureKey": [
"string"
],
"enabledFeatureKey": [
"string"
]
},
"security": {
"_typeName": "string",
"adminPassword": "string",
"removePermission": [
{
"_typeName": "string",
"entity": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"principal": "string",
"group": false,
"roleId": 0,
"propagate": false
}
],
"addPermission": [
{
"_typeName": "string",
"entity": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"principal": "string",
"group": false,
"roleId": 0,
"propagate": false
}
]
},
"userAccount": [
{
"_typeName": "string",
"id": "string",
"password": "string",
"description": "string"
}
],
"usergroupAccount": [
{
"_typeName": "string",
"id": "string",
"password": "string",
"description": "string"
}
],
"memory": {
"_typeName": "string",
"serviceConsoleReservation": 0
},
"activeDirectory": [
{
"_typeName": "string",
"changeOperation": "string",
"spec": {
"_typeName": "string",
"domainName": "string",
"userName": "string",
"password": "string",
"camServer": "string",
"thumbprint": "string",
"smartCardAuthenticationEnabled": false,
"smartCardTrustAnchors": [
"string"
]
}
}
],
"genericConfig": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"graphicsConfig": {
"_typeName": "string",
"hostDefaultGraphicsType": "string",
"sharedPassthruAssignmentPolicy": "string",
"deviceType": [
{
"_typeName": "string",
"deviceId": "string",
"graphicsType": "string"
}
]
},
"assignableHardwareConfig": {
"_typeName": "string",
"attributeOverride": [
{
"_typeName": "string",
"instanceId": "string",
"name": "string",
"value": {
"_typeName": "string"
}
}
]
}
},
"inapplicablePath": [
"string"
],
"requireInput": [
{
"_typeName": "string",
"inputPath": {
"_typeName": "string",
"profilePath": "string",
"policyId": "string",
"parameterId": "string",
"policyOptionId": "string"
},
"parameter": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
]
}
],
"error": [
{
"_typeName": "string",
"path": {
"_typeName": "string",
"profilePath": "string",
"policyId": "string",
"parameterId": "string",
"policyOptionId": "string"
},
"message": {
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
}
]
}string
status
Required
Status of the profile execution operation.
The value is a string that contains one of the ProfileExecuteResultStatusEnum enumerations.
configSpec
Optional
The HostConfigSpec data object provides access to data objects that specify configuration changes to be applied to an ESX host.
array of string
inapplicablePath
Optional
List of property paths.
Each path identifies a policy that does not apply to this host. For example, if the precheck policies for a port group are not satisfied, the port group will not be created when you apply the profile to the host. Based on this information, the client might not display that part of the profile tree.
array of ProfileDeferredPolicyOptionParameter
requireInput
Optional
List that describes the required input for host configuration and identifies any policy options that still require parameter data.
Each entry in the list specifies the path to a policy and a parameter list. If the call to HostProfile.ExecuteHostProfile includes deferred parameters, the requireInput entries (requireInput[].ProfileDeferredPolicyOptionParameter.parameter[]) will be populated with the parameter data that was passed to the execute method. For policies that still require input data, the parameter list in the corresponding entry will be null.
A vSphere client that displays a GUI can use this information to show the host-specific configuration policy options. The client can highlight required input fields and ask the user for data in increments instead of collecting all of the input at once. For example, in the first pass, the client collects a minimum of user input and sends that to the Server. The Server evaluates the profile and might decide to invalidate a particular part of the subtree or enable a new subtree in the profile. This would result in a new set of invalid paths (ProfileExecuteResult.inapplicablePath[]) and required input property paths (ProfileDeferredPolicyOptionParameter.ProfileDeferredPolicyOptionParameter.inputPath). The client can make a series of calls to the method until it achieves a success status.
When HostProfile.ExecuteHostProfile returns a success status, the requireInput list contains the complete list of parameters, consisting of the following data:
- Deferred parameter values resolved through successive calls to HostProfile.ExecuteHostProfile.
- Default parameter values from the host configuration.
- User-specified values that override the defaults.
You can specify the returned requireInput list in the userInput parameter to the HostProfileManager.HostProfileManager.ApplyHostConfig_Task method. The Server will use the list to update the AnswerFile associated with the host.
array of ProfileExecuteError
error
Optional
List of errors that were encountered during execute.
This field will be set if status is set to error.
On This Page
Host Profile Operations
POST
Host Profile Associate Profile
POST
Host Profile Check Profile Compliance Task
POST
Host Profile Destroy Profile
POST
Host Profile Dissociate Profile
POST
Host Profile Execute Host Profile
POST
Host Profile Export Profile
GET
Host Profile Get Compliance Check Time
GET
Host Profile Get Compliance Status
GET
Host Profile Get Config
GET
Host Profile Get Created Time
GET
Host Profile Get Description
GET
Host Profile Get Entity
GET
Host Profile Get Modified Time
GET
Host Profile Get Name
GET
Host Profile Get Reference Host
GET
Host Profile Get Validation Failure Info
GET
Host Profile Get Validation State
GET
Host Profile Get Validation State Update Time
POST
Host Profile Host Profile Reset Validation State
POST
Host Profile Retrieve Description
POST
Host Profile Update Host Profile
POST
Host Profile Update Reference Host