Msvm_PlannedComputerSystem class

Article
01/07/2021

Represents a planned virtual machine.

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

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_PlannedComputerSystem : CIM_ComputerSystem
{
  string   InstanceID;
  string   Caption = "Planned Virtual Machine";
  string   Description = "Microsoft Planned Virtual Machine";
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[] = { 2 };
  string   StatusDescriptions[] = { "The service is running normally" };
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState = 12;
  string   CreationClassName;
  string   Name;
  string   NameFormat;
  string   PrimaryOwnerName;
  string   PrimaryOwnerContact;
  string   Roles[];
  string   OtherIdentifyingInfo[];
  string   IdentifyingDescriptions[];
  uint16   Dedicated[];
  string   OtherDedicatedDescriptions[];
  uint16   ResetCapability;
  uint16   PowerManagementCapabilities[];
  uint16   AssignedNumaNodeList[];
  uint64   OnTimeInMilliseconds;
  uint32   ProcessID;
  datetime TimeOfLastConfigurationChange;
};

Members

The Msvm_PlannedComputerSystem class has these types of members:

Methods
Properties

Methods

The Msvm_PlannedComputerSystem class has these methods.

Method	Description
RequestStateChange	Requests that the state of the planned system be changed to the value specified.
SetPowerState	This method is not supported.

Properties

The Msvm_PlannedComputerSystem class has these properties.

AssignedNumaNodeList

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

An array of nonuniform memory access (NUMA) nodes that are currently assigned to the virtual machine.

AvailableRequestedStates

Data type: uint16 array
Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method used to initiate a state change. The values listed will be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities, where the values selected are a function of the current state of the CIM_EnabledLogicalElement object. This property can be non-Null if an implementation is able to advertise the set of possible values as a function of the current state. This property will be Null if an implementation is unable to determine the set of possible values as a function of the current state.

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)
Disabled (3)
Shut Down (4)
Offline (6)
Test (7)
Defer (8)
Quiesce (9)
Reboot (10)
Reset (11)
DMTF Reserved (.. )

Caption

Data type: string
Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Planned Virtual Machine".

CommunicationStatus

Data type: uint16
Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

CreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen ( 256 )

Indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified. This property is inherited from the CIM_System class.

Dedicated

Data type: uint16 array
Access type: Read-only

An array of values that indicate the purposes to which the planned system is dedicated, if any, and what functionality is provided. For example, one could specify that the System is dedicated to "Print" (value=11) or acts as a "Hub" (value=8). Multiple purposes can also be indicated. For example, this is a general purpose system indicating "Not Dedicated" (value=0) but that it also hosts "Print" (value=11) or "Mobile User Device" (value=17) services.

This property is inherited from the CIM_ComputerSystem class.

Value	Meaning
Not Dedicated 0
Unknown 1
Other 2
Storage 3
Router 4
Switch 5
Layer 3 Switch 6
Central Office Switch 7
Hub 8
Access Server 9
Firewall 10
Print 11
I/O 12
Web Caching 13
Management 14	Indicates this instance is dedicated to hosting system management software.
Block Server 15
File Server 16
Mobile User Device 17	An example of a dedicated mobile user device is a mobile phone or a bar code scanner in a store that communicates through radio frequency. These systems are quite limited in functionality and programmability, and are not considered general purpose computing platforms. Alternately, an example of a mobile system that is general purpose (that is, is NOT dedicated) is a hand-held computer. Although limited in its programmability, new software can be downloaded and its functionality expanded by the user.
Repeater 18
Bridge/Extender 19
Gateway 20
Storage Virtualizer 21
Media Library 22
ExtenderNode 23
NAS Head 24
Self-contained NAS 25
UPS 26
IP Phone 27
Management Controller 28	Indicates this instance represents specialized hardware dedicated to systems management (that is, a Baseboard Management Controller (BMC) or service processor). The management scope of a Management Controller is typically a single managed system in which it is contained.
Chassis Manager 29	Indicates this instance represents a system dedicated to management of a blade chassis and its contained devices. This value would be used to represent a Shelf Controller. A Chassis Manager is an aggregation point for management and may rely on subordinate management controllers for the management of constituent parts.
Host-based RAID controller 30	Indicates this instance represents a RAID storage controller contained within a host computer.
Storage Device Enclosure 31	Indicates this instance represents an enclosure that contains storage devices.
Desktop 32
Laptop 33
Virtual Tape Library 34	The emulation of a tape library by a Virtual Library System.
Virtual Library System 35	Uses disk storage to emulate tape libraries.
Network PC/Thin Client 36
FC Switch 37	Indicates this instance is dedicated to switching layer 2 Fibre Channel frames.
Ethernet Switch 38	Indicates this instance is dedicated to switching layer 2 Ethernet frames.
DMTF Reserved 39..32567
Vendor Reserved 32568..65535

Description

Data type: string
Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Microsoft Planned Virtual Machine".

DetailedStatus

Data type: uint16
Access type: Read-only

Complements the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

ElementName

Data type: string
Access type: Read-only

A display name for the object. This property is inherited from CIM_ManagedElement.

EnabledDefault

Data type: uint16
Access type: Read-only

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement, and can be one of the following values.

Value	Meaning
Disabled 3	The system is turned off.
Enabled but Offline 6	The system is enabled, but offline. Any new requests will be dropped.

EnabledState

Data type: uint16
Access type: Read-only

