Win32_RDMSVirtualDesktopCollection, ROOT\CIMV2\rdms\ms_409

Description

Creating and Managing Virtual Desktop Collections

Win32_RDMSVirtualDesktopCollection methods

Win32_RDMSVirtualDesktopCollection has 14 methods (14 Local)

Name	Origin	Return
AddVirtualDesktop	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
CancelPatch	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
GetInt32Property	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
GetPatchProperties	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
GetStringProperty	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
ProvisioningEnumerateJobs	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
ProvisioningJobCancel	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
ProvisioningJobExecute	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
ProvisioningJobGetReport	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
ProvisioningPrepJob	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
RemoveVirtualDesktop	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
SchedulePatch	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
SetInt32Property	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}
SetStringProperty	Win32_RDMSVirtualDesktopCollection	uint32 {'out':True}

Win32_RDMSVirtualDesktopCollection properties

Win32_RDMSVirtualDesktopCollection has 13 properties (13 Local)

Name	Origin	CIMType
key Alias	Win32_RDMSVirtualDesktopCollection	8 [string]
CollectionDescription	Win32_RDMSVirtualDesktopCollection	8 [string]
IconContents	Win32_RDMSVirtualDesktopCollection	17 [uint8]
IsHA	Win32_RDMSVirtualDesktopCollection	11 [boolean]
IsManaged	Win32_RDMSVirtualDesktopCollection	11 [boolean]
IsUserAdmin	Win32_RDMSVirtualDesktopCollection	11 [boolean]
Name	Win32_RDMSVirtualDesktopCollection	8 [string]
RollbackEnabled	Win32_RDMSVirtualDesktopCollection	11 [boolean]
SecurityDescriptor	Win32_RDMSVirtualDesktopCollection	8 [string]
ShowInPortal	Win32_RDMSVirtualDesktopCollection	11 [boolean]
Type	Win32_RDMSVirtualDesktopCollection	19 [uint32]
UserVHDSetting	Win32_RDMSVirtualDesktopCollection	8 [string]
VmFarmSettings	Win32_RDMSVirtualDesktopCollection	8 [string]

Detailed description of Win32_RDMSVirtualDesktopCollection methods

Local methods (14) of Win32_RDMSVirtualDesktopCollection class

…

▲ AddVirtualDesktop method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
VMName	string	0	✓	-	{'in':True}

Description

'AddVirtualDesktop'

AddVirtualDesktop method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ CancelPatch method
Return	uint32 {'out':True}
Description	'Cancel pool patching, if the patch hasnt started'
CancelPatch method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ GetInt32Property method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
key	string	0	✓	-	{'in':True}
Value	sint32	1	-	✓	{'out':True}

Description

'Get integer property of the collection'

GetInt32Property method is in 4 classes of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ GetPatchProperties method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
StartTime	DATETIME	0	-	✓	{'out':True}
ForceLogOffTime	DATETIME	1	-	✓	{'out':True}
JobGuid	string	2	-	✓	{'out':True}
State	uint32	3	-	✓	{'out':True}

Description

'Gets the last patch job propertiesStartTime: Time at which patching gets triggered, but users wont be force logged offForceLogOffTime: Time at which the system forcibly logs off users and start patching of those vmsJobGuid: ID of the Provisioning jobState: State of the patching job.'

GetPatchProperties method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ GetStringProperty method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
key	string	0	✓	-	{'in':True}
Value	string	1	-	✓	{'out':True}

Description

'Get string property of the collection'

GetStringProperty method is in 4 classes of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ ProvisioningEnumerateJobs method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
JobType	uint32	0	✓	-	{'in':True}
CollectionAlias	string	1	✓	-	{'in':True}
JobGuids	string	2	-	✓	{'out':True}

Description

'Enumeration of all the jobs in the Service.Set 0 for only running jobs, 1 for only completed jobsProvide FALSE if you want only Running jobs.The second param is optional'

ProvisioningEnumerateJobs method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ ProvisioningJobCancel method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
JobGuid	string	0	✓	-	{'in':True}

