Scripting Object - VcServiceInstance

Scripting-object corresponding to
ServiceInstance

Scripting Object Description

The {@link ServiceInstance} managed object is the singleton root object of the inventory on both vCenter servers and servers running on standalone host agents. The server creates the {@link ServiceInstance} automatically, and also automatically creates the various manager entities that provide services in the virtual environment. Some examples of manager entities are {@link vim.LicenseManager}, {@link vim.PerformanceManager}, and {@link vim.view.ViewManager}. You can access the manager entities through the {@link ServiceInstance#content} property.

A vSphere API client application begins by connecting to a server and obtaining a reference to the {@link ServiceInstance}. The client can then use the {@link ServiceInstance#retrieveContent} method to gain access to the various vSphere manager entities and to the root folder of the inventory.

When you create managed objects, the server adds them to the inventory. The inventory of managed objects includes instances the following object types:

The following figure shows the organization of managed objects in the vCenter hierarchy:

vCenter ServiceInstance Hierarchy

Every Datacenter has the following set of dedicated folders. These folders are empty until you create entities for the Datacenter.

The host agent hierarchy has the same general form as the vCenter hierarchy, but most of the objects are limited to one instance:

Host Agent Service Instance Hierarchy

Attributes

Name Type Description
capabilityVcCapability

@since VI API 2.5
contentVcServiceContent

@since VI API 2.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
serverClockDate

@since VI API 2.5
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, currentTime, queryVMotionCompatibility, retrieveInternalContent, retrieveProductComponents, retrieveServiceContent, validateMigration

retrieveInternalContent

Retrieves the internal properties of the service instance. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcInternalServiceInstanceContent

queryVMotionCompatibility

Investigates the general VMotion compatibility of a virtual machine with a set of hosts. The virtual machine may be in any power state. Hosts may be in any connection state and also may be in maintenance mode. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcHostSystem []

arg2String []


Return Value

Type Description
VcHostVMotionCompatibility []

_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

retrieveProductComponents

Component information for bundled products @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcProductComponentInfo []

retrieveServiceContent

Retrieves the properties of the service instance. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcServiceContent

currentTime

Returns the current time on the server. To monitor non-linear time changes, use the {@link #serverClock serverClock} property. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
Date

validateMigration

Checks the validity of a set of proposed migrations. A migration is the act of changing the assigned execution host of a virtual machine, which can result from invoking {@link vim.VirtualMachine#migrate} or {@link vim.VirtualMachine#relocate}. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcVirtualMachine []

arg1VcVirtualMachinePowerState

arg2String []

arg3VcResourcePool

arg4VcHostSystem


Return Value

Type Description
VcEvent []