Citrix Virtual Apps and Desktops SDK

New-HypStorage

Creates a new storage tier definition for use in a subsequent New-Item operation.

Syntax

New-HypStorage
   [-JobGroup] <Guid>
   -StorageType <StorageType>
   -StoragePath <String[]>
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Use this command to create a new storage tier definition, this definition can then be associated with a subsequent New-Item operation via the JobGroup reference.

Examples

EXAMPLE 1

The command creates a new job group with the unique id specified by $job which can subsequently be fed into the New-Item cmdlet. It defines a TemporaryStorage tier which will cause disks to be added to the storage path ‘XDHyp:\Connections\MyConnection\Primary Storage.storage’.

$job = [Guid]::NewGuid()
New-HypStorage -JobGroup $job -StorageType TemporaryStorage -StoragePath @('XDHyp:\Connections\MyConnection\Primary Storage.storage')
<!--NeedCopy-->

Parameters

-StorageType

The type of the new storage tier. Currently the only storage type is TemporaryStorage.

Type: StorageType
Accepted values: OSStorage, PersonalvDiskStorage, TemporaryStorage
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-StoragePath

Specifies the path to the storage that will be added. The path must be in one of the following formats: <drive>:\Connections\<ConnectionName>\MyStorage.storage or <drive>:\Connections{<Connection Uid>}\MyStorage.storage

Type: String[]
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-JobGroup

Specifies the JobGroup uid that is used to associate data from calls to this cmdlet with the subsequent New-Item operation.

Type: Guid
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

New-HypStorage