Start-CsClsLogging
Starts the specified scenario centralized logging service scenario. Centralized logging provides a way for administrators to simultaneously enable or disable Skype for Business Server tracing on multiple computers. This cmdlet was introduced in Lync Server 2013.
Syntax
Start-CsClsLogging
-Scenario <String>
[-AsXml]
[-Computers <String[]>]
[-Duration <String>]
[-Pools <String[]>]
[<CommonParameters>] 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 Skype for Business Server.
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 Skype for Business 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.
The Start-CsClsLogging cmdlet provides a way for administrators to begin logging a specified scenario on a computer or set of computers.
By default, that logging operation will continue to run until the Duration time limit has expired.
However, administrators can manually stop a logging operation at any time by using the Stop-CsClsLogging cmdlet.
Examples
-------------------------- Example 1 --------------------------
Start-CsClsLogging -Scenario "AlwaysOn"Example 1 starts logging the AlwaysOn scenario on all the computers in the current topology.
-------------------------- Example 2 --------------------------
Start-CsClsLogging -Scenario "cps" -Pools "atl-cs-001.litwareinc.com" -Duration 12:00The command shown in Example 2 starts CPS logging on all the computers in the pool atl-cs-001.litwareinc.com with duration of 12 hours.
Parameters
-AsXml
When specified, information is returned using XML.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Computers
Enables administrators to start logging on a specified server or set of servers. To start logging on a single server, specify the fully qualified domain name of that server. For example:
-Computers "atl-server-001.litwareinc.com"
Multiple servers can be specified by separating the computer FQDNs using commas:
-Computers "atl-server-001.litwareinc.com","red-server-002.litwareinc.com"
If you do not include the Computers parameter or the Pools parameter, the Start-CsClsLogging cmdlet will automatically run against the server you are connected to.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Duration
Amount of time that the logging operation should run. For example, this syntax causes the logging operation to run for 2 hours (0 days.02 hours:00 minutes) and then stop:
-Duration 0.02:00
This following syntax would specify a duration of 3 hours and 15 minutes:
-Duration 0.03:15
The following syntax would specify a duration of 6 days, 5 hours and 12 minutes:
-Duration 6.05:12
The default value is 4 hours (04:00).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Pools
Enables administrators to start logging a scenario on each server in a pool. To start logging in a pool, specify the fully qualified domain name of that pool. For example:
-Pools "atl-cs-001.litwareinc.com"
Multiple pools can be specified by separating the pool FQDNs using commas:
-Pools "atl-cs-001.litwareinc.com","red-cs-002.litwareinc.com"
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Scenario
Name of the centralized logging scenario to be started. Available scenarios (and their names) names can be returned by using this command:
Get-CsClsScenario | Select-Object Name
Note that you can only specify one scenario per call to the Start-CsClsLogging cmdlet.
Also only one scenario other than the "AlwaysOn" scenario can be started on a computer at any one time.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
None.
The Start-CsClsLogging cmdlet does not accept pipelined input.
Outputs
String value or XML output.
The Start-CsClsLogging cmdlet does not return objects.