Scripting Object - VcHostSpecificationManager

Scripting-object corresponding to
HostSpecificationManager
Attribute of
VcServiceContent

Scripting Object Description

The {@link vim.profile.host.HostSpecificationManager} provides the functionality to update, restrieve and delete {@link vim.profile.host.HostSpecification} and {@link vim.profile.host.HostSubSpecification}.

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, createTrigger, deleteHostSpecification, deleteHostSubSpecification, hostSpecGetUpdatedHosts, retrieveHostSpecification, updateHostSpecification, updateHostSubSpecification

deleteHostSubSpecification

Delete the host sub specification specified by the provided subSpecname of the specified host. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcHostSystem

arg1String


Return Value

Type Description
None

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

hostSpecGetUpdatedHosts

Query the hosts whose specification was updated in the specified time period. When the startChangeID isn't provided, it will return all the host updated before the endChangeID. When the endChangeID isn't provided, it will return all the hosts updated after startChangeID. If both aren't provided, all hosts having host spec will be returned. The format of the change ID is defined at {@link vim.profile.host.HostSpecification#changeID}. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
VcHostSystem []

updateHostSubSpecification

Update the host specification with the provided host sub specification. If there is no host specification for the host, create the host specification, which contains only the provided host sub specification, for this host; otherwise, add or update the host specification with the provided {@link vim.profile.host.HostSubSpecification} object. This method provides a way to incrementally build the host specification. On success, it will fire a HostSpecificationChangedEvent. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcHostSystem

arg1VcHostSubSpecification


Return Value

Type Description
None

retrieveHostSpecification

Retrieve the host specification. When the parameter fromHost is true, the host specification is retrieved from the host; otherwise, it is from the host specification "database" for this manager. When retrieved from host, the copy in host specification "database" will be updated. On success, it will fire a HostSpecificationChangedEvent. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcHostSystem

arg1Boolean


Return Value

Type Description
VcHostSpecification

updateHostSpecification

Update the host specification with the provided copy. If there is no host specification for the host, create the host specification for this host in the host specification "database"; otherwise, update the host specification with the provided. {@link vim.profile.host.HostSpecification} object. On success, it will fire a HostSpecificationChangedEvent. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcHostSystem

arg1VcHostSpecification


Return Value

Type Description
None

deleteHostSpecification

Delete the host specification of the specified host. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcHostSystem


Return Value

Type Description
None