Msvm_ImageManagementService, ROOT\virtualization\v2\ms_409

Description

Manages the virtual media (.vhdx, .vhd, .iso, or .vfd files) for a virtual machine.

Msvm_ImageManagementService methods

Msvm_ImageManagementService has 13 methods (13 Local)

Name	Origin	Return
AttachVirtualHardDisk	Msvm_ImageManagementService	uint32 {'out':True}
CompactVirtualHardDisk	Msvm_ImageManagementService	uint32 {'out':True}
ConvertVirtualHardDisk	Msvm_ImageManagementService	uint32 {'out':True}
CreateVirtualFloppyDisk	Msvm_ImageManagementService	uint32 {'out':True}
CreateVirtualHardDisk	Msvm_ImageManagementService	uint32 {'out':True}
GetVirtualHardDiskSettingData	Msvm_ImageManagementService	uint32 {'out':True}
GetVirtualHardDiskState	Msvm_ImageManagementService	uint32 {'out':True}
MergeVirtualHardDisk	Msvm_ImageManagementService	uint32 {'out':True}
ResizeVirtualHardDisk	Msvm_ImageManagementService	uint32 {'out':True}
SetParentVirtualHardDisk	Msvm_ImageManagementService	uint32 {'out':True}
SetVirtualHardDiskSettingData	Msvm_ImageManagementService	uint32 {'out':True}
ValidatePersistentReservationSupport	Msvm_ImageManagementService	uint32 {'out':True}
ValidateVirtualHardDisk	Msvm_ImageManagementService	uint32 {'out':True}

Detailed description of Msvm_ImageManagementService methods

Local methods (13) of Msvm_ImageManagementService class

…

