CIM_VirtualSystemManagementService, ROOT\virtualization\v2

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

Description

Service to define and manipulate virtual systems and their components

CIM_VirtualSystemManagementService - child subclasses in ROOT\virtualization\v2

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
Msvm_VirtualEthernetSwitchManagementService028121---
Msvm_VirtualSystemManagementService028331---

CIM_VirtualSystemManagementService methods

CIM_VirtualSystemManagementService has 9 methods (6 Local, 3 Derived)

NameOriginReturn
AddResourceSettingsCIM_VirtualSystemManagementServiceuint32 {'out':True}
DefineSystemCIM_VirtualSystemManagementServiceuint32 {'out':True}
DestroySystemCIM_VirtualSystemManagementServiceuint32 {'out':True}
ModifyResourceSettingsCIM_VirtualSystemManagementServiceuint32 {'out':True}
ModifySystemSettingsCIM_VirtualSystemManagementServiceuint32 {'out':True}
RemoveResourceSettingsCIM_VirtualSystemManagementServiceuint32 {'out':True}
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
StartServiceCIM_Serviceuint32 {'out':True}
StopServiceCIM_Serviceuint32 {'out':True}

CIM_VirtualSystemManagementService properties

CIM_VirtualSystemManagementService has 28 properties (28 Derived)

NameOriginCIMType
AvailableRequestedStatesCIM_EnabledLogicalElement18 [uint16]
CaptionCIM_ManagedElement8 [string]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
key
CreationClassName
CIM_Service8 [string]
DescriptionCIM_ManagedElement8 [string]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
InstanceIDCIM_ManagedElement8 [string]
key
Name
CIM_ManagedSystemElement8 [string]
OperatingStatusCIM_ManagedSystemElement18 [uint16]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
PrimaryOwnerContactCIM_Service8 [string]
PrimaryOwnerNameCIM_Service8 [string]
PrimaryStatusCIM_ManagedSystemElement18 [uint16]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
StartedCIM_Service11 [boolean]
StartModeCIM_Service8 [string]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
key
SystemCreationClassName
CIM_Service8 [string]
key
SystemName
CIM_Service8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]
TransitioningToStateCIM_EnabledLogicalElement18 [uint16]

Detailed description of CIM_VirtualSystemManagementService methods

Local methods (6) of CIM_VirtualSystemManagementService class

