Msvm_ComputerSystem, ROOT\virtualization\v2

Class | Methods (5) | Properties (45) | Qualifiers (4) | Instances (2) | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

Represents a hosting computer system or virtual computer system. To retrieve information for the VMMS, use Msvm_VirtualSystemManagementService. Remarks: When a property of the Msvm_ComputerSystem class changes, the WMI provider indicates an __InstanceModificationEvent event that describes the changes. The previous state is contained in the PreviousInstance property, and the new state is contained in the TargetInstance property. This event is asynchronous; by the time the __InstanceModificationEvent event is processed, the TargetInstance property may not reflect the current state.

Msvm_ComputerSystem methods

Msvm_ComputerSystem has 5 methods (3 Local, 2 Derived)

NameOriginReturn
InjectNonMaskableInterruptMsvm_ComputerSystemuint32 {'out':True}
RequestReplicationStateChangeMsvm_ComputerSystemuint32 {'out':True}
RequestReplicationStateChangeExMsvm_ComputerSystemuint32 {'out':True}
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
SetPowerStateCIM_ComputerSystemuint32 {'out':True}

Msvm_ComputerSystem properties

Msvm_ComputerSystem has 45 properties (13 Local, 32 Derived)

NameOriginCIMType
AvailableRequestedStatesCIM_EnabledLogicalElement18 [uint16]
CaptionCIM_ManagedElement8 [string]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
key
CreationClassName
CIM_System8 [string]
DedicatedCIM_ComputerSystem18 [uint16]
DescriptionCIM_ManagedElement8 [string]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
EnhancedSessionModeStateMsvm_ComputerSystem18 [uint16]
FailedOverReplicationTypeMsvm_ComputerSystem18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
IdentifyingDescriptionsCIM_System8 [string]
InstallDateCIM_ManagedSystemElement101 [datetime]
InstanceIDCIM_ManagedElement8 [string]
LastApplicationConsistentReplicationTimeMsvm_ComputerSystem101 [DateTime]
LastReplicationTimeMsvm_ComputerSystem101 [DateTime]
LastReplicationTypeMsvm_ComputerSystem18 [uint16]
LastSuccessfulBackupTimeMsvm_ComputerSystem101 [DateTime]
key
Name
CIM_ManagedSystemElement8 [string]
NameFormatCIM_System8 [string]
NumberOfNumaNodesMsvm_ComputerSystem18 [uint16]
OnTimeInMillisecondsMsvm_ComputerSystem21 [uint64]
OperatingStatusCIM_ManagedSystemElement18 [uint16]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherDedicatedDescriptionsCIM_ComputerSystem8 [string]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
OtherIdentifyingInfoCIM_System8 [string]
PowerManagementCapabilitiesCIM_ComputerSystem18 [uint16]
PrimaryOwnerContactCIM_System8 [string]
PrimaryOwnerNameCIM_System8 [string]
PrimaryStatusCIM_ManagedSystemElement18 [uint16]
ProcessIDMsvm_ComputerSystem19 [uint32]
ReplicationHealthMsvm_ComputerSystem18 [uint16]
ReplicationModeMsvm_ComputerSystem18 [uint16]
ReplicationStateMsvm_ComputerSystem18 [uint16]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
ResetCapabilityCIM_ComputerSystem18 [uint16]
RolesCIM_System8 [string]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
TimeOfLastConfigurationChangeMsvm_ComputerSystem101 [datetime]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]
TransitioningToStateCIM_EnabledLogicalElement18 [uint16]

Detailed description of Msvm_ComputerSystem methods

Local methods (3) of Msvm_ComputerSystem class

