Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Remove-CsClsSecurityGroup

Lync Server 2013
 

Topic Last Modified: 2013-03-06

Removes a centralized logging configuration security group. Centralized logging provides a way for administrators to simultaneously enable or disable event tracing on multiple computers. This cmdlet was introduced in Lync Server 2013.

Remove-CsClsSecurityGroup -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

The command shown in Example 1 deletes the centralized logging security group with the Identity Global/HelpDesk.

Remove-CsClsSecurityGroup -Identity "global/HelpDesk"

In Example 2, all the centralized logging security groups currently in use in the organization are deleted. To do this, the command first calls the Get-CsClsSecurityGroup cmdlet without any parameters; this returns a collection of all the centralized logging security groups. That collection is then piped to the Remove-CsClsSecurityGroup cmdlet, which deletes each group in the collection.

Get-CsClsSecurityGroup | Remove-CsClsSecurityGroup

Example 3 shows how you can delete all the centralized logging security groups that have the access level RedmondSupport. To carry out this task, the command first uses the Get-CsClsSecurityGroup cmdlet to return a collection of all the available centralized logging security groups. That collection is then piped to the Where-Object cmdlet, which selects only those groups where the AccessLevel property is set to Tier3. In turn, those groups are piped to, and removed by, the Remove-CsClsSecurityGroup cmdlet.

Get-CsClsSecurityGroup | Where-Object {$_.AccessLevel -eq "Tier3"} | Remove-CsClsSecurityGroup

The centralized logging service (which replaces the OCSLogger and OCSTracer tools used in Microsoft Lync Server 2010) provides a way for administrators to manage logging and tracing for all computers and pools running Microsoft Lync Server 2013. Centralized logging enables administrators to stop, start, and configure logging for one or more pools and computers by using a single command; for example, you can use one command to enable Address Book service logging on all your Address Book servers. This differs from the OCSLogger and OCSTracer tools, which had to be individually managed (including individually stopped and started) on each server. In addition, the centralized logging service also provides a way for administrators to search trace logs from the command, using the Windows PowerShell command-line interface and the Search-CsClsLogging cmdlet.

With Lync Online, security groups are used to determine which users have access to the personally-identifiable information that is written to the log files. Security groups are created by using the New-CsClsSecurityGroup cmdlet and then are added to a collection of centralized logging configuration settings. These groups can later be removed by using the Remove-CsClsSecurityGroup 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 "Remove-CsClsSecurityGroup"}

Lync Server Control Panel: The functions carried out by the Remove-CsClsSecurityGroup cmdlet are not available in the Lync Server Control Panel.

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.Xds.XdsIdentity

Unique identifier for the centralized logging security group to be removed. A security group identity consists of the scope where the group was created followed by the group name. For example, to remove a group named HelpDesk created at the global scope, use the following syntax:

-Identity "global/HelpDesk"

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses the display of any non-fatal error message that might occur when running the command.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Describes what would happen if you executed the command without actually executing the command.

The Remove-CsClsSecurityGroup cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object.

None. Instead, the Remove-CsClsSecurityGroup cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.