Invoke-RASRetrieveAgentLogs

Invoke-RASRetrieveAgentLogs

Retrieves the Log files for one or more RAS Agents.

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

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

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.

- FilePath <string>
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.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

Possible values: RDS, Provider, VDIHost, Gateway, Broker, PA, HALBDevice, All

        Required?                    false

        Position?                    named

        Default value                All

        Accept pipeline input?       false

        Accept wildcard characters?  false

- Server <string>
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.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

- SiteId <uint>
Site ID in which to modify the specified server.

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

- InputObject < RASAgentInfo[] >
The RAS agent info.

To obtain an RASAgentInfo object representing an RAS agent info list, use the Get-RASAgent 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. 

RASAgentInfo[]

RASFiles

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

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 ----------

Invoke-RASRetrieveAgentLogs -ServerType RDS -FilePath "C:/temp/logs.zip"

Retrieves log files for every RAS RDS Agent.
---------- EXAMPLE 3 ----------

Invoke-RASRetrieveAgentLogs -InputObject $RDSStatus -FilePath "C:/temp/"

Retrieves log files for the specified RAS server.

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