Get-RASAgentDiagnostic

NAME

Get-RASAgentDiagnostic

SYNOPSIS

Retrieves RAS Agent Diagnostic information.

SYNTAX

Get-RASAgentDiagnostic - AgentDiagnosticType {RDS | Provider | Gateway | Guest | Broker | PA | HALBDevice | EnrollmentServer} - Server <string> [- SiteId <uint> ] [ < CommonParameters > ]

DESCRIPTION

Retrieves the diagnostic information about the RAS Agent installed on a specific server, for diagnostic purposes, with a specific type, such as

RD Session Host, Provider, Gateway, Guest, Broker, HALB Device.

PARAMETERS


- Server <string>
The name of server from which to retrieve Agent information.

This must be the actual server name used in the RAS farm.

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

- SiteId <uint>
Site ID from which to retrieve the specified Agent information.

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

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

- AgentDiagnosticType < RASAgentDiagnosticType >
Specifies the server type for which to retrieve the information.

Possible values: RDS, Provider, Gateway, Guest, Broker, PA, HALBDevice, EnrollmentServer

        Required?                    true
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        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

-none-

OUTPUTS

BrokerAgentDiagnostic
EnrollmentServerAgentDiagnostic
GatewayAgentDiagnostic
GuestAgentDiagnostic
HALBDeviceAgentDiagnostic
ProviderAgentDiagnostic
RDSAgentDiagnostic

EXAMPLES


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

Get-RASAgentDiagnostic -Server test.domain -ServerType RDS

Retrieves the information about the RDS Agent installed on the server 'test.domain'.
---------- EXAMPLE 2 ----------

Get-RASAgentDiagnostic -Server test.domain -ServerType Provider

Retrieves the information about the Provider Agent installed on the server 'test.domain'.

RELATED LINKS