> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasagentdiagnostic.md).

# Get-RASAgentDiagnostic

## SYNOPSIS

Retrieves RAS Agent Diagnostic information.

## SYNTAX

```powershell
Get-RASAgentDiagnostic
 -AgentDiagnosticType {RDS | Provider | Gateway | Guest | Broker | HALBDevice | EnrollmentServer | AVDTemplate | AVDTemplateVersion | AVDHost | AVDHostPool | AVDWorkspace}
 -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.

## EXAMPLES

### Example 1

```powershell
Get-RASAgentDiagnostic -Server test.domain -ServerType RDS
```

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

### Example 2

```powershell
Get-RASAgentDiagnostic -Server test.domain -ServerType Provider
```

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

## PARAMETERS

### -Server

The name of server from which to retrieve Agent information.

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

```yaml
Type: string
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SiteId

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.

```yaml
Type: uint
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -AgentDiagnosticType

Specifies the server type for which to retrieve the information.

Possible values: RDS, Provider, Gateway, Guest, Broker, HALBDevice, EnrollmentServer, AVDTemplate, AVDTemplateVersion, AVDHost, AVDHostPool, AVDWorkspace

Type reference: [RASAgentDiagnosticType](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/rasagentdiagnostictype.md)

```yaml
Type: RASAgentDiagnosticType
Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### [BrokerAgentDiagnostic](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/brokeragentdiagnostic.md) [EnrollmentServerAgentDiagnostic](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/enrollmentserveragentdiagnostic.md) [GatewayAgentDiagnostic](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/gatewayagentdiagnostic.md) [GuestAgentDiagnostic](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/guestagentdiagnostic.md) [HALBDeviceAgentDiagnostic](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/halbdeviceagentdiagnostic.md) [ProviderAgentDiagnostic](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/provideragentdiagnostic.md) [RDSAgentDiagnostic](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/rdsagentdiagnostic.md)

## RELATED LINKS

* [Get-RASAgent](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasagent.md)
* [Update-RASAgent](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/update-rasagent.md)
* [Remove-RASAgent](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-rasagent.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasagentdiagnostic.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