▲ AttachVirtualHardDisk method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
Path	string	0	✓	-	{'Description':'A fully-qualified path that specifies the location of the virtual disk image file.','In':True}
AssignDriveLetter	boolean	1	✓	-	{'Description':'Indicates if drive letters are assigned to the disk's volumes.','In':True}
ReadOnly	boolean	2	✓	-	{'Description':'Indicates if the mount should be read only.','In':True}
Job	ref:CIM_ConcreteJob	3	-	✓	{'Description':'A reference to the job (can be null if the task is completed).','Out':True}

Description

'Attaches a virtual disk image file in loopback mode.'

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']

AttachVirtualHardDisk method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ CompactVirtualHardDisk method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
Path	string	0	✓	-	{'Description':'A fully-qualified path that specifies the location of the merging file.','In':True}
Mode	uint16	1	✓	-	{'Description':'An enumeration value that specifies the mode for the compact operation.','In':True,'Values':['Full', 'Quick', 'Retrim', 'Pretrimmed', 'Prezeroed']}
Job	ref:CIM_ConcreteJob	2	-	✓	{'Description':'A reference to the job (can be null if the task is completed).','Out':True}

Description

'Compacts a dynamic virtual hard disk file. Compacting is the process of unallocating unused portions of the virtual hard disk.'

Values

CompactVirtualHardDisk method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ ConvertVirtualHardDisk method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
SourcePath	string	0	✓	-	{'Description':'A fully-qualified path that specifies the location of the virtual hard disk file. This file will not be modified as a result of this operation.','In':True}
VirtualDiskSettingData	string	1	✓	-	{'In':True}
Job	ref:CIM_ConcreteJob	2	-	✓	{'Description':'A reference to the job (can be null if the task is completed).','Out':True}

Description

'Converts the type of an existing virtual hard disk.'

Values

ConvertVirtualHardDisk method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ CreateVirtualFloppyDisk method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
Path	string	0	✓	-	{'Description':'A fully-qualified path that specifies the location of the new file.','In':True}
Job	ref:CIM_ConcreteJob	1	-	✓	{'Description':'A reference to the job (can be null if the task is completed).','Out':True}

Description

'Creates a virtual floppy disk (.vfd) file.'

Values

CreateVirtualFloppyDisk method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ CreateVirtualHardDisk method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
VirtualDiskSettingData	string	0	✓	-	{'In':True}
Job	ref:CIM_ConcreteJob	1	-	✓	{'Description':'A reference to the job (can be null if the task is completed).','Out':True}

Description

'Creates a virtual hard disk file.'

Values

CreateVirtualHardDisk method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ GetVirtualHardDiskSettingData method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
Path	string	0	✓	-	{'Description':'A fully-qualified path that specifies the location of the disk image file.','In':True}
SettingData	string	1	-	✓	{'Description':'If successful, this object contains the information for the requested virtual hard disk. This is an embedded instance of Msvm_VirtualHardDiskSettingData.','Out':True}
Job	ref:CIM_ConcreteJob	2	-	✓	{'Description':'A reference to the job (can be null if the task is completed).','Out':True}

Description

'Retrieves setting data associated with virtual hard disk files.'

Values

GetVirtualHardDiskSettingData method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ GetVirtualHardDiskState method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
Path	string	0	✓	-	{'Description':'A fully-qualified path that specifies the location of the disk image file.','In':True}
State	string	1	-	✓	{'Description':'If successful, this object contains the information for the requested virtual hard disk. This is an embedded instance of Msvm_VirtualHardDiskState.','Out':True}
Job	ref:CIM_ConcreteJob	2	-	✓	{'Description':'A reference to the job (can be null if the task is completed).','Out':True}

Description

'Retrieves state of virtual hard disk files.'

Values

GetVirtualHardDiskState method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ MergeVirtualHardDisk method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
SourcePath	string	0	✓	-	{'Description':'A fully-qualified path that specifies the location of the merging file.','In':True}
DestinationPath	string	1	✓	-	{'Description':'A fully-qualified path that specifies the location of the parent disk image file into which data is to be merged. This could be the immediate parent virtual disk image of the merging file or parent disk image few levels up the differencing drive chain.','In':True}
Job	ref:CIM_ConcreteJob	2	-	✓	{'Description':'A reference to the job (can be null if the task is completed).','Out':True}

Description

'Merges a differencing virtual hard disk file with its parents. If the user executing this function does not have permission to update the virtual machines, then this function will fail.'

Values

MergeVirtualHardDisk method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ ResizeVirtualHardDisk method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
Path	string	0	✓	-	{'Description':'A fully qualified path that specifies the location of the disk image file.','In':True}
MaxInternalSize	uint64	1	✓	-	{'Description':'The maximum size of the virtual hard disk as viewable by the virtual machine, in bytes. MaxInternalsize minimum value is DiskSize + 512 - (DiskSize mod 512). DiskSize is the disk image file in number of bytes. The InvalidParameter error (32773) is returned if the MaxInternalsize value specified is less than the minimum value.','In':True}
Job	ref:CIM_ConcreteJob	2	-	✓	{'Description':'A reference to the job (can be null if the task is completed).','Out':True}

Description

'Resizes an existing virtual hard disk file.'

Values

ResizeVirtualHardDisk method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ SetParentVirtualHardDisk method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
ChildPath	string	0	✓	-	{'Description':'A fully-qualified path that specifies the location of the child disk image file.','In':True}
ParentPath	string	1	✓	-	{'Description':'A fully-qualified path that specifies the location of the parent virtual hard disk file.','In':True}
LeafPath	string	2	✓	-	{'Description':'A fully-qualified path that specifies the location of the leaf disk image file.','In':True}
IgnoreIDMismatch	boolean	3	✓	-	{'Description':'Indicates if the parent should be forcibly set when the virtual disk IDs do not match.','In':True}
Job	ref:CIM_ConcreteJob	4	-	✓	{'Description':'A reference to the job (can be NULL if the task is completed).','Out':True}

Description

'Updates the parent for the specified leaf and child.'

Values

SetParentVirtualHardDisk method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ SetVirtualHardDiskSettingData method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
VirtualDiskSettingData	string	0	✓	-	{'In':True}
Job	ref:CIM_ConcreteJob	1	-	✓	{'Description':'A reference to the job (can be null if the task is completed).','Out':True}

Description

'Sets a virtual hard disk file.'

Values

SetVirtualHardDiskSettingData method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ ValidatePersistentReservationSupport method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
Path	string	0	✓	-	{'Description':'A fully-qualified path that specifies the location of a disk image file or a directory in which a disk image file might be placed.','In':True}
Job	ref:CIM_ConcreteJob	1	-	✓	{'Description':'A reference to the job (can be null if the task is completed succesfully).','Out':True}

Description

'Validates whether a file system can support a virtual hard disk with persistent reservations enabled.'

Values

ValidatePersistentReservationSupport method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

…

▲ ValidateVirtualHardDisk method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
Path	string	0	✓	-	{'Description':'A fully-qualified path that specifies the location of the disk image file.','In':True}
Job	ref:CIM_ConcreteJob	1	-	✓	{'Description':'A reference to the job (can be null if the task is completed succesfully).','Out':True}

Description

'Validates whether a virtual disk image can be opened in read-only mode.'

Values

ValidateVirtualHardDisk method is in 1 class (Msvm_ImageManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces

Msvm_ImageManagementService Qualifiers

…

Name	Value	ToInstance	ToSubclass	Overridable	Amended	Local
AMENDMENT	True	✗	✗	✓	✗	✓
Description	'Manages the virtual media (.vhdx, .vhd, .iso, or .vfd files) for a virtual machine.'	✗	✗	✓	✗	✓
LOCALE	1033	✗	✗	✓	✗	✓

Msvm_ImageManagementService System properties

…

Name	Value	Origin	CIMType	Local	Array
__PATH	'\\.\ROOT\virtualization\v2\ms_409:Msvm_ImageManagementService'	___SYSTEM	8	✗	✗
__NAMESPACE	'ROOT\virtualization\v2\ms_409'	___SYSTEM	8	✗	✗
__SERVER	'.'	___SYSTEM	8	✗	✗
__DERIVATION	['CIM_Service', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']	___SYSTEM	8	✗	✓
__PROPERTY_COUNT	0	___SYSTEM	3	✗	✗
__RELPATH	'Msvm_ImageManagementService'	___SYSTEM	8	✗	✗
__DYNASTY	'CIM_ManagedElement'	___SYSTEM	8	✗	✗
__SUPERCLASS	'CIM_Service'	___SYSTEM	8	✗	✗
__CLASS	'Msvm_ImageManagementService'	___SYSTEM	8	✗	✗
__GENUS	1	___SYSTEM	3	✗	✗

WUtils.com

Includes&Samples

Msvm_ImageManagementService, ROOT\virtualization\v2\ms_409

Description

Msvm_ImageManagementService methods

Detailed description of Msvm_ImageManagementService methods

Local methods (13) of Msvm_ImageManagementService class

Msvm_ImageManagementService Qualifiers

Msvm_ImageManagementService System properties