Description

'Cancel Virtual Desktops Job executionJobGuid: ID of the job that needs to be canceled'

ProvisioningJobCancel method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ ProvisioningJobExecute method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
JobInputXml	string	0	✓	-	{'in':True}
JobGuid	string	1	-	✓	{'out':True}

Description

'Provision Virtual Desktops Job executionJobInputXml: XML format string containing the Provisioning details like Create/Update/PatchJobGuid: ID of the current started job'

ProvisioningJobExecute method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ ProvisioningJobGetReport method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
JobGuid	string	0	✓	-	{'in':True}
JobReportXml	string	1	-	✓	{'out':True}

Description

'job report or current statusJobGuid: ID of the Provisioning jobJobReportXml: details of the status/report of the given Provisioning'

ProvisioningJobGetReport method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ ProvisioningPrepJob method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
CollectionAlias	string	0	✓	-	{'in':True}
VMHostName	string	1	✓	-	{'in':True}
VMName	string	2	✓	-	{'in':True}
ExportToLocation	string	3	✓	-	{'in':True}
bSysPrep	boolean	4	✓	-	{'in':True}
MachineName	string	5	✓	-	{'in':True}
UserName	string	6	✓	-	{'in':True}
Password	string	7	✓	-	{'in':True}
JobGuid	string	8	-	✓	{'out':True}

Description

'ProvisioningPrepJob for Exporting and Sysprep of Reference VMCollectionAlias: Pool for which this job is associatedbSysprep: If FALSE, details are ignoredcreate a sysprep image and then export the VMJobGuid: ID of the current started job'

ProvisioningPrepJob method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ RemoveVirtualDesktop method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
VMName	string	0	✓	-	{'in':True}

Description

'RemoveVirtualDesktop'

RemoveVirtualDesktop method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ SchedulePatch method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
StartTime	DATETIME	0	✓	-	{'in':True}
ForceLogOffTime	DATETIME	1	✓	-	{'in':True}
JobInputXml	string	2	✓	-	{'in':True}

Description

'Triggers pool patchStartTime: Time at which patching gets triggered, but users wont be force logged offForceLogOffTime: Time at which the system forcibly logs off users and start patching of those vmsJobInputXml: XML format string containing the Provisioning details'

SchedulePatch method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ SetInt32Property method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
key	string	0	✓	-	{'in':True}
Value	sint32	1	✓	-	{'in':True}

Description

'Set integer property of the collection'

SetInt32Property method is in 4 classes of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ SetStringProperty method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
key	string	0	✓	-	{'in':True}
Value	string	1	✓	-	{'in':True}

Description

'Set string property of the collection'

SetStringProperty method is in 4 classes of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

Detailed description of Win32_RDMSVirtualDesktopCollection properties

Local properties (13) of Win32_RDMSVirtualDesktopCollection class

…

▲ Alias property
CIMTYPE	'string'
Description	'Alias of the Collection'
key	True
Alias property is in 3 classes of ROOT\CIMV2\rdms\ms_409 and in 8 namespaces

…

▲ CollectionDescription property
CIMTYPE	'string'
Description	'Description of the Collection'
CollectionDescription property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ IconContents property
CIMTYPE	'uint8'
Description	'Contents of the icon corresponding to the Collection'
IconContents property is in 3 classes of ROOT\CIMV2\rdms\ms_409 and in 4 namespaces

…

▲ IsHA property
CIMTYPE	'boolean'
Description	'Whether this Collection contains highly available VMs'
IsHA property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ IsManaged property
CIMTYPE	'boolean'
Description	'The kind of collection: Managed=TRUE, UnManaged=FALSE'
IsManaged property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ IsUserAdmin property
CIMTYPE	'boolean'
Description	'Whether the User is made an administrator on the VM'
IsUserAdmin property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 3 namespaces

…

▲ Name property
CIMTYPE	'string'
Description	'Name of the Collection'
Name property is in 10 classes of ROOT\CIMV2\rdms\ms_409 and in 142 namespaces

