Product Documentation

Test-AdminAccess

Oct 01, 2013

Retrieves the scopes where the specified operation is permitted.

Syntax

Test-AdminAccess [-Operation] <String> [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

This cmdlet evaluates what rights the current user has, and from these determines the scopes where the specified operation is permitted.

Operations are the indivisible unit of functionality that each XenDesktop service can perform, and usually correspond to individual cmdlets.

Related topics

Parameters

-Operation<String>

The operation to query.

Required? true
Default Value  
Accept Pipeline Input? true (ByValue)

-AdminAddress<String>

Specifies the address of a XenDesktop controller the PowerShell snap-in connects to. You can provide this as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

Return Values

Citrix.DelegatedAdmin.Sdk.ScopeReference

The list of permissible scopes for the specified operation.

Notes

If the specified operation has unrestricted access a single object is returned representing the 'All' scope with a ScopeId of Guid.Empty (00000000-0000-0000-0000-000000000000).

Examples

-------------------------- EXAMPLE 1 --------------------------

C:\PS> Test-AdminAccess -Operation 'Broker:GetCatalog'

Queries the scopes where 'Broker:GetCatalog' is permitted.