Test-CsSetupPermission
Topic Last Modified: 2012-03-26
Verifies that the required permissions needed to install Microsoft Lync Server 2010 or one of its components have been configured on the specified Active Directory container.
Syntax
Test-CsSetupPermission -ComputerOU <String> [-Domain <Fqdn>] [-DomainController <Fqdn>] [-GlobalCatalog <Fqdn>] [-Report <String>]
Detailed Description
The domain preparation that takes place when you install Lync Server 2010 does not automatically add the permissions that enable members of the RTCUniversalServerAdmins group to run the Enable-CsTopology cmdlet. That means that, by default, you must be a domain administrator in order to enable a topology. To give members of the RTCUniversalServerAdmins group the right to enable a topology, you must run the Grant-CsSetupPermissions cmdlet. In addition, you will need to run this cmdlet against each Active Directory container that houses computers running Lync Server.
The Test-CsSetupPermission cmdlet enables you to determine whether or not the requisite permissions have been added to a given Active Directory container (that is, a container hosting computers running Lync Server). Test-CsSetupPermission returns True if the correct permissions have been applied, and returns False if the correct permissions have not been applied. If the cmdlet returns False, you will need to run Grant-CsSetupPermission in order to make the necessary changes to the Active Directory container.
Who can run this cmdlet: To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Test-CsSetupPermission"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
ComputerOU |
Required |
Active Directory distinguished name |
Distinguished name of the organizational unit (OU) that contains the accounts for the computers running Lync Server. For example: "ou=CsServers,dc=litwareinc,dc=com". |
Domain |
Optional |
String |
Name of the domain where the OU to be checked is located. If this parameter is not included, then Test-CsSetupPermission will look for the OU in the current domain. |
DomainController |
Optional |
String |
Fully qualified domain name (FQDN) of a domain controller in your domain. This parameter is not required if you are running Test-CsSetupPermission on a computer with an account in your domain. |
GlobalCatalog |
Optional |
String |
FQDN of a global catalog server in your domain. This parameter is not required if you are running Test-CsSetupPermission on a computer with an account in your domain. |
Report |
Optional |
String |
Reports detailed activity to the screen as the cmdlet runs. |
Verbose |
Optional |
Switch Parameter |
Reports detailed activity to the screen as the cmdlet runs. |
Input Types
None. Test-CsSetupPermission does not accept pipelined input.
Return Types
Test-CsSetupPermission returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.
Example
-------------------------- Example 1 ------------------------
Test-CsSetupPermission -ComputerOU "ou=CsServers,dc=litwareinc,dc=com"
The command shown in Example 1 checks to see if the required setup permissions have been applied to the CsServers OU in the litwareinc.com domain.