Devolutions.Server

2022.3.13.0

Public/Authentication/Close-DSSession.ps1

function Close-DSSession {
    <#
        .SYNOPSIS
        Terminate the connection with your Devolutions Server instance.
        .DESCRIPTION
        Terminate the connection with your Devolutions Server by clearing global variables required to keep it up and running.
    #>
    [CmdletBinding()]
    param (
        
    )
    
    begin {
        Write-Verbose '[Close-DSSession] Beginning...'
        $VarsToClear = @('DSInstanceName', 'DSInstanceVersion', 'DSSafeSessionKey', 'DSSessionKey', 'WebSession', 'DSBaseURI')
    }
    
    process {
        $RequestParams = @{
            URI    = "$Script:DSBaseURI/api/logout"
            Method = 'GET'
        }

        try {
            Invoke-WebRequest @RequestParams -WebSession $Global:WebSession
        }
        catch {
            Write-Warning '[Close-DSSession] No session was previously established.'
        }

        $VarsToClear.GetEnumerator() | ForEach-Object {
            try {
                if ($_ -eq 'DSBaseURI') { Remove-Variable $_ -Scope Script -ErrorAction SilentlyContinue -Force } else { Remove-Variable $_ -Scope Global -ErrorAction SilentlyContinue -Force }
            }
            catch {
                Write-Warning "[Close-DSSession] Error while clearing $_..."
            }
        }

    }
    
    end {
        Write-Verbose '[Close-DSSession] Done.'
    }
}