Edit

Share via

Get-CsClsAgentStatus

Module:
Skype for Business Server PowerShell

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

Syntax

Default (Default) 

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

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultXml

Applicable: Skype for Business Server 2015, Skype for Business Server 2019

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Microsoft.Rtc.Management.Cls.AgentInfo

Or an XmlDocument object if the DefaultXml parameter is used.