GetProvisioningProperties method of the Win32_RDMSCollectionProperties class

Retrieves the provisioning properties of the virtual desktop collection.

Syntax

uint32 GetProvisioningProperties(
  [out] string  PoolVhdType,
  [out] string  MasterVmLocation,
  [out] string  NamePrefix,
  [out] uint32  NameStartIndex,
  [out] string  LocalVmLocation,
  [out] string  LocalGoldVmLocation,
  [out] boolean RunFromSMB,
  [out] string  SMBLocation,
  [out] boolean SMBStreaming,
  [out] string  VmDomain,
  [out] string  VmOU,
  [out] string  ProductKey
);

Parameters

PoolVhdType [out]

Specifies the VHD (virtual hard disk) format of the virtual machine pool in the collection.

Clone

A cloned VHD.

DiffDisk

A differencing VHD.

MasterVmLocation [out]

Receives the path to the master VM image.

NamePrefix [out]

Receives the name prefix to append to the beginning of virtual machine names.

NameStartIndex [out]

Start index.

LocalVmLocation [out]

Receives the local path to the virtual machines on the Hyper-V servers. If this parameter is set to NULL or if it is empty, the default virtual machine directory will be used.

LocalGoldVmLocation [out]

Receives the local path to the golden VHD image when the PoolVhdTpe parameter is set to "DiffDisk". If this parameter is set to NULL or if it is empty, the default virtual machine directory will be used.

RunFromSMB [out]

Receives a value that indicates whether to run the collection from an Server Message Block (SMB) share. TRUE to run the virtual machines from an SBM share; otherwise; FALSE.

SMBLocation [out]

Receives the path to the SMB share if SMB sharing is enabled.

SMBStreaming [out]

Receives a value that indicates whether SMB streaming is enabled. TRUE if SMB sharing is enabled; otherwise; FALSE.

VmDomain [out]

Receives the domain name of the virtual machines in the collection.

VmOU [out]

Receives the Active Directory organization unit (OU) of the virtual machines in the collection.

ProductKey [out]

Receives the OS product keys for the virtual machines in the collection.

Return value

Returns 0 on success, otherwise returns a WMI error code.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\CIMv2\rdms
MOF	RDManagement.mof
DLL	RDMS.dll

See also

Win32_RDMSCollectionProperties