Get-ADTSession

SYNOPSIS

Retrieves the most recent ADT session.

SYNTAX

Get-ADTSession [<CommonParameters>]

DESCRIPTION

The Get-ADTSession function returns the most recent session from the ADT module data. If no sessions are found, it throws an error indicating that an ADT session should be opened using Open-ADTSession before calling this function.

EXAMPLES

EXAMPLE 1

Get-ADTSession

This example retrieves the most recent ADT session.

EXAMPLE 2

$adtSession = Get-ADTSession
...
Close-ADTSession
$adtSession.GetExitCode()

This example retrieves the given deployment session's exit code after the session has closed.

PARAMETERS

CommonParameters

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

INPUTS

None

You cannot pipe objects to this function.

OUTPUTS

ADTSession

Returns the most recent session object from the ADT module data.

NOTES

An active ADT session is required to use this function.

Requires: PSADT session should be initialized using Open-ADTSession

Tags: psadt
Website: https://psappdeploytoolkit.com
Copyright: (C) 2025 PSAppDeployToolkit Team (Sean Lillis, Dan Cunningham, Muhammad Mashwani, Mitch Richters, Dan Gough).
License: https://opensource.org/license/lgpl-3-0

RELATED LINKS

https://psappdeploytoolkit.com/docs/reference/functions/Get-ADTSession