Msvm_VirtualSystemGlobalSettingData Class (Windows)

Switch View

Msvm_VirtualSystemGlobalSettingData...

Msvm_VirtualSystemGlobalSettingData Class

Syntax

class Msvm_VirtualSystemGlobalSettingData : CIM_VirtualSystemSettingData
{
  string   Caption = "Global Virtual Machine Settings";
  string   Description = "Global settings for the virtual machine";
  string   ElementName = "Global Virtual Machine Settings";
  string   InstanceID = "Microsoft:GUID\Global";
  string   SystemName = "GUID";
  uint16   SettingType = 32768;
  uint16   VirtualSystemType = 301;
  string   OtherVirtualSystemType;
  boolean  AutoActivate;
  datetime CreationTime;
  string   ExternalDataRoot;
  string   SnapshotDataRoot;
  uint16   AutomaticStartupAction = 1;
  datetime AutomaticStartupActionDelay = "00000000000000.000000:000";
  uint16   AutomaticShutdownAction = 1;
  uint16   AutomaticRecoveryAction = 1;
  string   AdditionalRecoveryInformation;
  string   ScopeOfResidence;
  uint32   DebugChannelId;
  boolean  AllowFullSCSICommandSet = False;
  string   Version;
};

Methods

The Msvm_VirtualSystemGlobalSettingData class does not define any methods.

Properties

The Msvm_VirtualSystemGlobalSettingData class defines the following properties.

AdditionalRecoveryInformation

Data type: string
Access type: Read/write

Any additional information provided to the recovery action. The meaning of this property is defined by the action in AutomaticRecoveryAction. If AutomaticRecoveryAction is 0 (None) or 1 (Restart), this value is NULL. If AutomaticRecoveryAction is 2 (Revert to Snapshot), this is the object path to a snapshot that should be applied on failure of the virtual machine worker process.

This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.

AllowFullSCSICommandSet

Data type: boolean
Access type: Read/write

Indicates whether SCSI commands from the guest operating system are passed to pass-through disks. It is recommended that SCSI filtering remains enabled for production deployments.

This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.

Windows Server 2008: The AllowFullSCSICommandSet property is not supported before Windows Server 2008 R2.

Value	Meaning
False	SCSI commands emitted by the guest operating system to pass-through disks are filtered.
True	SCSI commands emitted by the guest operating system to pass-through disks are not filtered.

AutoActivate

Data type: boolean
Access type: Read/write

This property is inherited from CIM_VirtualSystemSettingData and it is set to NULL.

Windows Server 2008: The AutoActivate property is not supported before Windows Server 2008 R2.

AutomaticRecoveryAction

Data type: uint16
Access type: Read/write

The action to be taken if the virtual machine worker process terminates abnormally. The default action is 1 (Restart).

This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.

Name	Value
None	0
Restart	1
Revert to Snapshot	2

AutomaticShutdownAction

Data type: uint16
Access type: Read/write

The action to take when the host is shut down. The default action is 1 (Save State).

This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.

Name	Value
Turn Off	0
Save State	1
ShutDown	2

AutomaticStartupAction

Data type: uint16
Access type: Read/write

The action to be taken when the host is started. The default action is 1 ("Restart if Previously Running").

This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.

Value	Meaning
0	None
1	Restart if Previously Running
2	Always Startup

AutomaticStartupActionDelay

Data type: datetime
Access type: Read/write

The time interval to wait before performing the startup action. By default, there is no delay.

This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.

Caption

Data type: string
Access type: Read-only

A short textual description (one-line string) of the object. This property is inherited from CIM_ManagedElement and it is set to "Global Virtual Machine Settings".

CreationTime

Data type: datetime
Access type: Read-only

The date or time when the virtual system setting data was created. For snapshots, this value corresponds to the time at which the snapshot was taken. For non-snapshots, this value corresponds to the time at which the virtual system was created. This property is inherited from CIM_VirtualSystemSettingData.

This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.

Windows Server 2008: The CreationTime property is not supported before Windows Server 2008 R2.

DebugChannelId

Data type: uint32
Access type: Read/write

The channel identifier used to debug the virtual system using the VUD unified debugger.

Description

Data type: string
Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and it is set to "Global settings for the virtual machine".

ElementName

Data type: string
Access type: Read-only

A user-friendly name for the object. This property is inherited from CIM_ManagedElement and it defaults to "Global Virtual Machine Settings". Changing this property will change the ElementName of the associated Msvm_ComputerSystem derivative.

This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.

ExternalDataRoot

Data type: string
Access type: Read-only

The fully-qualified path to the root directory of an external data store. This store is managed by the virtual system management service and may contain private data from multiple virtual systems. This property may be specified only at the time the virtual machine is defined.

This is a read-only property, but it can be changed before the virtual machine is created using the DefineVirtualSystem method of the Msvm_VirtualSystemManagementService class.

InstanceID

Data type: string
Access type: Read-only

This property is inherited from CIM_SettingData and it is set to "Microsoft:GUID\Global".

OtherVirtualSystemType

Data type: string
Access type: Read-only

This property is inherited from CIM_VirtualSystemSettingData and it is set to NULL.

Windows Server 2008: The OtherVirtualSystemType property is not supported before Windows Server 2008 R2.

ScopeOfResidence

Data type: string
Access type: Read/write

The authorization scope to use in determining the access control policy for this virtual system.

This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.

SettingType

Data type: uint16
Access type: Read-only

This property is inherited from CIM_VirtualSystemSettingData and it is set to 32768, which means "Global setting type".

Windows Server 2008: The SettingType property is not supported before Windows Server 2008 R2.

SnapshotDataRoot

Data type: string
Access type: Read-only

The fully-qualified path to the root directory of the external data store used to store snapshots for this virtual system. This store is managed by the virtual system management service and may contain private data from multiple virtual systems. Changes made to this property affect only snapshots taken subsequent to the change.

This is a read-only property, but it can be changed using the ModifyVirtualSystem method of the Msvm_VirtualSystemManagementService class.

SystemName

Data type: string
Access type: Read-only

The label by which the object is known. This property is inherited from CIM_VirtualSystemSettingData and it is set to "GUID". This coresponds to the Name property of the associated Msvm_ComputerSystem class and the SystemName property of the associated Msvm_VirtualSystemSettingData class.

Windows Server 2008: The SystemName property is not supported before Windows Server 2008 R2.

Version

Data type: string
Access type: Read-only

The version of the virtual system in a format of "major.minor", for example "2.0".

Windows Server 2008: The Version property is not supported before Windows Server 2008 R2.

VirtualSystemType

Data type: uint16
Access type: Read-only

This property is inherited from CIM_VirtualSystemSettingData and it is set to 301, which means "Hyper-V".

Windows Server 2008: The VirtualSystemType property is not supported before Windows Server 2008 R2.

Remarks

Access to the Msvm_VirtualSystemGlobalSettingData class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2008
MOF	WindowsVirtualization.mof
Namespace	\\.\Root\Virtualization

Syntax

Methods

Properties

Remarks

Requirements

See Also