Specifies the enabled state of the planned system. This property is inherited from CIM_EnabledLogicalElement, and it can be one of the following values.

Value	Meaning
Disabled 3	The system is turned off.
Enabled but Offline 6	The system is enabled, but offline. Any new requests will be dropped.

HealthState

Data type: uint16
Access type: Read-only

The current health of the element. This property expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely nonfunctional. This property is inherited from CIM_ManagedSystemElement, and it is always set to 5 (OK).

Value	Meaning
5	The health status is normal.

IdentifyingDescriptions

Data type: string array
Access type: Read-only

An array of strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index. This property is inherited from the CIM_System class.

InstallDate

Data type: datetime
Access type: Read-only

The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

Name

Data type: string
Access type: Read-only
Qualifiers: Key, Override, MaxLen ( 256 )

The inherited name serves as the key of a system instance in an enterprise environment. This property is inherited from the CIM_System class.

NameFormat

Data type: string
Access type: Read-only
Qualifiers: MaxLen ( 64 )

Identifies how the system name was generated, using the heuristic of the subclass. The system object and its derivatives are top-level objects of CIM. They provide the scope for numerous components. Having unique system keys is required. A heuristic can be defined in individual system subclasses to attempt to always generate the same system name key. This property is inherited from the CIM_System class.

OnTimeInMilliseconds

Data type: uint64
Access type: Read-only
Qualifiers: Units ("MilliSeconds")

The total time, in milliseconds, since the virtual machine was last turned on, reset, or restored. This time excludes the time the virtual machine was in the paused state.

OperatingStatus

Data type: uint16
Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

OperationalStatus

Data type: uint16 array
Access type: Read-only

The current statuses of the object. This property is inherited from CIM_ManagedSystemElement, and each array element is always set to 2 (OK).

OtherDedicatedDescriptions

Data type: string array
Access type: Read-only

A string describing how or why the system is dedicated when the Dedicated array includes the value 2, "Other". This property is inherited from the CIM_ComputerSystem class.

OtherEnabledState

Data type: string
Access type: Read-only

A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to Null when EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

OtherIdentifyingInfo

Data type: string array
Access type: Read-only
Qualifiers: Key, MaxLen ( 256 )

Contains additional data, beyond system name information, that can be used to identify a ComputerSystem. One example would be to hold the Fibre Channel World-Wide Name (WWN) of a node. If only the Fibre Channel name is available and is unique (able to be used as the system key), then this property would be Null and the WWN would become the system key, its data placed in the Name property. This property is inherited from the CIM_System class.

PowerManagementCapabilities

Data type: uint16 array
Access type: Read-only

This property is inherited from the CIM_ComputerSystem class, but it is not supported.

PrimaryOwnerContact

Data type: string
Access type: Read/write
Qualifiers: MaxLen ( 256 )

A string that provides information on how the primary system owner can be reached (for example, phone number, email address, and so on). This property is inherited from the CIM_System class.

PrimaryOwnerName

Data type: string
Access type: Read/write
Qualifiers: MaxLen ( 64 )

The name of the primary system owner. The system owner is the primary user of the system. This property is inherited from the CIM_System class.

PrimaryStatus

Data type: uint16
Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status information for the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

ProcessID

Data type: uint32
Access type: Read-only

The identifier of the process under which this virtual machine is running. This value can be used to uniquely identify the instance of Vmwp.exe on the system that is running the virtual machine.

RequestedState

Data type: uint16
Access type: Read-only

The last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current states for an element. A particular instance of the CIM_EnabledLogicalElement class might not support the RequestedState property. If this occurs, the value 12 ("Not Applicable") is used. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 12 (Not Applicable).

Value	Meaning
12	Not applicable.

ResetCapability

Data type: uint16
Access type: Read-only

Specifies the reset capabilities of the computer system. This property is inherited from the CIM_ComputerSystem class.

Value	Meaning
Other 1
Unknown 2
Disabled 3	Hardware reset is not allowed.
Enabled 4	The computer system can be reset by using hardware (for example, the power and reset buttons).
Not Implemented 5

Roles

Data type: string array
Access type: Read/write

An array of strings that specifies the administrator-defined roles this system plays in the managed environment. Examples might be "Building 8 print server" or "Boise user directories". A single system may perform multiple roles. The instrumentation view of the roles of a system is defined by instantiating a specific subclass of system, or by properties in a subclass, or both. For example, the purpose of a ComputerSystem is defined using the Dedicated and OtherDedicatedDescription properties. This property is inherited from the CIM_System class.

Status

Data type: string
Access type: Read-only

This property is inherited from CIM_ManagedSystemElement, but it is not used.

StatusDescriptions

Data type: string array
Access type: Read-only

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement, and each array element is always set to "The service is running normally".

TimeOfLastConfigurationChange

Data type: datetime
Access type: Read-only

The date and time when the virtual machine configuration file was last modified. The configuration file is modified during certain virtual machine operations, as well as when any of the virtual machine or device settings are added, modified, or removed.

TimeOfLastStateChange

Data type: datetime
Access type: Read-only

The date and time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement, but it is not supported.

TransitioningToState

Data type: uint16
Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement.

Value	Meaning
Unknown 0
Enabled 2
Disabled 3
Shut Down 4
No Change 5	No transition is in progress.
Offline 6
Test 7
Defer 8
Quiesce 9
Reboot 10
Reset 11
Not Applicable 12	The implementation does not support representing ongoing transitions.
DMTF Reserved ..

Requirements

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