Invoke-RASClearAgentLogs

NAME

Invoke-RASClearAgentLogs

SYNOPSIS

Removes the Log file of one or more RAS Agents.

SYNTAX

Invoke-RASClearAgentLogs [[-Server] <string>] [[-SiteId] <uint>] [-ServerType <RASLogSrvType> {RDS | Provider | VDIHost | Gateway | PA | HALBDevice | All}] [<CommonParameters>]

Invoke-RASClearAgentLogs [-InputObject] <RASAgentInfo[]> [<CommonParameters>]

DESCRIPTION

Removes the Log file of one or more RAS Agents.

PARAMETERS


-ServerType <RASLogSrvType>
Specifies the server type for which to retrieve the information.

Acceptable values: ALL (Default), RDS, Provider, Gateway, PA, HALB Device.

Possible values: RDS, Provider, VDIHost, Gateway, PA, HALBDevice, All

        Required?                    false
        Position?                    named
        Default value                All
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Server <string>
The name of the RAS agent server.

The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

        Required?                    false
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID in which to modify the specified server.

If the parameter is omitted, the site ID of the Licensing Server will be used.

        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InputObject <RASAgentInfo[]>
The RAS agent info.

To obtain an RASAgentInfo object representing an RAS agent info list, use the Get-RASAgent command."

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

<CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters documentation. 

INPUTS

RASAgentInfo[]

OUTPUTS

-none-

EXAMPLES


---------- EXAMPLE 1 ----------

Invoke-RASClearAgentLogs -ServerType RDS

Clears the log files for every RAS RDS Agent.

---------- EXAMPLE 2 ----------

Invoke-RASClearAgentLogs -Server MyRASserver

Clears the log files for the specified RAS server.

---------- EXAMPLE 3 ----------

Invoke-RASClearAgentLogs -InputObject $RDSStatus

Clears the log files for the specified RAS server.

RELATED LINKS