# Get-AdminRoleConfiguration
Gets role configurations for this site.
Syntax
Get-AdminRoleConfiguration [[-Name] <String>] [-Id <Guid>] [-Locale <String>] [-Priority <Int32>] [-Version <String>] [-Property <String[]>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description
Retrieves role configurations matching the specified criteria. If no parameters are specified, this cmdlet enumerates and returns all role configurations.
Role configurations are part of the product configuration and define what permissions, permission groups, and built-in roles the product has. This cmdlet also provides the mapping of permissions to operations.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Name | Gets role configurations matching the specified name. | false | true (ByValue, ByPropertyName) | |
| Id | Gets role configurations with the specified id. | false | true (ByPropertyName) | |
| Locale | Gets role configurations with the specified locale. Role configurations usually have a consistent locale. | false | false | |
| Priority | Gets role configurations with the specified priority. | false | false | |
| Version | Gets role configurations with the matching version number. | false | false | |
| Property | Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server. | 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_Admin_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_Admin_Filtering for details. | 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
None
You cannot pipe input into this cmdlet.
Return Values
Citrix.DelegatedAdmin.Sdk.RoleConfiguration
Get-AdminRoleConfiguration returns an object for each matching role configuration.## Notes This command is supplied for infrastructure purposes only and is not intended for public use.
Examples
EXAMPLE 1
C:\PS> Get-AdminRoleConfiguration -Name Director
Description
-----------
Retrieve the role configuration for the Citrix Director component.