Get-RASCustomRoute

NAME

Get-RASCustomRoute

SYNOPSIS

Retrieves information about one or multiple custom routes.

SYNTAX

Get-RASCustomRoute [[-Id] <uint>] [<CommonParameters>] Get-RASCustomRoute [[-Name] <string>] [[-SiteId] <uint>] [<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 . 

INPUTS

-none-

OUTPUTS

CustomRoute

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. ---------- EXAMPLE 2 ---------- Get-RASCustomRoute -Id 10 Retrieves information about the Custom Route specified by ID from the Licensing Server site.