Topic Last Modified: 2010-10-01
Deletes all the Device Update Web service log and audit files that are older than the specified number of days.
Syntax
Clear-CsDeviceUpdateLog -Identity <XdsIdentity>
-DaysBack <Int32> [-Confirm [<SwitchParameter>]]
[-Force <SwitchParameter>] [-WhatIf
[<SwitchParameter>]]
|
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Xds Identity |
Unique identifier of the service hosting the Device Update Web service log files. For example, this syntax clears Device Update Web service log files from the Web Services for the pool atl-cs-001.litwareinc.com: -Identity "service:WebServer:atl-cs-001.litwareinc.com". |
DaysBack |
Required |
Integer |
Maximum age (in days) of the log files to be maintained. All log files older than the value specified using the DaysBack parameter will be deleted. For example, if you set DaysBack to 7 then any log files more than seven days old will be removed. This parameter can be set to any integer value between 1 and 30, inclusive. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Detailed Description
The Device Update Web service keeps an extensive collection of log files; this collection includes both audit logs conducted by the service itself as well as log files uploaded from client devices such as cell phones. Depending on the amount of device update activity, and depending on the number of client devices used in your organization, your server could soon become “cluttered” with Device Update Web service logs. The Clear-CsDeviceUpdateLog cmdlet provides a way for you to reduce the number of log files stored on the server: all you have to do is run the cmdlet and specify the maximum age (in days) of the files that should not be deleted. Any log files older than that maximum age will be removed from the system.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Clear-CsDeviceUpdateLog cmdlet locally: RTCUniversalServerAdmins. 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 "Clear-CsDeviceUpdateLog"}
Input Types
None. Clear-CsDeviceUpdateLog does not accept pipelined input.
Return Types
None. Clear-CsDeviceUpdateLog does not return any values.
Example
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
Clear-CsDeviceUpdateLog -Identity "service:WebServer:atl-cs-001.litwareinc.com" -DaysBack 10 |
The command shown in Example 1 connects to the Device Update Web service with the Identity "service:WebServer:atl-cs-001.litwareinc.com" and deletes all the device and audit logs that are more than 10 days old.