Get-DSAdministrationLog

Synopsis

Get administration logs.

Syntax

__AllParameterSets

Get-DSAdministrationLog [-DateFilter <DateFilter>] [-After <datetime>] [-Before <datetime>]
 [-Filter <string>] [-PageSize <int>] [<CommonParameters>]

Description

Get administration logs from the server. Optionally filter by date range or keyword. If no date filter is applied, log entries from the last 7 days are fetched. Returns all matching log entries.

Examples

Example 1

PS C:\> Get-DSAdministrationLog -Filter 'John'

Gets all administration log entries mentioning 'John' from the last 7 days (default).

Example 2

PS C:\> $before = (Get-Date '2025-03-31').AddDays(1).AddMilliseconds(-1)
PS C:\> Get-DSAdministrationLog -DateFilter Custom -After '2025-01-01' -Before $before

Gets all administration log entries for Q1 2025. Since -Before defaults to midnight, $before is set to 23:59:59.999 to include the full last day.

Parameters

-After

Start of the date range. Required when using -DateFilter Custom. Also implicitly activates a custom date range when provided without -DateFilter.

Type: System.Nullable`1[System.DateTime]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Before

End of the date range. Defaults to the current date and time when not specified.

Type: System.Nullable`1[System.DateTime]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-DateFilter

Preset date range for the logs. Defaults to Last7Days. Use Custom with -After to specify an exact range.

Type: Devolutions.RemoteDesktopManager.DateFilter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Filter

Filter results by user name, machine name, or message (partial match).

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PageSize

Number of log entries fetched per request. Default is 10000. Increase this value to reduce the number of requests for large datasets (fewer round trips), or decrease it if you encounter timeout issues due to heavy payloads.

Type: System.Int32
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSAdministrationLogItem

Notes

For more information, type "Get-Help Get-DSAdministrationLog -detailed". For technical information, type "Get-Help Get-DSAdministrationLog -full".