Product Documentation

Test-HypHostingUnitNameAvailable

Nov 06, 2015

Checks to see if the proposed name for a hosting unit is unused.

Syntax

Test-HypHostingUnitNameAvailable -HostingUnitName <String[]> [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Checks to see if the proposed name for a hosting unit is unused. This check is done without regard for scoping of existing hosting unit, so even the names of inaccessible hosting units will be checked.

Related topics

New-Item

Rename-Item

Parameters

-HostingUnitName<String[]>

The name or names of the hosting units(s) to be tested.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue, ByPropertyName)

-AdminAddress<String>

Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

Return Values

object[]

An array of PSObjects which pair the name and availability of the name

Notes

In the case of failure the following errors can be produced.

Error Codes

-----------

DatabaseError

An error occurred in the service whilst attempting a database operation.

DatabaseNotConfigured

The operation could not be completed as the database for the service is not configured.

DataStoreException

An error occurred in the service whilst attempting a database operation - communication to database failed for

for various reasons.

CommunicationError

An error occurred whilst communicating with the service.

PermissionDenied

The user does not have administrative rights to perform this operation.

ExceptionThrown

An unexpected error occurred. To locate more details see the Windows event logs on the controller being used, or examine the XenDesktop logs.

Examples

-------------------------- EXAMPLE 1 --------------------------

Test-HypHostingUnitNameAvailable -HostingUnitName $NewHostingUnitName

This will test whether the if the value of $NewHostingUnitName could be used to create a new hosting unit or rename an existing one without failing because the name is not unique, returning true if the name is good.