Win32_RDMSVirtualDesktopCollection, ROOT\CIMV2\rdms

Class | Methods (14) | Properties (13) | Qualifiers (4) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

Creating and Managing Virtual Desktop Collections

Win32_RDMSVirtualDesktopCollection methods

Win32_RDMSVirtualDesktopCollection has 14 methods (14 Local)

NameOriginReturn
AddVirtualDesktopWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
CancelPatchWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
GetInt32PropertyWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
GetPatchPropertiesWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
GetStringPropertyWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
ProvisioningEnumerateJobsWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
ProvisioningJobCancelWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
ProvisioningJobExecuteWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
ProvisioningJobGetReportWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
ProvisioningPrepJobWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
RemoveVirtualDesktopWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
SchedulePatchWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
SetInt32PropertyWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}
SetStringPropertyWin32_RDMSVirtualDesktopCollectionuint32 {'out':True}

Win32_RDMSVirtualDesktopCollection properties

Win32_RDMSVirtualDesktopCollection has 13 properties (13 Local)

NameOriginCIMType
key
Alias
Win32_RDMSVirtualDesktopCollection8 [string]
CollectionDescriptionWin32_RDMSVirtualDesktopCollection8 [string]
IconContentsWin32_RDMSVirtualDesktopCollection17 [uint8]
IsHAWin32_RDMSVirtualDesktopCollection11 [boolean]
IsManagedWin32_RDMSVirtualDesktopCollection11 [boolean]
IsUserAdminWin32_RDMSVirtualDesktopCollection11 [boolean]
NameWin32_RDMSVirtualDesktopCollection8 [string]
RollbackEnabledWin32_RDMSVirtualDesktopCollection11 [boolean]
SecurityDescriptorWin32_RDMSVirtualDesktopCollection8 [string]
ShowInPortalWin32_RDMSVirtualDesktopCollection11 [boolean]
TypeWin32_RDMSVirtualDesktopCollection19 [uint32]
UserVHDSettingWin32_RDMSVirtualDesktopCollection8 [string]
VmFarmSettingsWin32_RDMSVirtualDesktopCollection8 [string]

Detailed description of Win32_RDMSVirtualDesktopCollection methods

Local methods (14) of Win32_RDMSVirtualDesktopCollection class

