Citrix Virtual Apps and Desktops SDK


Gets configuration data for the service.


Get-ProvServiceConfigurationData [-Name <String[]>] [-Value <String[]>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]


Detailed Description

Provides the ability to retrieve the configuration parameters for the Machine Creation Service.


Name Description Required? Pipeline Input Default Value
Name The configuration data item name. false false  
Value The configuration data item value. false false  
ReturnTotalRecordCount When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Prov_Filtering for details. false false False
MaxRecordCount Specifies the maximum number of records to return. false false 250
Skip Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. false false 0
SortBy Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present. false false The default sort order is by name or unique identifier.
Filter Gets records that match a PowerShell-style filter expression. See about_Prov_Filtering for details. false false  
FilterScope Gets only results allowed by the specified scope id. 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 user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops 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


This object provides details of the configuration data and contains the following information:

  • Name <string> The name for the configuration item.

  • Value <string> The value for the configuration item.


In the case of failure the following errors can be produced.

UnknownObject One of the specified objects was not found.
PartialData Only a subset of the available data was returned.
InvalidFilter A filtering expression was supplied that could not be interpreted for this cmdlet.
CouldNotQueryDatabase The query required to get the database was not defined.
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.
DataStoreException An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
PermissionDenied You do not have permission to execute this command.
AuthorizationError There was a problem communicating with the Citrix Delegated Administration Service.
CommunicationError An error occurred while communicating with the service.
ExceptionThrown An unexpected error occurred. For more details see the Windows event logs on the controller being used, or Citrix Virtual Apps and Desktops logs.


Example 1


Name                : DeltaDiskDelete.timeDelay

Value               : 10



Get the Configuration data for the service.