Get-CsClsAgentStatus

  • Reference
Module:
SkypeForBusiness
Applies to:
Skype for Business Server 2015, Skype for Business Server 2019

Use the Get-CsClsAgentStatus to return information about the ClsAgent service on the local machine.

Syntax

Get-CsClsAgentStatus
   [-CacheFileLocalFolders <String>]
   [-DefaultXml]
   [<CommonParameters>]

Description

The Get-CsClsAgentStatus cmdlet returns information about the ClsAgent, including version, service status, log storage details, and disk free space.

Examples

-------------------------- Example 1 --------------------------

Get-CsClsAgentStatus

Returns information about the ClsAgent service on the local machine.

-------------------------- Example 2 --------------------------

Get-CsClsAgentStatus -DefaultXml

Returns the default.xml file as an XmlDocument object.

Parameters

-CacheFileLocalFolders

Specifies the path to search for log files stored on disk. By default the CacheFileLocalFolders path from the Get-CsClsConfiguration cmdlet is used.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

-DefaultXml

If specified, the cmdlet will return the default.xml file as an XmlDocument object for debugging purposes.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Skype for Business Server 2015, Skype for Business Server 2019

Inputs

None

Outputs

Microsoft.Rtc.Management.Cls.AgentInfo

Or an XmlDocument object if the DefaultXml parameter is used.