InjectNonMaskableInterrupt method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Jobref:CIM_ConcreteJob0-{'Description':'May contain a reference to the ConcreteJob created to track the status of the interrupt injection.','Out':True}
Bypass_GetObjectTrue
ImplementedTrue
ValueMap['0', '4096', '32769']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Access Denied']
InjectNonMaskableInterrupt method is in 1 class (Msvm_ComputerSystem) of ROOT\virtualization\v2 and in 1 namespace
RequestReplicationStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'Indicates the requested state for the replication.','In':True,'ValueMap':['1', '2', '3', '4', '7', '9'],'Values':['Ready to start initial replication', 'Waiting to complete initial replication', 'Replicating', 'Synced replication complete', 'Suspend', 'Cancel Resynchronize']}
Jobref:CIM_ConcreteJob1-{'Description':'An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.','Out':True}
TimeoutPerioddatetime2-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned.','In':True}
Bypass_GetObjectTrue
Deprecated['Msvm_ComputerSystem.RequestReplicationStateChangeEx()']
Description'Requests that the state of the replication be changed to the value specified in the RequestedState parameter.'
ImplementedTrue
ModelCorrespondence['Msvm_ComputerSystem.ReplicationState']
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
RequestReplicationStateChange method is in 1 class (Msvm_ComputerSystem) of ROOT\virtualization\v2 and in 2 namespaces
RequestReplicationStateChangeEx method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ReplicationRelationshipstring0-{'Description':'The replication relationship for state change request.','HyperVEmbeddedInstance':'Msvm_ReplicationRelationship','In':True}
RequestedStateuint161-{'Description':'Indicates the requested state for the extended replication.','In':True,'ValueMap':['1', '2', '3', '4', '7', '9'],'Values':['Ready to start initial replication', 'Waiting to complete initial replication', 'Replicating', 'Synced replication complete', 'Suspend', 'Cancel Resynchronize']}
Jobref:CIM_ConcreteJob2-{'Description':'An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.','Out':True}
TimeoutPerioddatetime3-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned.','In':True}
Bypass_GetObjectTrue
Description'Requests that the state of the extended replication be changed to the value specified in the RequestedState parameter.'
ImplementedTrue
ModelCorrespondence['Msvm_ComputerSystem.ReplicationState']
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778', '32779']
Values['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found']
RequestReplicationStateChangeEx method is in 1 class (Msvm_ComputerSystem) of ROOT\virtualization\v2 and in 2 namespaces

Derived methods (2) of Msvm_ComputerSystem class

RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-{'Description':'May contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.'}
TimeoutPerioddatetime2-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned.'}
Bypass_GetObjectTrue
ImplementedTrue
ModelCorrespondence['CIM_EnabledLogicalElement.RequestedState']
ValueMap['0', '4096', '32768', '32769', '32770', '32771', '32772', '32773', '32774', '32775', '32776', '32777', '32778']
RequestStateChange method is in 111 classes of ROOT\virtualization\v2 and in 15 namespaces
SetPowerState method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
PowerStateuint320-{'Description':'The Desired state for the COmputerSystem.','ValueMap':['1', '2', '3', '4', '5', '6', '7', '8'],'Values':['Full Power', 'Power Save - Low Power Mode', 'Power Save - Standby', 'Power Save - Other', 'Power Cycle', 'Power Off', 'Hibernate', 'Soft Off']}
Timedatetime1-{'Description':'Time indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received.'}
SetPowerState method is in 68 classes of ROOT\virtualization\v2 and in 14 namespaces

Detailed description of Msvm_ComputerSystem properties

Local properties (13) of Msvm_ComputerSystem class

