Download full document:

# Start-AppLibAppDiskAnalysis

Starts an AppDNA analysis for an AppDisk

Syntax

Start-AppLibAppDiskAnalysis [-AppDiskName] <String> [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Start-AppLibAppDiskAnalysis -AppDiskUid <Guid> [-RunAsynchronously] [-PurgeJobOnSuccess] [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

AppDNA will analyse the chosen AppDisk to check for any compatability issues.

Parameters

Name Description Required? Pipeline Input Default Value
AppDiskName The name of the AppDisk to analyse true false
AppDiskUid The unique identifier of the App Disk to analyse true true (ByPropertyName)
RunAsynchronously Indicates whether or not the command returns before it is complete. If specified, the command returns an identifier for the task that was created. This task can be monitored using the Get-AppLibTask command. false false false
PurgeJobOnSuccess Indicates that the task history is removed from the database when the task has finished. This can only be specified for tasks that are not run asynchronously. 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
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

System.Guid

When the RunAsynchronously identifier is specified, this GUID is returned and provides the task identifier### System.Management.Automation.PSCustomObject System.Management.Automation.PSCustomObject This object provides details of the task that was run and contains the following information:
TaskId The identifier for the task that was performed. Active Indicates whether the task is still processing or is complete. Host The name of the host on which the task is running or was run. DateStarted The date and time that the task was initiated. LastUpdateTime The date and time of the last task status update DateFinished The date and time that the task finished execution Metadata Associated key-value data TaskState Where in its lifecycle the task is CurrentOperation Operation specific phase of the overall "Running" task state. TerminatingError < Citrix.Fma.Sdk.ServiceCore.CommonCmdlets.TaskterminatingError> Diagnostic information in the case of a complete task failure ActiveElapsedTime How many seconds of active execution the task has taken Type The type of task. For this cmdlet's tasks, this is always ImportAppDisk. AppDiskName The name of the AppDisk that the task was for. AppDiskUid The identifier of the AppDisk that the task was for. Scopes The delegated administration scopes to which the AppDisk will belong. TaskStateInformation Additional information about the current task state. TaskProgress The progress of the task 0-100%. DiskLocalUid The identifier of the AppDisk lineage. DiskLocalVersion The identifier of the AppDisk within its lineage. RemoteTaskId The identifier of the associated disk management task on the Machine Creation Service HostingUnitName The name of the associated hosting unit HostingUnitUid The indentifier of the associated hosting unit VirtualDiskId The identifier of the AppDisk stack DiskId The hypervisor's identifier for the disk being imported RunAppDnaAnalysis Whether AppDNA analysis has been run ReservedMachineSid Security identifier of the VM being used to perform the operation## Notes Only one long-running task for each AppDisk can be processed at a time.
In case of failure, the following errors can result.
Error Codes
-----------
JobCreationFailed
The requested task could not be started.
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
for various reasons.
CommunicationError
An error occurred while communicating with the service.
InvalidParameterCombination
Both PurgeJobOnSuccess and RunAsynchronously were specified. When running asynchronously, the cmdlet terminates before the job does, so it cannot clean up the completed job.
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.
ScopeNotFound
One or more of the scopes nominated for the imported AppDisk do not exist.
ExceptionThrown
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used, or examine the XenDesktop logs.