Scripting Object - VcVirtualMachineNamespaceManager

Scripting-object corresponding to
VirtualMachineNamespaceManager
Attribute of
VcInternalServiceInstanceContent

Scripting Object Description

Virtual Machine Namespace manager.

This manager is used to manage virtual machine namespaces. Virtual machine namespace is an entity through which the guest operating system can exchange information with management application. The information exchanged can be key/value pairs and notification events with string payload. Notification events work best if for one namespace there is exactly one client in the virtual machine, and one client on the VMODL side.

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, createNamespace, createTrigger, deleteAllNamespaces, deleteNamespace, fetchEventsFromGuest, listNamespaces, queryNamespace, retrieveData, sendEventToGuest, updateData, updateNamespace

_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

queryNamespace

Retrieve details about the namespace with the specified name for the specified virtual machine. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String


Return Value

Type Description
VcVirtualMachineNamespaceManagerNamespaceInfo

updateData

Add/update/delete keys as specified in request[]. Either all keys/values are updated, or none are. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String

arg2VcVirtualMachineNamespaceManagerDataSpec []


Return Value

Type Description
None

createNamespace

Create a new namespace on the virtual machine. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcVirtualMachineNamespaceManagerCreateSpec


Return Value

Type Description
None

updateNamespace

Update namespace limits and properties. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcVirtualMachineNamespaceManagerCreateSpec


Return Value

Type Description
None

sendEventToGuest

Send event to the guest. Multiple events are delivered to the guest virtual machine in the order they were generated.

This operation may be invoked only when the virtual machine is powered on. InvalidState is thrown otherwise. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String

arg2String


Return Value

Type Description
Boolean

deleteAllNamespaces

Delete all namespaces for the virtual machine. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
None

retrieveData

Retrieve keys/values listed in the keys[]. Non-existent keys are returned with value unset. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String

arg2String []

arg3String


Return Value

Type Description
VcVirtualMachineNamespaceManagerQueryResult

fetchEventsFromGuest

Retrieve all unseen events generated by the guest associated with specified namespace. Events returned by this call are removed from the queue of pending events. Events are returned in the order in which they were generated by the virtual machine.

This operation may be invoked only when the virtual machine is powered on. InvalidState is thrown otherwise. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String


Return Value

Type Description
VcVirtualMachineNamespaceManagerEventList

deleteNamespace

Delete the specified namespace. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String


Return Value

Type Description
None

listNamespaces

Retrieve all namespaces for the specified virtual machine. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcVirtualMachine


Return Value

Type Description
String []