AddResourceSettings method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
AffectedConfigurationref:CIM_VirtualSystemSettingData0-{'Description':'Reference to the affected virtual system configuration.'}
ResourceSettingsstring1-{'ArrayType':'Indexed','Description':'Array of strings each containing one embedded instance of class CIM_ResourceAllocationSettingData that describes the virtual aspects of a virtual resource to be added to the virtual system.','HyperVEmbeddedInstance':'CIM_ResourceAllocationSettingData'}
ResultingResourceSettingsref:CIM_ResourceAllocationSettingData2-{'ArrayType':'Indexed','Description':'Array of references to instances of class CIM_ResourceAllocationSettingData representing virtual aspects of the added virtual resources.','Out':True}
Jobref:CIM_ConcreteJob3-{'Description':'If the operation is long running, then optionally a job may be returned. In this case, the instances of class CIM_ResourceAllocationSettingData representing the added resource settings are available via association CIM_ConreteComponent from the instance of class CIM_VirtualSystemSettingData representing the affected virtual system configuration.','Out':True}
Description'Adds resources to a virtual system configuration
.When applied to a "state" virtual system configuration, as a side effect resources are added to the active virtual system.'
ValueMap['0', '1', '2', '3', '4', '..', '4096', '4097..32767', '32768..65535']
Values['Completed with No Error', 'Not Supported', 'Failed', 'Timeout', 'Invalid Parameter', 'DMTF Reserved', 'Method Parameters Checked - Job Started', 'Method Reserved', 'Vendor Specific']
AddResourceSettings method is in 3 classes of ROOT\virtualization\v2 and in 2 namespaces
DefineSystem method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
SystemSettingsstring0-{'Description':'String containing an embedded instance of class CIM_VirtualSystemSettingData that is used to define attributes of the virtual system to be created.','HyperVEmbeddedInstance':'CIM_VirtualSystemSettingData'}
ResourceSettingsstring1-{'ArrayType':'Indexed','Description':'Array of strings each containing an embedded instance of class CIM_ResourceAllocationSettingData that describes the virtual aspects of a virtual resource to be created in the scope of the new virtual system.','HyperVEmbeddedInstance':'CIM_ResourceAllocationSettingData'}
ReferenceConfigurationref:CIM_VirtualSystemSettingData2-{'Description':'Reference to an instance of class CIM_VirtualSystemSettingData object that is the top level object of a reference virtual system configuration. The reference configuration is used to complement the configuration of the new virtual system if parameters SystemSettings and ResourceSettings did not provide respective information.'}
ResultingSystemref:CIM_ComputerSystem3-{'Description':'If a virtual computer system is successfully defined, a reference to an instance of class CIM_ComputerSystem that represents the newly defined virtual computer system is returned.','Out':True}
Jobref:CIM_ConcreteJob4-{'Description':'If the operation is long running, then optionally a job may be returned. In this case, the instance of class CIM_ComputerSystem representing the new virtual systemis presented via association CIM_AffectedJobElementwith property AffectedElement refering to the new instance of class CIM_ComputerSystem and property ElementEffects set to 5 (Create).','Out':True}
Description'Defines a virtual system.
Input that is not completely specified may be filled out with default values.'
ValueMap['0', '1', '2', '3', '4', '..', '4096', '4097..32767', '32768..65535']
Values['Completed with No Error', 'Not Supported', 'Failed', 'Timeout', 'Invalid Parameter', 'DMTF Reserved', 'Method Parameters Checked - Job Started', 'Method Reserved', 'Vendor Specific']
DefineSystem method is in 3 classes of ROOT\virtualization\v2 and in 2 namespaces
DestroySystem method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
AffectedSystemref:CIM_ComputerSystem0-{'Description':'Reference to an instance of class CIM_ComputerSystem representing the virtual computer system that it to be destroyed.'}
Jobref:CIM_ConcreteJob1-{'Description':'If the operation is long running, then optionally a job may be returned.','Out':True}
Description'Destroys a virtual system.
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 those resources (implementation dependent). If the virtual system is active when the operation is invoked, it is first deactivated and then destroyed. If snapshots were created from the virtual system, these are destroyed as well.'
ValueMap['0', '1', '2', '3', '4', '5', '..', '4096', '4097..32767', '32768..65535']
Values['Completed with No Error', 'Not Supported', 'Failed', 'Timeout', 'Invalid Parameter', 'Invalid State', 'DMTF Reserved', 'Method Parameters Checked - Job Started', 'Method Reserved', 'Vendor Specific']
DestroySystem method is in 3 classes of ROOT\virtualization\v2 and in 2 namespaces
ModifyResourceSettings method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ResourceSettingsstring0-{'ArrayType':'Indexed','Description':'Array of strings each containing an embedded instance of class CIM_ResourceAllocationSettingData that describes modifications to the virtual aspects of an existing virtual resource. All instances must have a valid InstanceID in order to identify the virtual resource setting to be modified.','HyperVEmbeddedInstance':'CIM_ResourceAllocationSettingData'}
ResultingResourceSettingsref:CIM_ResourceAllocationSettingData1-{'ArrayType':'Indexed','Description':'Array of references to instances of class Cim_ResourceAllocationSettingData representing virtual aspects of the modified virtual resources.','Out':True}
Jobref:CIM_ConcreteJob2-{'Description':'If the operation is long running, then optionally a job be returned. In this case, the instances of class CIM_ResourceAllocationSettingData representing the modified resource settings are available via association CIM_ConreteComponent from the instance of class CIM_VirtualSystemSettingData representing the affected virtual system configuration.','Out':True}
Description'Modifies virtual resource settings.
When applied to parts of a "current" virtual system configuration, as a side effect resources of the active virtual system may be modified.'
ValueMap['0', '1', '2', '3', '4', '5', '6', '..', '4096', '4097..32767', '32768..65535']
Values['Completed with No Error', 'Not Supported', 'Failed', 'Timeout', 'Invalid Parameter', 'Invalid State', 'Incompatible Parameters', 'DMTF Reserved', 'Method Parameters Checked - Job Started', 'Method Reserved', 'Vendor Specific']
ModifyResourceSettings method is in 3 classes of ROOT\virtualization\v2 and in 2 namespaces
ModifySystemSettings method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
SystemSettingsstring0-{'Description':'String containing an instance of class CIM_VirtualSystemSettingData that is used to modify the settings of the virtual system. The instance must have a valid InstanceID in order to identify the virtual system setting to be modified.','HyperVEmbeddedInstance':'CIM_VirtualSystemSettingData'}
Jobref:CIM_ConcreteJob1-{'Description':'If the operation is long running, then optionally a job may be returned.','Out':True}
Description'Modifies virtual system settings.
When applied to the system settings of a "current" virtual system configuration, as a side effect the virtual system instance may be modified.'
ValueMap['0', '1', '2', '3', '4', '5', '6', '..', '4096', '4097..32767', '32768..65535']
Values['Completed with No Error', 'Not Supported', 'Failed', 'Timeout', 'Invalid Parameter', 'Invalid State', 'Incompatible Parameters', 'DMTF Reserved', 'Method Parameters Checked - Job Started', 'Method Reserved', 'Vendor Specific']
ModifySystemSettings method is in 3 classes of ROOT\virtualization\v2 and in 2 namespaces
RemoveResourceSettings method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ResourceSettingsref:CIM_ResourceAllocationSettingData0-{'Description':'Array of references to instances of class CIM_ResourceAllocationSettingData where each instance represents the settings of a virtual resource within a virtual system configuration that are to be removed.'}
Jobref:CIM_ConcreteJob1-{'Description':'If the operation is long running, then optionally a job my be returned.','Out':True}
Description'Removes virtual resource settings from a virtual system configuration.
When applied to parts of a "current" virtual system configuration, as a side effect resources of the active virtual system may be removed.'
ValueMap['0', '1', '2', '3', '4', '5', '..', '4096', '4097..32767', '32768..65535']
Values['Completed with No Error', 'Not Supported', 'Failed', 'Timeout', 'Invalid Parameter', 'Invalid State', 'DMTF Reserved', 'Method Parameters Checked - Job Started', 'Method Reserved', 'Vendor Specific']
RemoveResourceSettings method is in 3 classes of ROOT\virtualization\v2 and in 2 namespaces

