Msvm_VirtualSystemImportSettingData class

Article
05/31/2018

Represents settings of a virtual system to import. Used by the ImportVirtualSystemEx method of the Msvm_VirtualSystemManagementService class.

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

Syntax

[AMENDMENT]
class Msvm_VirtualSystemImportSettingData : CIM_SettingData
{
  string  Caption;
  string  Description;
  string  InstanceID;
  string  ElementName;
  boolean GenerateNewId;
  boolean CreateCopy;
  string  Name;
  string  SourceVmDataRoot;
  string  SourceSnapshotDataRoot;
  string  SourceVhdDataRoot;
  string  TargetVmDataRoot;
  string  TargetSnapshotDataRoot;
  string  TargetVhdDataRoot;
  string  SecurityScope;
  string  CurrentResourcePaths[];
  string  SourceResourcePaths[];
  string  TargetResourcePaths[];
  string  SourceNetworkConnections[];
  string  TargetNetworkConnections[];
};

Members

The Msvm_VirtualSystemImportSettingData class has these types of members:

Properties

Properties

The Msvm_VirtualSystemImportSettingData class has these properties.

Caption

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

A short description (one-line string) of the object. This property is inherited from CIM_SettingData.

CreateCopy

Data type: boolean
Access type: Read/write

Indicates whether the VM will be copied when imported.

Value	Meaning
TRUE	The VM will be copied when imported. The TargetVmDataRoot, TargetSnapshotDataRoot, TargetVhdDataRoot properties give the target for the new copy. The TargetResourcePaths property gives the target paths for the copies made from the resources specified in the SourceResourcePaths property.
FALSE	The VM will not be copied when imported. The TargetVmDataRoot, TargetSnapshotDataRoot, TargetVhdDataRoot, and TargetResourcePaths properties are ignored.

CurrentResourcePaths

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

Array of strings that represents the current resources of the VM that is being imported. Each resource is represented as one string.

Description

Data type: string
Access type: Read-only

A description of the object. This property is inherited from CIM_SettingData.

ElementName

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

The display name for this instance. In addition, the display name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.) This property is inherited from CIM_SettingData.

GenerateNewId

Data type: boolean
Access type: Read/write

Indicates whether new IDs will be generated for VMs that are imported.

Value	Meaning
TRUE	New IDs will be generated.
FALSE	The IDs will remain the same.

InstanceID

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

Within the scope of the instantiating Namespace, InstanceID property opaquely and uniquely identifies an instance of this class. This property is inherited from CIM_SettingData.

Name

Data type: string
Access type: Read/write

If set, the imported VM will have this name.

SecurityScope

Data type: string
Access type: Read/write

If set, the imported VM will have this set as the ScopeOfResidence property.

SourceNetworkConnections

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

Array of strings containing the FriendlyName properties of the source switches to which the VM is connected.

SourceResourcePaths

Data type: string array
Access type: Read/write
Qualifiers: ArrayType ("Indexed")

Array of strings containing the source locations for the resources specified in the CurrentResourcePaths property.

SourceSnapshotDataRoot

Data type: string
Access type: Read/write

Represents the folder for the snapshot data files for the VM being imported. If VM was exported without state information, this property should contain the SnapshotDataRoot where the VM state files are present. ImportVirtualSystemEx will not import the VM if a VM was exported without a state and this property is not satisfied. If VM is exported with state, this property will contain the SnapshotDataRoot directory under Import Directory.

SourceVhdDataRoot

Data type: string
Access type: Read/write

Represents the folder for the VM VHD data files for the VM being imported. If VM was exported without state information, this property should contain the VhdDataRoot where the VM state files are present. ImportVirtualSystemEx will not import the VM if a VM was exported without a state and this property is not satisfied. If VM is exported with state, this property will contain the VhdDataRoot directory under Import Directory. If the VHD files are being stored on different directories, they will be specified with the SourceResourcePaths and TargetResourcePaths properties. In this case, this property will be ignored.

SourceVmDataRoot

Data type: string
Access type: Read/write

Represents the folder for the VM data files for the VM being imported. If VM was exported without state information, this property should contain the VmDataRoot where the VM state files are present. ImportVirtualSystemEx will not import the VM if a VM was exported without a state and this property is not satisfied. If VM is exported with state, this property will contain the VmDataRoot directory under Import Directory.

TargetNetworkConnections

Data type: string array
Access type: Read/write
Qualifiers: ArrayType ("Indexed")

Array of strings containing the FriendlyName properties for the target switches to which the VM is to be connected.

TargetResourcePaths

Data type: string array
Access type: Read/write
Qualifiers: ArrayType ("Indexed")

Array of strings containing the target locations for the resources specified in the CurrentResourcePaths property.

TargetSnapshotDataRoot

Data type: string
Access type: Read/write

Represents the target snapshot data root for the VM being imported if the CreateCopy property is set to TRUE. If the CreateCopy property is set to FALSE, this property is ignored.

TargetVhdDataRoot

Data type: string
Access type: Read/write

Represents the target VHD data root for the VM being imported if the CreateCopy property is set to TRUE. If the CreateCopy property is set to FALSE, this property is ignored.

TargetVmDataRoot

Data type: string
Access type: Read/write

Represents the target VM data root for the VM being imported if the CreateCopy property is set to TRUE. If the CreateCopy property is set to FALSE, this property is ignored.

Remarks

Access to the Msvm_VirtualSystemImportSettingData 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 R2
End of client support	None supported
End of server support	Windows Server 2012 R2
Namespace	Root\Virtualization
MOF	WindowsVirtualization.mof

Share via