EnhancedSessionModeState property
CIMTYPE'uint16'
Description'Indicates whether or not enhanced mode connections are allowed by the host and if allowed, whether or not they are available to the virtual machine.'
readTrue
ValueMap['2', '3', '6']
Values['Allowed and available', 'Not allowed', 'Allowed but not available']
EnhancedSessionModeState property is in 2 classes of ROOT\virtualization\v2 and in 2 namespaces
FailedOverReplicationType property
CIMTYPE'uint16'
Deprecated['Msvm_ReplicationRelationship.FailedOverReplicationType']
Description'Type of failover that was performed for the virtual machine.'
readTrue
ValueMap['0', '1', '2', '3']
Values['None', 'Regular', 'Application consistent', 'Planned']
FailedOverReplicationType property is in 2 classes of ROOT\virtualization\v2 and in 2 namespaces
LastApplicationConsistentReplicationTime property
CIMTYPE'DateTime'
Deprecated['Msvm_ReplicationRelationship.LastApplicationConsistentReplicationTime']
Description'The time at which the last application consistent replication is received on recovery for the virtual machine.'
readTrue
LastApplicationConsistentReplicationTime property is in 2 classes of ROOT\virtualization\v2 and in 2 namespaces
LastReplicationTime property
CIMTYPE'DateTime'
Deprecated['Msvm_ReplicationRelationship.LastReplicationTime']
Description'The time at which the last replication is received on recovery for the virtual machine.'
readTrue
LastReplicationTime property is in 2 classes of ROOT\virtualization\v2 and in 2 namespaces
LastReplicationType property
CIMTYPE'uint16'
Deprecated['Msvm_ReplicationRelationship.LastReplicationType']
Description'Type of the last replication that was received for the virtual machine.'
readTrue
ValueMap['0', '1', '2', '3']
Values['None', 'Regular', 'Application consistent', 'Planned']
LastReplicationType property is in 2 classes of ROOT\virtualization\v2 and in 2 namespaces
LastSuccessfulBackupTime property
CIMTYPE'DateTime'
Description'The time at which the last successful backup has completed for the virtual machine.'
readTrue
LastSuccessfulBackupTime property is in 1 class (Msvm_ComputerSystem) of ROOT\virtualization\v2 and in 2 namespaces
NumberOfNumaNodes property
CIMTYPE'uint16'
Description'The number of non-uniform memory access (NUMA) nodes of the computer system. When Msvm_ComputerSystem represents the hosting computer system, this property contains the count of physical NUMA nodes. When Msvm_ComputerSystem represents a virtual computer system, this property contains the number of virtual NUMA nodes that are presented to the guest OS through the ACPI System Resource Affinity Table (SRAT).'
readTrue
NumberOfNumaNodes property is in 1 class (Msvm_ComputerSystem) of ROOT\virtualization\v2 and in 2 namespaces
OnTimeInMilliseconds property
CIMTYPE'uint64'
Description'For the virtual system, this property describes the total up time, in milliseconds, since the machine was last turned on, reset, or restored. This time excludes the time the virtual system was in the paused state. For the host system, this property is set to NULL.'
readTrue
Units'MilliSeconds'
OnTimeInMilliseconds property is in 2 classes of ROOT\virtualization\v2 and in 2 namespaces
ProcessID property
CIMTYPE'uint32'
Description'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.'
readTrue
ProcessID property is in 2 classes of ROOT\virtualization\v2 and in 18 namespaces
ReplicationHealth property
CIMTYPE'uint16'
Deprecated['Msvm_ReplicationRelationship.ReplicationHealth']
Description'Replication health for the virtual machine.'
readTrue
ValueMap['0', '1', '2', '3']
Values['Not applicable', 'Ok', 'Warning', 'Critical']
ReplicationHealth property is in 4 classes of ROOT\virtualization\v2 and in 2 namespaces
ReplicationMode property
CIMTYPE'uint16'
Description'Identifies replication type for the virtual machine.'
readTrue
ValueMap['0', '1', '2', '3', '4']
Values['None', 'Primary', 'Replica', 'Test Replica', 'Extended Replica']
ReplicationMode property is in 2 classes of ROOT\virtualization\v2 and in 2 namespaces
ReplicationState property
CIMTYPE'uint16'
Deprecated['Msvm_ReplicationRelationship.ReplicationState']
Description'Replication state for the virtual machine.'
readTrue
ValueMap['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14']
Values['Disabled', 'Ready for replication', 'Waiting to complete initial replication', 'Replicating', 'Synced replication complete', 'Recovered', 'Committed', 'Suspended', 'Critical', 'Waiting to start resynchronization', 'Resynchronizing', 'Resynchronization suspended', 'Failover in progress', 'Failback in progress', 'Failback complete']
ReplicationState property is in 3 classes of ROOT\virtualization\v2 and in 2 namespaces
TimeOfLastConfigurationChange property
CIMTYPE'datetime'
Description'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.'
readTrue
TimeOfLastConfigurationChange property is in 2 classes of ROOT\virtualization\v2 and in 2 namespaces

Derived properties (32) of Msvm_ComputerSystem class

