Get-RASAgent

NAME

Get-RASAgent

SYNOPSIS

Retrieves RAS Agent information by server type or server name.

SYNTAX

Get-RASAgent [-Server] <string> [[-SiteId] <uint>] [<CommonParameters>]

Get-RASAgent [[-ServerType] <RASServerType> {RDS | VDIHost | Gateway | Guest | PC | VDITemplate | PA | Site | All}] [<CommonParameters>]

DESCRIPTION

Retrieves the information about RAS Agent(s) installed on a specific server or on servers of a specific type, such as.

Publishing Agent, RD Session Host, RAS Secure Client Gateway, VDI Host, VDI Guest, VDI Template.

PARAMETERS


-Server <string>
The name of server from which to retrieve Agent information.

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

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

-SiteId <uint>
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.

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

-ServerType <RASServerType>
Specifies the server type for which to retrieve the information.

Acceptable values: ALL (Default), RDS, VDIHost, Gateway, Guest, VDITemplate, PA, Site.

Possible values: RDS, VDIHost, Gateway, Guest, PC, VDITemplate, PA, Site, All

        Required?                    false
        Position?                    0
        Default value                All
        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

PSAdmin.RASAgentInfo

EXAMPLES


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

Get-RASAgent -Server MyRASserver

Retrieves the information about Agent(s) installed on the server named 'MyRASserver'.

---------- EXAMPLE 2 ----------

Get-RASAgent

Retrieves the information about all Agents from all servers in the farm.

---------- EXAMPLE 3 ----------

Get-RASAgent -ServerType RDS

Retrieves the information about the Agents installed on all RD Sessions Host servers in the farm.

RELATED LINKS