Derived methods (3) of CIM_VirtualSystemManagementService 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.'}
RequestStateChange method is in 111 classes of ROOT\virtualization\v2 and in 15 namespaces
StartService method
Returnuint32 {'out':True}
StartService method is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces
StopService method
Returnuint32 {'out':True}
StopService method is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces

Detailed description of CIM_VirtualSystemManagementService properties

Derived properties (28) of CIM_VirtualSystemManagementService 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
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
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
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
OtherEnabledState property
CIMTYPE'string'
OtherEnabledState property is in 107 classes of ROOT\virtualization\v2 and in 11 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
Started property
CIMTYPE'boolean'
Started property is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces
StartMode property
CIMTYPE'string'
StartMode property is in 23 classes of ROOT\virtualization\v2 and in 15 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
SystemCreationClassName property
CIMTYPE'string'
keyTrue
SystemCreationClassName property is in 109 classes of ROOT\virtualization\v2 and in 20 namespaces
SystemName property
CIMTYPE'string'
keyTrue
SystemName property is in 109 classes of ROOT\virtualization\v2 and in 22 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

CIM_VirtualSystemManagementService Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AbstractTrue
Description'Service to define and manipulate virtual systems and their components'
LOCALE1033
UMLPackagePath'CIM::Core::Virtualization'
Version'2.22.0'

CIM_VirtualSystemManagementService System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\virtualization\v2:CIM_VirtualSystemManagementService'___SYSTEM8
__NAMESPACE'ROOT\virtualization\v2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_Service', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT28___SYSTEM3
__RELPATH'CIM_VirtualSystemManagementService'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_Service'___SYSTEM8
__CLASS'CIM_VirtualSystemManagementService'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_VirtualSystemManagementService

Number of classes:43
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_ForwardingService2343---
CIM_HostedService220-10-
CIM_MetricService1289-1-
CIM_MetricServiceCapabilities1130-1-
CIM_NetworkService1323---
CIM_ResourcePoolConfigurationService0289---
CIM_Service12283-1-
CIM_ServiceAccessPoint1241---
CIM_ServiceAffectsElement140-40-
CIM_ServiceComponent120---
CIM_ServiceSAPDependency120---
CIM_SwitchService0383---
CIM_SwitchServiceTransparentBridging020---
CIM_TransparentBridgingService1363---
CIM_VirtualSystemMigrationService1287-1-
CIM_VirtualSystemSnapshotService1286-1-
Msvm_GuestFileService0284----
Msvm_GuestService1283----
Msvm_GuestServiceInterfaceComponent0388----
Msvm_GuestServiceInterfaceComponentSettingData02401---
Msvm_HostedService02010---
Msvm_HostedSwitchService020----
Msvm_ImageManagementService028161---
Msvm_MetricService028101---
Msvm_MetricServiceCapabilities01301---
Msvm_MetricServiceSettingData0501---
Msvm_RegisteredGuestService020----
Msvm_ReplicationService028291---
Msvm_ReplicationServiceSettingData01101---
Msvm_ResourcePoolConfigurationService02871---
Msvm_ServiceAffectsElement04040---
Msvm_Synthetic3DService02861---
Msvm_Synthetic3DServiceSettingData0501---
Msvm_TerminalService02871---
Msvm_TerminalServiceSettingData0901---
Msvm_TransparentBridgingService0363----
Msvm_VirtualEthernetSwitchManagementService028121---
Msvm_VirtualSystemManagementService028331---
Msvm_VirtualSystemManagementServiceSettingData01701---
Msvm_VirtualSystemMigrationService031151---
Msvm_VirtualSystemMigrationServiceSettingData01001---
Msvm_VirtualSystemMigrationServiceSettingDataComponent020----
Msvm_VirtualSystemSnapshotService02881---
WUtils.com
online utility - toplist