AvailableRequestedStates property
CIMTYPE'uint16'
AvailableRequestedStates property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces
Caption property
CIMTYPE'string'
Caption property is in 222 classes of ROOT\virtualization\v2 and in 37 namespaces
CommunicationStatus property
CIMTYPE'uint16'
CommunicationStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
CreationClassName property
CIMTYPE'string'
keyTrue
CreationClassName property is in 113 classes of ROOT\virtualization\v2 and in 20 namespaces
Dedicated property
CIMTYPE'uint16'
Dedicated property is in 5 classes of ROOT\virtualization\v2 and in 8 namespaces
Description property
CIMTYPE'string'
Description property is in 225 classes of ROOT\virtualization\v2 and in 142 namespaces
DetailedStatus property
CIMTYPE'uint16'
DetailedStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
ElementName property
CIMTYPE'string'
ElementName property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
EnabledDefault property is in 106 classes of ROOT\virtualization\v2 and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
EnabledState property is in 116 classes of ROOT\virtualization\v2 and in 13 namespaces
HealthState property
CIMTYPE'uint16'
HealthState property is in 128 classes of ROOT\virtualization\v2 and in 15 namespaces
IdentifyingDescriptions property
CIMTYPE'string'
IdentifyingDescriptions property is in 69 classes of ROOT\virtualization\v2 and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
InstallDate property is in 127 classes of ROOT\virtualization\v2 and in 23 namespaces
InstanceID property
CIMTYPE'string'
InstanceID property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
Name property
CIMTYPE'string'
keyTrue
Name property is in 152 classes of ROOT\virtualization\v2 and in 142 namespaces
NameFormat property
CIMTYPE'string'
NameFormat property is in 22 classes of ROOT\virtualization\v2 and in 21 namespaces
OperatingStatus property
CIMTYPE'uint16'
OperatingStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
OperationalStatus property
CIMTYPE'uint16'
OperationalStatus property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
OtherDedicatedDescriptions property
CIMTYPE'string'
OtherDedicatedDescriptions property is in 5 classes of ROOT\virtualization\v2 and in 6 namespaces
OtherEnabledState property
CIMTYPE'string'
OtherEnabledState property is in 107 classes of ROOT\virtualization\v2 and in 11 namespaces
OtherIdentifyingInfo property
CIMTYPE'string'
OtherIdentifyingInfo property is in 69 classes of ROOT\virtualization\v2 and in 20 namespaces
PowerManagementCapabilities property
CIMTYPE'uint16'
PowerManagementCapabilities property is in 68 classes of ROOT\virtualization\v2 and in 14 namespaces
PrimaryOwnerContact property
CIMTYPE'string'
PrimaryOwnerContact property is in 30 classes of ROOT\virtualization\v2 and in 15 namespaces
PrimaryOwnerName property
CIMTYPE'string'
PrimaryOwnerName property is in 30 classes of ROOT\virtualization\v2 and in 15 namespaces
PrimaryStatus property
CIMTYPE'uint16'
PrimaryStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
RequestedState property
CIMTYPE'uint16'
RequestedState property is in 106 classes of ROOT\virtualization\v2 and in 12 namespaces
ResetCapability property
CIMTYPE'uint16'
ResetCapability property is in 5 classes of ROOT\virtualization\v2 and in 10 namespaces
Roles property
CIMTYPE'string'
Roles property is in 6 classes of ROOT\virtualization\v2 and in 17 namespaces
Status property
CIMTYPE'string'
Status property is in 127 classes of ROOT\virtualization\v2 and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
StatusDescriptions property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 111 classes of ROOT\virtualization\v2 and in 17 namespaces
TransitioningToState property
CIMTYPE'uint16'
TransitioningToState property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces

Msvm_ComputerSystem Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
Description'Represents a hosting computer system or virtual computer system.
To retrieve information for the VMMS, use Msvm_VirtualSystemManagementService.
Remarks: When a property of the Msvm_ComputerSystem class changes, the WMI provider indicates an __InstanceModificationEvent event that describes the changes. The previous state is contained in the PreviousInstance property, and the new state is contained in the TargetInstance property. This event is asynchronous; by the time the __InstanceModificationEvent event is processed, the TargetInstance property may not reflect the current state.'
dynamicTrue
Locale1033
provider'VmmsWmiInstanceAndMethodProvider'

Msvm_ComputerSystem System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\virtualization\v2:Msvm_ComputerSystem'___SYSTEM8
__NAMESPACE'ROOT\virtualization\v2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_ComputerSystem', 'CIM_System', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT45___SYSTEM3
__RELPATH'Msvm_ComputerSystem'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_ComputerSystem'___SYSTEM8
__CLASS'Msvm_ComputerSystem'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to Msvm_ComputerSystem

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_ComputerSystem4322-2-
Msvm_PlannedComputerSystem0362----
comments powered by Disqus
WUtils.com