Managed Object - HostProfileManager

Property of: ServiceContent
Extends: ProfileManager
See also: ApplyProfile, HostConfigSpec, HostProfileManagerConfigTaskList, HostSystem, ProfileMetadata
Since: vSphere API 4.0

Managed Object Description

This Class is responsible for managing Host Profiles.

Properties

Name	Type	Description
None
Properties inherited from ProfileManager
profile

Methods

Methods defined in this Managed Object
ApplyHostConfig_Task, CreateDefaultProfile, GenerateConfigTaskList, QueryHostProfileMetadata
Methods inherited from ProfileManager
CreateProfile, FindAssociatedProfile, QueryPolicyMetadata

ApplyHostConfig_Task

Apply the configuration to the host.

Required Privileges: Dynamic - See discussion above

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
host	ManagedObjectReference to a HostSystem	Host to which the configuration needs to be applied. Depending on the contents of the configSpec, user has to have different privileges to perform this operation.
configSpec	HostConfigSpec	Set of configuration changes that need to be applied to the host.

Return Value

Type	Description
ManagedObjectReference to a Task

Faults

Type	Description
HostConfigFailed
InvalidState
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

CreateDefaultProfile

Create a default profile of a given type. e.g: VirtualSwitchProfile. The profileTypes are defined in Vmodl. Once the default profile dataObject is generated, it can be modified and a profile can be created on the server.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
profileType	xsd:string

Return Value

Type	Description
ApplyProfile

Faults

Type	Description
InvalidArgument	Thrown if the profileType specified is incorrect.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateDefaultProfile" type="vim25:CreateDefaultProfileRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateDefaultProfileResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ApplyProfile"/>
               </sequence>
            </complexType>
         </element>

GenerateConfigTaskList

Generate a list of configuration tasks that will be performed on the host during HostProfile application.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
configSpec	HostConfigSpec	ConfigSpec which was proposed by ExecuteHostProfile method.
host	ManagedObjectReference to a HostSystem	Host on which the HostProfile application needs to be carried out.

Return Value

Type	Description
HostProfileManagerConfigTaskList	List of Configuration tasks.

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GenerateConfigTaskList" type="vim25:GenerateConfigTaskListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GenerateConfigTaskListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:HostProfileManagerConfigTaskList"/>
               </sequence>
            </complexType>
         </element>

QueryHostProfileMetadata

Query the metadata for the Profiles.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
profileName*	xsd:string[]	Names of the profiles for which metadata is requested. If profileName is not set, metadata for all the profiles will be returned.

*Need not be set

Return Value

Type	Description
ProfileMetadata[]	List of ProfileMetadatas

Faults

Type	Description
InvalidArgument	Thrown if profileName parameter is invalid.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryHostProfileMetadata" type="vim25:QueryHostProfileMetadataRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryHostProfileMetadataResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ProfileMetadata" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>