…

▲ RollbackEnabled property
CIMTYPE	'boolean'
Description	'Whether the VM is rolled back'
RollbackEnabled property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 3 namespaces

…

▲ SecurityDescriptor property
CIMTYPE	'string'
Description	'Security Descriptor controlling access to the Collection, in SDDL Format. Empty string implies allow all access. Does not support DENY ACEs, or ACEs referring to non-domain users or groups.'
SecurityDescriptor property is in 3 classes of ROOT\CIMV2\rdms\ms_409 and in 142 namespaces

…

▲ ShowInPortal property
CIMTYPE	'boolean'
Description	'Whether this Collection should be shown in the TS Web Access'
ShowInPortal property is in 2 classes of ROOT\CIMV2\rdms\ms_409 and in 4 namespaces

…

▲ Type property
CIMTYPE	'uint32'
Description	'The type of collection: TempVm=1, ManualPersonalVm=2, AutoPersonalVM=3'
Type property is in 2 classes of ROOT\CIMV2\rdms\ms_409 and in 142 namespaces

…

▲ UserVHDSetting property
CIMTYPE	'string'
Description	'User Data VHD Setting'
UserVHDSetting property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 2 namespaces

…

▲ VmFarmSettings property
CIMTYPE	'string'
Description	'Virtual machine Collection settings corresponding to the desktop'
VmFarmSettings property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms\ms_409 and in 4 namespaces

Win32_RDMSVirtualDesktopCollection Qualifiers

…

Name	Value	ToInstance	ToSubclass	Overridable	Amended	Local
AMENDMENT	True	✗	✗	✓	✗	✓
Description	'Creating and Managing Virtual Desktop Collections'	✗	✓	✓	✗	✓
LOCALE	1033	✗	✗	✓	✗	✓

Win32_RDMSVirtualDesktopCollection System properties

…

Name	Value	Origin	CIMType	Local	Array
__PATH	'\\.\ROOT\CIMV2\rdms\ms_409:Win32_RDMSVirtualDesktopCollection'	___SYSTEM	8	✗	✗
__NAMESPACE	'ROOT\CIMV2\rdms\ms_409'	___SYSTEM	8	✗	✗
__SERVER	'.'	___SYSTEM	8	✗	✗
__DERIVATION	[]	___SYSTEM	8	✗	✓
__PROPERTY_COUNT	13	___SYSTEM	3	✗	✗
__RELPATH	'Win32_RDMSVirtualDesktopCollection'	___SYSTEM	8	✗	✗
__DYNASTY	'Win32_RDMSVirtualDesktopCollection'	___SYSTEM	8	✗	✗
__SUPERCLASS	null	___SYSTEM	8	✗	✗
__CLASS	'Win32_RDMSVirtualDesktopCollection'	___SYSTEM	8	✗	✗
__GENUS	1	___SYSTEM	3	✗	✗

Similar Classes to Win32_RDMSVirtualDesktopCollection

Number of classes:2

…

Class name	Childs	Properties	Methods	Class Instances	Child Instances	Abstract	Singleton
Win32_RDMSCollectionProperties	0	10	1	-	-	-	-
Win32_RDSHCollection	0	3	4	-	-	-	-

WUtils.com

Includes&Samples

Win32_RDMSVirtualDesktopCollection, ROOT\CIMV2\rdms\ms_409

Description

Win32_RDMSVirtualDesktopCollection methods

Win32_RDMSVirtualDesktopCollection properties

Detailed description of Win32_RDMSVirtualDesktopCollection methods

Local methods (14) of Win32_RDMSVirtualDesktopCollection class

Detailed description of Win32_RDMSVirtualDesktopCollection properties

Local properties (13) of Win32_RDMSVirtualDesktopCollection class

Win32_RDMSVirtualDesktopCollection Qualifiers

Win32_RDMSVirtualDesktopCollection System properties

Similar Classes to Win32_RDMSVirtualDesktopCollection