AddVirtualDesktop method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
VMNamestring0-{'in':True}
Description'AddVirtualDesktop'
implementedTrue
AddVirtualDesktop method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
CancelPatch method
Returnuint32 {'out':True}
Description'Cancel pool patching, if the patch hasnt started'
implementedTrue
CancelPatch method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
GetInt32Property method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
keystring0-{'in':True}
Valuesint321-{'out':True}
Description'Get integer property of the collection'
implementedTrue
GetInt32Property method is in 4 classes of ROOT\CIMV2\rdms and in 2 namespaces
GetPatchProperties method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
StartTimeDATETIME0-{'out':True}
ForceLogOffTimeDATETIME1-{'out':True}
JobGuidstring2-{'out':True}
Stateuint323-{'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.'
implementedTrue
GetPatchProperties method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
GetStringProperty method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
keystring0-{'in':True}
Valuestring1-{'out':True}
Description'Get string property of the collection'
implementedTrue
GetStringProperty method is in 4 classes of ROOT\CIMV2\rdms and in 2 namespaces
ProvisioningEnumerateJobs method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
JobTypeuint320-{'in':True}
CollectionAliasstring1-{'in':True}
JobGuidsstring2-{'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'
implementedTrue
staticTrue
ProvisioningEnumerateJobs method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
ProvisioningJobCancel method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
JobGuidstring0-{'in':True}
Description'Cancel Virtual Desktops Job executionJobGuid: ID of the job that needs to be canceled'
implementedTrue
staticTrue
ProvisioningJobCancel method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
ProvisioningJobExecute method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
JobInputXmlstring0-{'in':True}
JobGuidstring1-{'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'
implementedTrue
staticTrue
ProvisioningJobExecute method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
ProvisioningJobGetReport method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
JobGuidstring0-{'in':True}
JobReportXmlstring1-{'out':True}
Description'job report or current statusJobGuid: ID of the Provisioning jobJobReportXml: details of the status/report of the given Provisioning'
implementedTrue
staticTrue
ProvisioningJobGetReport method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
ProvisioningPrepJob method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
CollectionAliasstring0-{'in':True}
VMHostNamestring1-{'in':True}
VMNamestring2-{'in':True}
ExportToLocationstring3-{'in':True}
bSysPrepboolean4-{'in':True}
MachineNamestring5-{'in':True,'opt':True}
UserNamestring6-{'in':True,'opt':True}
Passwordstring7-{'in':True,'opt':True}
JobGuidstring8-{'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'
implementedTrue
staticTrue
ProvisioningPrepJob method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
RemoveVirtualDesktop method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
VMNamestring0-{'in':True}
Description'RemoveVirtualDesktop'
implementedTrue
RemoveVirtualDesktop method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
SchedulePatch method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
StartTimeDATETIME0-{'in':True}
ForceLogOffTimeDATETIME1-{'in':True}
JobInputXmlstring2-{'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'
implementedTrue
SchedulePatch method is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
SetInt32Property method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
keystring0-{'in':True}
Valuesint321-{'in':True}
Description'Set integer property of the collection'
implementedTrue
SetInt32Property method is in 4 classes of ROOT\CIMV2\rdms and in 2 namespaces
SetStringProperty method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
keystring0-{'in':True}
Valuestring1-{'in':True}
Description'Set string property of the collection'
implementedTrue
SetStringProperty method is in 4 classes of ROOT\CIMV2\rdms 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'
keyTrue
readTrue
writeTrue
Alias property is in 3 classes of ROOT\CIMV2\rdms and in 8 namespaces
CollectionDescription property
CIMTYPE'string'
Description'Description of the Collection'
optionalTrue
readTrue
writeTrue
CollectionDescription property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
IconContents property
CIMTYPE'uint8'
Description'Contents of the icon corresponding to the Collection'
optionalTrue
readTrue
writeTrue
IconContents property is in 3 classes of ROOT\CIMV2\rdms and in 4 namespaces
IsHA property
CIMTYPE'boolean'
Description'Whether this Collection contains highly available VMs'
readTrue
writeTrue
IsHA property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
IsManaged property
CIMTYPE'boolean'
Description'The kind of collection: Managed=TRUE, UnManaged=FALSE'
readTrue
writeTrue
IsManaged property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
IsUserAdmin property
CIMTYPE'boolean'
Description'Whether the User is made an administrator on the VM'
readTrue
writeTrue
IsUserAdmin property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 3 namespaces
Name property
CIMTYPE'string'
Description'Name of the Collection'
readTrue
writeTrue
Name property is in 10 classes of ROOT\CIMV2\rdms and in 142 namespaces
RollbackEnabled property
CIMTYPE'boolean'
Description'Whether the VM is rolled back'
readTrue
writeTrue
RollbackEnabled property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms 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.'
optionalTrue
readTrue
writeTrue
SecurityDescriptor property is in 3 classes of ROOT\CIMV2\rdms and in 142 namespaces
ShowInPortal property
CIMTYPE'boolean'
Description'Whether this Collection should be shown in the TS Web Access'
readTrue
writeTrue
ShowInPortal property is in 2 classes of ROOT\CIMV2\rdms and in 4 namespaces
Type property
CIMTYPE'uint32'
Description'The type of collection: TempVm=1, ManualPersonalVm=2, AutoPersonalVM=3'
readTrue
ValueMap['1', '2', '3']
Values['TempVM', 'ManualPersonalVM', 'AutoPersonalVM']
writeTrue
Type property is in 2 classes of ROOT\CIMV2\rdms and in 142 namespaces
UserVHDSetting property
CIMTYPE'string'
Description'User Data VHD Setting'
optionalTrue
readTrue
writeTrue
UserVHDSetting property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 2 namespaces
VmFarmSettings property
CIMTYPE'string'
Description'Virtual machine Collection settings corresponding to the desktop'
optionalTrue
readTrue
writeTrue
VmFarmSettings property is in 1 class (Win32_RDMSVirtualDesktopCollection) of ROOT\CIMV2\rdms and in 4 namespaces

Win32_RDMSVirtualDesktopCollection Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
Description'Creating and Managing Virtual Desktop Collections'
dynamicTrue
LOCALE1033
provider'Win32_RDManagement_Prov'

Win32_RDMSVirtualDesktopCollection System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\CIMV2\rdms:Win32_RDMSVirtualDesktopCollection'___SYSTEM8
__NAMESPACE'ROOT\CIMV2\rdms'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION[]___SYSTEM8
__PROPERTY_COUNT13___SYSTEM3
__RELPATH'Win32_RDMSVirtualDesktopCollection'___SYSTEM8
__DYNASTY'Win32_RDMSVirtualDesktopCollection'___SYSTEM8
__SUPERCLASSnull___SYSTEM8
__CLASS'Win32_RDMSVirtualDesktopCollection'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to Win32_RDMSVirtualDesktopCollection

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
Win32_RDMSCollectionProperties0101----
Win32_RDSHCollection034----
comments powered by Disqus
online utility - toplist
WUtils.com