Download full document:

# Set-HypHostingUnitStorage

Sets options for a storage location on a hosting unit.


Set-HypHostingUnitStorage [-LiteralPath] <String> [-StoragePath] <String> [-StorageType <StorageType>] [-Superseded <Boolean>] [-LoggingId <Guid>] [-BearerToken <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Use this command to set options for storage locations that are defined for a hosting unit. Do not use this command if the connection for the hosting unit is in maintenance mode.


Name Description Required? Pipeline Input Default Value
LiteralPath Specifies the path to the hosting unit which defines the storage. The path must be in one of the following formats: :\HostingUnits\ or :\HostingUnits{} true false
StoragePath Specifies the path to the storage that will be modified. The path must be in one of the following formats: :\Connections\\ or :\Connections{}\ or :\HostingUnits\\ or :\HostingUnits{}\ true true (ByValue)
StorageType Specifies the type of storage in StoragePath. Supported storage types are: OSStorage PersonalvDiskStorage TemporaryStorage false false OSStorage
Superseded Specifies that this storage has been superseded and must not be used for future provisioning operations. Existing virtual machines using this storage will continue to function. false false
LoggingId Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets. false false
BearerToken Specifies the bearer token assigned to the calling user false false
AdminAddress Specifies the address of a XenDesktop controller that the PowerShell snap-in connects. This can be a host name or an IP address. false false LocalHost. When a value is provided by any cmdlet, this value becomes the default.

Input Type

You can pipe a string that contains a path to Add-HypHostingUnitStorage (StoragePath parameter).

Return Values

Set-HypHostingUnitStorage returns an object containing the new definition of the hosting unit.
Specifies the unique identifier for the hosting unit.
Specifies the name of the hosting unit.
Specifies the connection that the hosting unit uses to access a hypervisor.
Identifies, to the hypervisor, the root of the hosting unit.
The hosting unit provider path that represents the root of the hosting unit.
The list of storage items that the hosting unit can use.
The list of storage items that the hosting unit can use for storing personal data.
Specifies whether or not the metadata in the hypervisor can be used to store information about the XenDesktop Machine Creation Service.
The hypervisor's internal identifier that represents the network specified for the hosting unit.
The hosting unit provider path to the network specified for the hosting unit.
The list of additional storage items that the hosting unit can use.
A list of key value pairs that can store additional information about the hosting unit.

## Notes The storage path must be valid for the hosting unit. The rules that are applied are as follows: XenServer (HypervisorConnection Type = XenServer)
VMWare vSphere/ESX (HypervisorConnection Type = vCenter)
The storage path must be directly contained in the root path item of the hosting unit.
Microsoft SCVMM/Hyper-v (HypervisorConnection Type = SCVMM)
Only one storage entry for these connection types is valid, and it must reference an SMB share. Additionally, if a Hyper-V failover cluster is used the SMB share must be the top-level mount point of the cluster shared volume on one of the servers in the cluster (i.e. C:\ClusterStorage).
In the case of failure, the following errors can be produced.
Error Codes
The path provided is not to an item in a subdirectory of a hosting unit item.
The specified path is invalid.
The storage path cannot be found or is invalid. See notes above about validity.
The specified storage path is already part of the hosting unit.
The hypervisor for the connection is in maintenance mode.
An error occurred in the service while attempting a database operation.
The operation could not be completed because the database for the service is not configured.
An error occurred in the service while attempting a database operation. Communication with the database failed for
for various reasons.
An error occurred while communicating with the service.
The user does not have administrative rights to perform this operation.
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used, or examine the XenDesktop logs.



c:\PS>Set-HypHostingUnitStorage -LiteralPath XDHyp:\HostingUnits\MyHostingUnit -StoragePath 'XDHyp:\HostingUnits\MyHostingUnits\' -Superseded $true

          HostingUnitUid       : bcd3d649-86d1-4aa8-8ec2-d322b6a2c457
          HostingUnitName      : MyHostingUnit
          HypervisorConnection : MyConnection
          RootPath             : /
          RootId               :
          NetworkPath          : /Network
          NetworkId            : ab47080b-ca15-771a-c8dc-6ad9650158f1
          Storage              : {/Local, /}
          PersonalvDiskStorage : {/}
          VMTaggingEnabled     : True
          AdditionalStorage    : {TemporaryStorage}
          Metadata             : {}

The command updates a storage location called "" associated with the hosting unit called "MyHostingUnit".