Remove-RASCustomRoute

NAME

Remove-RASCustomRoute

SYNOPSIS

Removes a Custom Route from a site.

SYNTAX

Remove-RASCustomRoute [- Id ] <uint> [ < CommonParameters > ]

Remove-RASCustomRoute [- InputObject ] < CustomRoute > [ < CommonParameters > ]

Remove-RASCustomRoute [- Name ] <string> [[- SiteId ] <uint> ] [ < CommonParameters > ]

DESCRIPTION

Removes a Custom Route from a site.

PARAMETERS


- Name <string>
The name of a Custom Route to remove from a site.

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

- SiteId <uint>
Site ID from which to remove the Custom Route.

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 to remove from the site.

To obtain the ID, use the Get-RASCustomRoute cmdlet.

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

- InputObject < CustomRoute >
The Custom Route to remove from a site.

To obtain a VDIHostPool object representing a Custom Route, use the Get-RASCustomRoute command.

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        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

CustomRoute

OUTPUTS

-none-

EXAMPLES


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

Remove-RASCustomRoute -Name "My Custom Route"

Removes the Custom Route specified by name from the Licensing Server site (default).

To remove a Custom Route from a specific site, specify the -SiteId parameter.
---------- EXAMPLE 2 ----------

Remove-RASCustomRoute -Id 10

Removes the Custom Route specified by ID. To obtain the group ID, use the Get-RASCustomRoute cmdlet.
---------- EXAMPLE 3 ----------

Get-RASCustomRoute -Id 10 | Remove-RASCustomRoute

Removes a Custom Route, which is identified by an object obtained from the pipeline output.

RELATED LINKS