Scripting Object - VcProfileHostProfileEngineHostProfileManager

Scripting-object corresponding to
ProfileHostProfileEngineHostProfileManager
Attribute of
VcProfileHostProfileEngineHostProfileEngine

Scripting Object Description

Internal interface used by Vpxd to call Python ProfileManager.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, bookKeep, createTrigger, hostdApplyHostConfig_Task, hostdCreateDefaultProfile, hostdGenerateHostConfigTaskSpec, hostdGenerateHostProfileTaskList_Task, hostdQueryPolicyMetadata, hostdQueryProfileCategoryMetadata, hostdQueryProfileComponentMetadata, hostdQueryProfileStructure, prepareExport, profileManagerInternalExecute, queryProfileMetadata, queryState, retrieveProfile, retrieveProfileDescription, updateTaskConfigSpec, vpxdProfileManagerQueryUserInputPolicyOptions

hostdQueryProfileStructure

Get Information about the structure of the profile @since vSphere API 5.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcProfileProfileStructure

hostdQueryPolicyMetadata

Query metadata for given policyNames @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcProfileHostProfileEngineHostProfileManagerPolicyMetaArray

hostdQueryProfileComponentMetadata

Query metadata for given componentNames @since vSphere API 5.1

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcProfileHostProfileEngineHostProfileManagerProfileComponentMetaArray

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

queryProfileMetadata

Query metadata for given profileNames @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String []

arg1String []


Return Value

Type Description
VcProfileHostProfileEngineHostProfileManagerProfileMetaArray

prepareExport

Prepare profile for export. We don't want to export parameters such as passwords convert these policy options to user input options @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcHostProfileConfigInfo


Return Value

Type Description
VcHostProfileConfigInfo

retrieveProfile

Retrieve a profile from the host's configuration Individual configuration elements like VirtualSwitch etc are examined and a corresponding sub-profile will be created in the returned profile. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcProfileHostProfileEngineHostInfo


Return Value

Type Description
VcHostProfileConfigInfo

hostdCreateDefaultProfile

Create a default profile of type profileType. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
VcApplyProfile

bookKeep

Bookkeep the profile. e.g: Update the keys etc when user changes some part of the profile. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcHostProfileConfigInfo


Return Value

Type Description
VcHostProfileConfigInfo

hostdQueryProfileCategoryMetadata

Query metadata for given categoryNames @since vSphere API 5.1

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcProfileHostProfileEngineHostProfileManagerProfileCategoryMetaArray

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

vpxdProfileManagerQueryUserInputPolicyOptions

Get a list of policy options that are set to require user inputs @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcHostApplyProfile

arg1VcProfileHostProfileEngineHostInfo


Return Value

Type Description
VcProfileHostProfileEngineHostProfileManagerUserInputArray

hostdGenerateHostConfigTaskSpec

Execute the profileManager engine. If execute is successful then, Generate a list of configuration tasks that will be performed on the host during HostProfile application. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcProfileHostProfileEngineHostInfo

arg1VcHostApplyProfile

arg2VcProfileDeferredPolicyOptionParameter []


Return Value

Type Description
VcApplyHostProfileConfigurationSpec

hostdGenerateHostProfileTaskList_Task

Generate a list of configuration tasks that will be performed on the host during HostProfile application. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcProfileHostProfileEngineHostInfo

arg1VcHostConfigSpec


Return Value

Type Description
VcTask

retrieveProfileDescription

Get localized description of the profile. The description will have details like how many virtual switches will be created on the host, which portgroups will be created, etc. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcHostProfileConfigInfo


Return Value

Type Description
VcProfileDescription

hostdApplyHostConfig_Task

Applies the specified host configuration to the host. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcHostConfigSpec


Return Value

Type Description
VcTask

profileManagerInternalExecute

Execute the profileManager engine @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcHostApplyProfile

arg1VcProfileHostProfileEngineHostInfo

arg2VcProfileDeferredPolicyOptionParameter []


Return Value

Type Description
VcProfileExecuteResult

updateTaskConfigSpec

Update the configSpec depending on the current configuration of the host Trims the configSpec to a task list which can then be handed over to say Vpxa. e.g: If the input configSpec contains a VirtualSwitch create instruction and that VirtualSwitch already exists in the configInfo of the host (current config), this method stips out the virtualSwitchCreateSpec from the configSpec. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcProfileHostProfileEngineHostInfo

arg1VcHostConfigSpec


Return Value

Type Description
VcHostProfileManagerConfigTaskList

queryState

Retrieves a list of name-value pairs indicating the current state of the host profile manager and plug-ins on this host. The possible state settings are not defined by this interface to allow for plug-in specific state to be retrieved via this method. @since vSphere API 5.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcKeyAnyValue []