Skip to content
Was this article helpful?

Set-AppLibAppDisk

Changes the parameter values for an AppDisk.

Syntax

Set-AppLibAppDisk [-AppDiskName] <String> [-Description <String>] [-PassThru] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Set-AppLibAppDisk -AppDiskUid <Guid> [-Description <String>] [-PassThru] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Provides the ability to update the parameters of an existing AppDisk.

This allows the following parameters to be updated:

Description of the AppDisk.

To change the name of the AppDisk see Rename-AppLibAppDisk.

Parameters

Name Description Required? Pipeline Input Default Value
AppDiskName The name of the AppDisk to be updated. true false
AppDiskUid The identifier of the AppDisk to be updated. true false
Description The description to apply; may be empty. false false
PassThru Returns the affected record. By default, this cmdlet does not generate any output. false 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
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false
AdminAddress 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. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

Citrix.Applibrary.Sdk.Appdisk

This object provides details of the AppDisk and contains the following information:

  • AppDiskUid <Guid> The unique identifier for the AppDisk.

  • AppDiskName <string> The name of the AppDisk.

  • Description <string> A description of the AppDisk.

  • HostingUnitUid <Guid> The unique identifier of the hosting unit (from the Hosting Unit PowerShell snap-in) that the scheme uses.

  • HostingUnitName <string> The name of the hosting unit (from the Hosting Unit PowerShell snap-in) that the scheme uses.

  • VirtualDiskID <DateTime> The MCS disk identifier for the AppDisk.

  • TaskId <Guid> The identifier of any current task that is running for the AppDisk.

  • DiskLocalUid <Guid> The AppDNA identifier for the disk.

  • DiskLocalVersion <Guid> The AppDNA version specifier for the disk.

  • Scopes <ScopeReference[]> The Delegated Administration scopes in which the AppDisk falls Task <Task< The state of any current task that is running for the AppDisk.

  • State <AppDiskState> The overall lifecycle state of the AppDisk

  • StateString <string> The overall lifecycle state of the AppDisk as a string

  • AppDNAState <AppDNAState> The AppDNA lifecycle state of the AppDisk

  • AppDNAStateString <string> The AppDNA lifecycle state of the AppDisk as a string

  • NewVersionCreationInProgress <bool> A value indicating whether a new version of this AppDisk is currently being created

Notes

In the case of failure, the following errors can result.

  • AppDiskNotFound: The specified AppDisk could not be located.

  • DatabaseError: An error occurred in the service while attempting a database operation.

  • DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.

  • ServiceStatusInvalidDb: An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.

  • CommunicationError: An error occurred while communicating with the service.

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

  • ConfigurationLoggingError: The operation could not be performed because of a configuration logging error

  • 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

C:\PS> Set-AppLibAppDisk -AppDiskName MyDisk -Description "Experimental"

Description

Updates as AppDisk called "MyDisk" to have the description "Experimental".

Was this article helpful?