# Get-RASCustomRoute

## NAME

Get-RASCustomRoute

## SYNOPSIS

Retrieves information about one or multiple custom routes.

## SYNTAX

**Get-RASCustomRoute** \[\[-[Id](#id-string)]\*\* *(uint)*] \[*(*[*CommonParameters*](#CommonParameters)*)*]

**Get-RASCustomRoute** \[\[-[Name](#name-string)]\*\* *(string)*] \[\[-[SiteId](#siteid-string)] *(uint)*] \[*(*[*CommonParameters*](#CommonParameters)*)*]

## DESCRIPTION

Retrieves information about one or multiple custom routes.

The cmdlet returns an object of type CustomRoute.

Custom routes are used within published item preferred routing settings.

## PARAMETERS

## Name (string)

The name of the Custom Route for which to retrieve the information.

```
        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## SiteId (uint)

Site ID from which to retrieve the Custom Route information.

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

```
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## Id (uint)

The ID of a Custom Route for which to retrieve the information.

```
        Required?                    false

        Position?                    0

        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

[CustomRoute](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/customroute.md)

## EXAMPLES

**---------- EXAMPLE 1 ----------**

Get-RASCustomRoute -Name "My Custom Route"

Retrieves information about the Custom Route specified by name from the Licensing Server site.

To retrieve the info from a specific site, specify the -SiteId parameter.\
\&#xNAN;**---------- EXAMPLE 2 ----------**

Get-RASCustomRoute -Id 10

Retrieves information about the Custom Route specified by ID from the Licensing Server site.

## RELATED LINKS

* [New-RASCustomRoute](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/new-rascustomroute.md)
* [Set-RASCustomRoute](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/set-rascustomroute.md)
* [Remove-RASCustomRoute](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/remove-rascustomroute.md)
* [Add-RASPubItemPreferredRoute](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/add-raspubitempreferredroute.md)
* [Get-RASPubItemPreferredRoute](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/get-raspubitempreferredroute.md)
* [Set-RASPubItemPreferredRoute](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/set-raspubitempreferredroute.md)
* [Remove-RASPubItemPreferredRoute](/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/remove-raspubitempreferredroute.md)


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/get-rascustomroute.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.