Citrix Virtual Apps and Desktops SDK

Rename-AppLibAppDisk

August 3, 2023

Contributed by:

Renames a AppDisk.

Syntax

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

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

<!--NeedCopy-->

Detailed Description

Provides the ability to change the name of an existing AppDisk. The unique identifier for the AppDisk never changes after it has been created so, regardless of any name changes, the AppDisk can always be identified by its unique identifier.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
AppDiskName	The current name of the AppDisk.	true	false
AppDiskUid	The identifier for the AppDisk that is to be renamed.	true	false
NewAppDiskName	The new name for the AppDisk. This must be a name that is not being used by an existing AppDisk, and it must not contain any of the following characters \/;:#.*?=<>\|”“’	true	false
PassThru	Defines whether or not the command returns a result showing the new state of the updated AppDisk.	false	false	true
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 that the PowerShell snap-in connects 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.
AppDiskNameAlreadyExists: A AppDisk with the same name as the new AppDisk name already exists.
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>Rename-AppLibAppDisk -AppDiskName CurrentName -NewAppDiskName NewName

<!--NeedCopy-->

Description

Renames a AppDisk from “currentName” to “NewName”.

Example 2

C:\PS>Rename-AppLibAppDisk -AppDiskName CurrentName -NewAppDiskName NewName -PassThru

          AppDiskUid             : 7585f0de-192e-4847-a6d8-22713c3a2f42

          AppDiskName            : NewName

          Description                 : Microsoft Office 2013

          MasterStorageID             : 03743136-e43b-4a87-af74-ab71686b3c16

          MasterDiskID                : c0571690-4f57-4476-901b-fe64d6aecb79

          HostingUnitUid              : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501

          HostingUnitName             : HostUnit1

          TaskId                      : 00000000-0000-0000-0000-000000000000

          DiskLocalUid                : 4F8323D9-6978-4CA0-8231-22F9185C71B6

          DiskLocalVersion            : DDA81A28-6BF4-41E1-A120-67F72C164DF6

          Scopes                      :

<!--NeedCopy-->

Description

Renames a AppDisk from “currentName” to “NewName” and displays the resulting state.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Rename-AppLibAppDisk

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Rename-AppLibAppDisk

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Applibrary.Sdk.Appdisk

Notes

Examples

Example 1

Description

Example 2

Description

In this article