> 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/invoke-rasretrieveagentlogs.md).

# Invoke-RASRetrieveAgentLogs

## SYNOPSIS

Retrieves the Log files for one or more RAS Agents.

## SYNTAX

```powershell
Invoke-RASRetrieveAgentLogs [-InputObject] <RASAgentInfo[]> [-FilePath <string>]
 [<CommonParameters>]
```

```powershell
Invoke-RASRetrieveAgentLogs [[-Server] <string>] [[-SiteId] <uint>] [-FilePath <string>]
 [-ServerType {RDS | Provider | Gateway | Broker | HALBDevice | EnrollmentServer | All}]
 [<CommonParameters>]
```

## DESCRIPTION

Retrieves the Log files for one or more RAS Agents.

For every RAS Agent log retrieved, a '.zip' file is generated. The output file path for every RAS Agent is returned.

## EXAMPLES

### Example 1

```powershell
Invoke-RASRetrieveAgentLogs -Server MyRASserver
```

Retrieves log files for the specified RAS server.

The log files will be save in the default Parallels RAS log path.

### Example 2

```powershell
Invoke-RASRetrieveAgentLogs -ServerType RDS -FilePath "C:\Path\To\File"
```

Retrieves log files for every RAS RDS Agent.

### Example 3

```powershell
Invoke-RASRetrieveAgentLogs -InputObject $RDSStatus -FilePath "C:\Path\To\File"
```

Retrieves log files for the specified RAS server.

Log file names will be auto generated with this format: \<ServerName>\_\<ServerType>\_Logs\_\<Timestamp>.zip.

## PARAMETERS

### -FilePath

The path where the logs will be saved.

FilePath is optional. If not supplied, the logs are saved in default Parallels RAS log folder.

If any of these tags \[\<ServerName> | \<ServerType> | \<Timestamp>] are used in the filename, they will be replaced with a proper value.

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

### -ServerType

Specifies the server type for which to retrieve the information.

Possible values: RDS, Provider, Gateway, Broker, HALBDevice, EnrollmentServer, All

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

```yaml
Type: RASLogSrvType
Required: False
Position: Named
Default value: All
Accept pipeline input: False
Accept wildcard characters: False
```

### -Server

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.

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

### -SiteId

Site ID in which to modify the specified server.

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

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

### -InputObject

The RAS agent info.

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

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

```yaml
Type: RASAgentInfo[]
Required: True
Position: 0
Default value: None
Accept pipeline input: true (ByValue)
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

### [RASAgentInfo\[\]](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/rasagentinfo.md)

## OUTPUTS

### [RASFiles](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/rasfiles.md)

## RELATED LINKS

* [Set-RASAgentLogLevel](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-rasagentloglevel.md)
* [Invoke-RASClearAgentLogs](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/invoke-rasclearagentlogs.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/invoke-rasretrieveagentlogs.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.
