Scripting Object - VcHostServiceSystem

Scripting-object corresponding to
HostServiceSystem
Attribute of
VcHostConfigManager

Scripting Object Description

The {@link ServiceSystem} managed object describes the configuration of host services. This managed object operates in conjunction with the {@link vim.host.FirewallSystem HostFirewallSystem} managed object.

Attributes

Name Type Description
availableFieldVcCustomFieldDef []

@since VI API 2.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
serviceInfoVcHostServiceInfo

@since VI API 2.5
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
valueVcCustomFieldValue []

@since VI API 2.5
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, refreshServices, restartService, setCustomValue, startService, stopService, uninstallService, updateServicePolicy

_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

stopService

Stops the service. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

restartService

Restarts the service. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

updateServicePolicy

Updates the activation policy of the service. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

startService

Starts the service. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

setCustomValue

Assigns a value to a custom field. The setCustomValue method requires whichever updatePrivilege is defined as one of the {@link CustomFieldsManager.FieldDef#fieldInstancePrivileges} for the CustomFieldDef whose value is being changed. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

refreshServices

Refresh the service information and settings to pick up any changes made directly on the host. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

uninstallService

Uninstalls the service. If the service is running, it is stopped before being uninstalled. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None