Msvm_GuestService class

Msvm_GuestService is the abstract base class for services in the guest that can be accessed from the host. This class derives from the CIM_Service class.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[Abstract, AMENDMENT]
class Msvm_GuestService : CIM_Service
{
  string   Caption;
  string   CreationClassName;
  string   Description;
  datetime InstallDate;
  string   Name;
  boolean  Started;
  string   StartMode;
  string   Status;
  string   SystemCreationClassName;
  string   SystemName;
};

Members

The Msvm_GuestService class has these types of members:

Methods

The Msvm_GuestService class has these methods.

Method Description
RequestStateChange Requests that the state of the guest service be changed to the specified value.
StartService Puts the guest service in a started state.
StopService Stops the guest service.

Properties

The Msvm_GuestService class has these properties.

Caption

Data type: string

Access type: Read-only

Short textual description of the object. This property is inherited from CIM_ManagedSystemElement.

CreationClassName

Data type: string

Access type: Read-only

Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified.

Description

Data type: string

Access type: Read-only

Textual description of the object. This property is inherited from CIM_ManagedSystemElement.

InstallDate

Data type: datetime

Access type: Read-only

Date and time the object was installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

Name

Data type: string

Access type: Read-only

Unique identifier for the service that also provides an indication of the functionality that is managed. For more information about the functionality, see the object's Description property. This property is inherited from CIM_ManagedSystemElement.

Started

Data type: boolean

Access type: Read-only

If TRUE, the service has started.

StartMode

Data type: string

Access type: Read-only

Indicates whether the service is automatically started (for example, by an operating system) or only started upon request.

Values include the following:

"Automatic"

"Manual"

Status

Data type: string

Access type: Read-only

Current status of the object. This property is inherited from CIM_ManagedSystemElement.

Values include the following:

"OK"

"Error"

"Degraded"

"Unknown"

"Pred Fail"

"Starting"

"Stopping"

"Service"

"Stressed"

"NonRecover"

"No Contact"

"Lost Comm"

SystemCreationClassName

Data type: string

Access type: Read-only

Scoping system's creation class name.

SystemName

Data type: string

Access type: Read-only

Name of the system that hosts the service.

Requirements

Minimum supported client
Windows 8.1 [desktop apps only]
Minimum supported server
Windows Server 2012 R2 [desktop apps only]
Namespace
Root\Virtualization\V2
MOF
WindowsVirtualization.V2.mof
DLL
Vmms.exe

See also

CIM_Service

CIM_Service