Data Object Description

ProfileExecuteResult

HostProfile

ExecuteHostProfile

Properties

Name	Type	Description
configSpec*	HostConfigSpec	Host configuration specification. This data is valid only if the `status` value is `success`. See ProfileExecuteResultStatus. Use this data object when you apply the configuration to a host. See the `configSpec` parameter to the HostProfileManager.ApplyHostConfig_Task method.
error*	ProfileExecuteError[]	List of errors that were encountered during execute. This field will be set if status is set to error.
inapplicablePath*	xsd:string[]	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.
requireInput*	ProfileDeferredPolicyOptionParameter[]	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 ExecuteHostProfile includes deferred parameters, the `requireInput` entries (`requireInput[].`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 (inapplicablePath[]) and required input property paths (ProfileDeferredPolicyOptionParameter.inputPath). The client can make a series of calls to the method until it achieves a success status. When 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 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.ApplyHostConfig_Task method. The Server will use the list to update the AnswerFile associated with the host.
status	xsd:string	Status of the profile execution operation. The value is a string that contains one of the ProfileExecuteResultStatus enumerations.
Properties inherited from DynamicData
None

Name

Type

Description

configSpec*

HostConfigSpec

Host configuration specification. This data is valid only if the status value is success. See ProfileExecuteResultStatus.

Use this data object when you apply the configuration to a host. See the configSpec parameter to the HostProfileManager.ApplyHostConfig_Task method.

error*

ProfileExecuteError[]

List of errors that were encountered during execute. This field will be set if status is set to error.

inapplicablePath*

xsd:string[]

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.

requireInput*

ProfileDeferredPolicyOptionParameter[]

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 ExecuteHostProfile includes deferred parameters, the requireInput entries (requireInput[].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 (inapplicablePath[]) and required input property paths (ProfileDeferredPolicyOptionParameter.inputPath). The client can make a series of calls to the method until it achieves a success status.

When 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 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.ApplyHostConfig_Task method. The Server will use the list to update the AnswerFile associated with the host.

status

xsd:string

Status of the profile execution operation. The value is a string that contains one of the ProfileExecuteResultStatus enumerations.

Properties inherited from DynamicData

None

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="ProfileExecuteResult">
            <complexContent>
               <extension base="vsan:DynamicData">
                  <sequence>
                     <element name="status" type="xsd:string"/>
                     <element name="configSpec" type="vsan:HostConfigSpec" minOccurs="0"/>
                     <element name="inapplicablePath" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="requireInput" type="vsan:ProfileDeferredPolicyOptionParameter" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="error" type="vsan:ProfileExecuteError" minOccurs="0" maxOccurs="unbounded"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - ProfileExecuteResult(vim.profile.host.ExecuteResult)

Data Object Description