CIM_VirtualSystemManagementService class

Service to control virtual systems including definition, instantiation, destruction, and modification.

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

class CIM_VirtualSystemManagementService : CIM_Service
{
  string   SystemName;
  string   SystemCreationClassName;
  string   Status;
  string   StartMode;
  boolean  Started;
  string   Name;
  datetime InstallDate;
  string   Description;
  string   CreationClassName;
  string   Caption;
};

Members

The CIM_VirtualSystemManagementService class has these types of members:

Methods

The CIM_VirtualSystemManagementService class has these methods.

MethodDescription
CloneVirtualSystem

Optional method to clone a virtual system. An implementation implementing the CloneVirtualSystem() method shall set the CloneVirtualSystemSupported flag of its CIM_VirtualSystemManagementCapabilities instance. CloneVirtualSystem() shall allow to apply modifications to the cloned system in the same way as ModifyVirtualSystem(). The implementation may decide whether these modifications are applied during the clone process or after an initially identical cloned system was created. If the CopyContent flag is set, then the source virtual system must be in the 'Defined' state for the duration of the method execution.

CreateVirtualSystemConfiguration

Create a validated virtual system configuration at the virtualization platform. The configuration may be used in a subsequent call DefineVirtualSystem to actually create the virtual system.

DefineVirtualSystem

Define a Virtual System. Input that is not completely specified will be filled with default values.

DestroyVirtualSystem

The referenced virtual system is destroyed, including any elements scoped by it. Virtual resources are returned to their resource pools, which may imply the destruction of the resource (implementation dependent).

DestroyVirtualSystemConfiguration

The referenced virtual system is configuration isdestroyed, including any elements scoped by it. Virtual resources are returned to their resource pools, which may imply the destruction of the resource (implementation dependent).

ModifyVirtualSystem

General method for modifying settings(s) associated with a virtual system.

 

Properties

The CIM_VirtualSystemManagementService 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 require 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 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 creation class name.

SystemName
Data type: string
Access type: Read-only

Name of the system that hosts the service.

Requirements

Namespace

Root\CIMV2

See also

CIM_Service

 

 

Show: