Topic Last Modified: 2014-02-19

Creates a new collection of centralized logging configuration settings. Centralized logging provides a way for administrators to simultaneously enable or disable Lync Server 2013 tracing on multiple computers. This cmdlet was introduced in Lync Server 2013.

Syntax


New-CsClsConfiguration -Identity <XdsIdentity> [-CacheFileLocalFolders <String>] [-CacheFileLocalMaxDiskUsage <UInt32>] [-CacheFileLocalRetentionPeriod <UInt32>] [-CacheFileNetworkFolder <String>] [-ComponentThrottleLimit <UInt32>] [-ComponentThrottleSample <UInt32>] [-Confirm [<SwitchParameter>]] [-EtlFileFolder <String>] [-EtlFileRolloverMinutes <UInt32>] [-EtlFileRolloverSizeMB <UInt32>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-MinimumClsAgentServiceVersion <UInt32>] [-NetworkUsagePacketSize <UInt32>] [-NetworkUsageThreshold <UInt32>] [-Regions <PSListModifier>] [-Scenarios <PSListModifier>] [-SearchTerms <PSListModifier>] [-SecurityGroups <PSListModifier>] [-TmfFileSearchPath <String>] [-WhatIf [<SwitchParameter>]]

New-CsClsConfiguration -Identity <XdsIdentity>
[-CacheFileLocalFolders <String>]
[-CacheFileLocalMaxDiskUsage <UInt32>]
[-CacheFileLocalRetentionPeriod <UInt32>]
[-CacheFileNetworkFolder <String>] [-ComponentThrottleLimit
<UInt32>] [-ComponentThrottleSample <UInt32>] [-Confirm
[<SwitchParameter>]] [-EtlFileFolder <String>]
[-EtlFileRolloverMinutes <UInt32>] [-EtlFileRolloverSizeMB
<UInt32>] [-Force <SwitchParameter>] [-InMemory
<SwitchParameter>] [-MinimumClsAgentServiceVersion
<UInt32>] [-NetworkUsagePacketSize <UInt32>]
[-NetworkUsageThreshold <UInt32>] [-Regions
<PSListModifier>] [-Scenarios <PSListModifier>]
[-SearchTerms <PSListModifier>] [-SecurityGroups
<PSListModifier>] [-TmfFileSearchPath <String>]
[-WhatIf [<SwitchParameter>]]

Examples

Example 1

The command shown in Example 1 creates a new collection of centralized logging configuration settings for the Redmond site. In this new collection, the ETL file rollover size is set to 40 megabytes, and the ETL file rollover time is set to 2 hours (120 minutes).

	Copy Code
New-CsClsConfiguration -Identity "site:Redmond" -EtlFileRolloverSizeMB 40 -EtlFileRolloverMinutes 120

Detailed Description

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.

Centralized logging is built around a series of predefined scenarios that offer a more finely-targeted approach to logging than offered in previous versions of Lync Server. These scenarios predetermine the server components and logging for you; as a result, an administrator enabling the RGS scenario can be confident that he or she will only log information relevant to the Response Group service and not to, say, the audio conferencing provider service.

It is also possible to define custom scenarios by using the New-CsClsScenario cmdlet.

Centralized logging is managed by using collections of centralized logging service configuration settings. When you install Lync Server 2013, you install a global set of these configuration settings; in addition, administrators can add custom settings collections at the site scope. This is done by using the New-CsClsConfiguration 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 "New-CsClsConfiguration"}

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

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Rtc.Management.Xds.XdsIdentity	Unique identifier for the centralized logging configuration settings to be created. Because these settings can only be created at the site scope, use syntax similar to this, with the prefix "site:" followed by the name of the site: -Identity "site:Redmond"
CacheFileLocalFolders	Optional	System.String	One or more full paths to the local folders where the cache files will be stored. The default value is %TEMP%\Tracing. If more than one path is specified, then separate them with semi-colons.
CacheFileLocalMaxDiskUsage	Optional	System.UInt32	Maximum amount of disk space (percentage) that can be used for the cache files. The default value is 80.
CacheFileLocalRetentionPeriod	Optional	System.UInt32	Maximum number of days that cache files are retained locally. The default value is 14.
CacheFileNetworkFolder	Optional	System.String	Full UNC path to the network cache folder. There is no default value.
ComponentThrottleLimit	Optional	System.UInt32	Maximum rate at which a component is allowed to generate trace records before its tracing is throttled. The default value is 5000 trace calls per second.
ComponentThrottleSample	Optional	System.UInt32	Maximum number of times the ComponentThrottleLimit can be exceeded within a one minute interval. The default value is 3.
Confirm	Optional	System.Management.Automation.SwitchParameter	Prompts you for confirmation before executing the command.
EtlFileFolder	Optional	System.String	Full path to the folder where the event log trace files will be stored. The default value is %TEMP%\Tracing. Note that %TEMP% is evaluated in the contents of the CLS Service so it actual expands to %WINDIR%\ServiceProfiles\NetworkService\AppData\Local
EtlFileRolloverMinutes	Optional	System.UInt32	Maximum amount of time (in minutes) that can elapse before a new event log trace file is created. (This new file will be created even if the existing trace file has not reached the specified rollover size.) The default value is 60.
EtlFileRolloverSizeMB	Optional	System.UInt32	Maximum size (in megabytes) that at event trace log file can reach before a new file is created. The default value is 20.
Force	Optional	System.Management.Automation.SwitchParameter	Suppresses the display of any non-fatal error message that might occur when running the command.
InMemory	Optional	System.Management.Automation.SwitchParameter	Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet.
MinimumClsAgentServiceVersion	Optional	System.UInt32	Specifies the minimum version of the centralized logging service agent to be used when logging data; any computers with an agent version lower than the minimum value will be excluded from the logging operations. The default value is 6, representing Lync Server 2013. This parameter is intended for use with Lync Online.
NetworkUsagePacketSize	Optional	System.UInt32	PARAMVALUE: UInt32
NetworkUsageThreshold	Optional	System.UInt32	PARAMVALUE: UInt32
Regions	Optional	System.Management.Automation.PSListModifier	Collection of regions defined for the centralized logging configuration settings. Regions are defined using the New-CsClsRegion cmdlet. This parameter is intended for use with Lync Server 2013.
Scenarios	Optional	System.Management.Automation.PSListModifier	Collection of components/situations that can be traced using centralized logging. Scenarios are managed using the CsClsScenario cmdlets.
SearchTerms	Optional	System.Management.Automation.PSListModifier	Collection of terms that help determine the personally identifiable information available to technical support personnel who search the centralized logging files. Search terms are managed using the CsClsSearchTerm cmdlets.
SecurityGroups	Optional	System.Management.Automation.PSListModifier	Security groups who are allowed to access the log files. This parameter is intended for use with Lync Online.
TmfFileSearchPath	Optional	System.String	Search path for TMF (trace message format) files. TMF files convert binary trace messages to a human-readable format.
WhatIf	Optional	System.Management.Automation.SwitchParameter	Describes what would happen if you executed the command without actually executing the command.

Input Types

None. The New-CsClsConfiguration cmdlet does not accept pipelined input.

Return Types

The New-CsClsConfiguration cmdlet creates new instances of the icrosoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object.