Scripting Object - VcMessageBusProxy

Scripting-object corresponding to
MessageBusProxy
Attribute of
VcHostConfigManager

Scripting Object Description

This managed object provides interfaces to configure the common message bus proxy service running on the ESX host.

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, configureMessageBusProxy, createTrigger, reloadMessageBusProxy, retrieveMessageBusProxyInfo, startMessageBusProxy, stopMessageBusProxy, unconfigureMessageBusProxy

reloadMessageBusProxy

If the common message bus proxy service was not running, start it. If the common message bus proxy service was running, send it a notification to reload its configuration file so that the new configuration takes effect. @since vSphere API 6.0

Parameters

NameTypeDescription
None

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

unconfigureMessageBusProxy

Unconfigure and disable the common message bus proxy service on the ESX host. Stop the proxy service if it was running. Previous configuration data shall be erased. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
None

startMessageBusProxy

Start the common message bus proxy service on the ESX host if it was not running. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
None

configureMessageBusProxy

Configure the common message bus proxy service. The configuration is modified to reflect changes specified in configSpec. If the proxy service was running, it may still use the configuration information loaded from the old configuration file. Application needs to call the Reload method for the proxy service to reload the new configuration file. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcMessageBusProxyConfigSpec


Return Value

Type Description
None

retrieveMessageBusProxyInfo

Retrieve the common message bus proxy service information. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcMessageBusProxyInfo

stopMessageBusProxy

Stop the common message bus proxy service on the ESX host if it was running. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
None