Get-DSGatewayLogs

    2025-01-30

    Get-DSGatewayLogs

    SYNOPSIS

    Get a gateway's logs

    SYNTAX

    __AllParameterSets

    Get-DSGatewayLogs -GatewayID <guid> -OutputPath <string> [-AsLegacyResponse] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Get a gateway's logs. The logs will be stored in the specified path. The Devolutions Gateway module is required.

    EXAMPLES

    EXAMPLE

    PS C:> $response = Get-DSGateway -All -AsLegacyResponse; $gateways = $response.Data; $gateways | ForEach-Object {Get-DSGatewayLogs -GatewayID $.Id -OutputPath "C:\my\path\filename$_.Name.txt"}

    Get logs for all gateways and create a file for each of them.

    PARAMETERS

    -AsLegacyResponse

    In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

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

    -GatewayID

    Gateway's ID

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

    -OutputPath

    Path, including the file name and extension, where the file will be the saved.

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  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.

    INPUTS

    OUTPUTS

    NOTES

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