Get-DSGatewaySession

    2024-11-18

    Get-DSGatewaySession

    SYNOPSIS

    Get a gateway's sessions

    SYNTAX

    __AllParameterSets

    Get-DSGatewaySession -GatewayID <guid> [-AsLegacyResponse] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Get a gateway's sessions. The Devolutions Gateway module is required.

    EXAMPLES

    EXAMPLE

    PS C:> $response = Get-DSGatewaySession -GatewayID "08a521fe-14f7-4ae5-b2b9-d9f6164c15e8" -AsLegacyResponse; $gateway = $response.Data; $gwSessions -GatewayID $gateway.Id

    Get all sessions of the specified gateway.

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

    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-DSGatewaySession -detailed". For technical information, type "Get-Help Get-DSGatewaySession -full".