Export (0) Print
Expand All
Expand Minimize

Set-CsClsRegion

Lync Server 2013
 

Topic Last Modified: 2013-03-07

Modifies an existing centralized logging configuration region. 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.

Set-CsClsRegion [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Set-CsClsRegion [-Instance <PSObject>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-OtherRegionAccess <String>] [-SecurityGroupSuffix <String>] [-Sites <String>] [-WhatIf [<SwitchParameter>]]

The command shown in Example 1 changes the security group suffix for the region global/US to USSupport.

Set-CsClsRegion -Identity "global/US" -SecurityGroupSuffix "USSupport"

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 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, regions are used to determine which users have access to the personally-identifiable information that is written to the log files. Regions are created by using the New-CsClsRegion cmdlet and then are added to a collection of centralized logging configuration settings. After they have been created, you can modify the properties of these regions by using the Set-CsClsRegion 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 "Set-CsClsRegion"}

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

 

Parameter Required Type Description

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.

Identity

Optional

Microsoft.Rtc.Management.Xds.XdsIdentity

Unique identifier for the region. Region Identities consist of the centralized logging configuration scope where the region was created plus a unique region name. For example, to refer to a global region named Redmond use this syntax:

-Identity "global/Redmond"

Instance

Optional

System.Management.Automation.PSObject

Allows you to pass a reference to an object rather than set individual parameter values.

OtherRegionAccess

Optional

System.String

Name of an additional region that can be accessed by authorized users for this region.

SecurityGroupSuffix

Optional

System.String

Suffix to be added to the end of the name of any security group that will be authorized for this region.

Sites

Optional

System.String

Sites contained within this region. These correspond to the SideId attribute values in the topology document.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

The Set-CsClsRegion cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object.

None. Instead, the Set-CsClsRegion cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft