VictronEnergy

0.1.1.0

Remove-VESession.ps1

                                function Remove-VESession {

    <#

        .SYNOPSIS

            Remove a session connected to the Victron Energy API

        .DESCRIPTION

            Long description

        .INPUTS

            No object can be piped to the function

        .EXAMPLE

            Remove-VESession

            Example of how to remove a session using the Victron Energy API

        .NOTES

            Author:    Decembry Quentin

    #>

    [CmdletBinding()]

    [OutputType()]

    [Alias()]

    param(

        # The VE session

        # Default: the default VE session

        [Parameter(Mandatory=$false)] [PSTypeName('VictronEnergy.Session')] $Session = $Script:VE_Session

    )

    begin {

        if ($PSBoundParameters['Debug']) {

            $DebugPreference = 'Continue'

        }

        if ($MyInvocation.MyCommand.ModuleName) { 

            $Private:ThisFunction = '{0}::{1}' -f $MyInvocation.MyCommand.ModuleName, $MyInvocation.MyCommand.Name

        } else {

            $Private:ThisFunction = '{0}::{1}' -f (Get-PSCallStack)[0].ScriptName, $MyInvocation.MyCommand.Name

        }

        Write-Debug "[$Private:ThisFunction] Begin"

     }

    process {

        Write-Debug "[$Private:ThisFunction] Process"

        if ($Session.Token) {

            $Uri = $Script:VE_VrmApiBaseUri + 'auth/logout'

            $Headers = @{ 'X-Authorization' = 'Bearer {0}' -f $Session.Token }

            try {

                Write-Debug "[$Private:ThisFunction] Send request to '$Uri'"

                $WebRequest = Invoke-WebRequest -UseBasicParsing -Uri $Uri -Method POST -Headers $Headers -Body $Body -ErrorAction Stop

                Write-Debug "[$Private:ThisFunction] Clear local variable"

                $Session.Token = ''

                $Session.IdUser = 0

            } catch {

                $_ | ForEach-Object {

                    Write-Error $_

                }

            }

        } else {

            Write-Debug "[$Private:ThisFunction] Session without token"

        }

     }

    end {

        Write-Debug "[$Private:ThisFunction] End"

    }

}

# SIG # Begin signature block

# MIIIbQYJKoZIhvcNAQcCoIIIXjCCCFoCAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB

# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR

# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQU2zW0o4TlZWCj7mKd0j96xzPw

# d+CgggX4MIICYjCCAgigAwIBAgITXwAAAAITcsrrTJecaQAAAAAAAjAKBggqhkjO

# PQQDAjAkMQswCQYDVQQGEwJCRTEVMBMGA1UEAxMMSG9tZSBSb290IENBMB4XDTIy

# MDUwNTE0MDMxOFoXDTMyMDUwNTE0MTMxOFowJzELMAkGA1UEBhMCQkUxGDAWBgNV

# BAMTD0hvbWUgSXNzdWluZyBDQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABDOT

# aIIU+QU7LfsmyPqGkCf53SrJuaBPpb5iVILCvG3cQxL6vgIZaGRaKlzYO+lq3CnN

# b4rtJW2d7rlTeehXtpWjggEUMIIBEDAQBgkrBgEEAYI3FQEEAwIBADAdBgNVHQ4E

# FgQUYf1/nMEp3Df+Nzi+Hvk7FymPsrMwGQYJKwYBBAGCNxQCBAweCgBTAHUAYgBD

# AEEwCwYDVR0PBAQDAgGGMA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAUfSS6

# P6qin/3ibmvelGJQhV1r1VgwOwYDVR0fBDQwMjAwoC6gLIYqaHR0cDovL3BraS5x

# ZWRpbnV4LmJlL0hvbWUlMjBSb290JTIwQ0EuY3JsMEYGCCsGAQUFBwEBBDowODA2

# BggrBgEFBQcwAoYqaHR0cDovL3BraS5xZWRpbnV4LmJlL0hvbWUlMjBSb290JTIw

# Q0EuY3J0MAoGCCqGSM49BAMCA0gAMEUCIERRzfMu3vx9vb+Apud4sDkOEKhKrCEl

# gSsedbjZRJ+YAiEA8BBaOqhnbnsUBIX2nty77euunwoAHrCuWzab5xJiy0UwggOO

# MIIDM6ADAgECAhNRAAAAMJpCm89a8zgYAAAAAAAwMAoGCCqGSM49BAMCMCcxCzAJ

# BgNVBAYTAkJFMRgwFgYDVQQDEw9Ib21lIElzc3VpbmcgQ0EwHhcNMjIwNzExMDc0

# NzQ3WhcNMjQwNzExMDc1NzQ3WjAbMRkwFwYDVQQDExBEZWNlbWJyeSBRdWVudGlu

# MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAjALWtmJ1AQG77y9rUBbT

# HXR9FZokTP01bBWfNzk4Kenr/Xpm7Jt09PqLoNS8ToWWKRz9EkM+jg7lnLljWKcO

# G+fT1TbaEwxOpncugnbrioQQonbdWpyn0P7PxlqjUQdWd5Z7xQ0Z8RO3vvERWtDA

# L9QH0VBHNK4WqdWh3ElV6ogJUsy5hYxVTIU0K5VEYkIT4qvqq0RdajKavGWIr57R

# EsYv52Jcyh9FNgZKGdu9NwSKZUvkwHxGsI8zmwfP1I6QRkzsqPXlpk7A8NTD3+h+

# 4Y5AprRFyAWrVNYH+UQQe2D/PjjbKtfsU9xzG9EnqJF09pVRchapis+8DbfWnoC8

# iQIDAQABo4IBfTCCAXkwOgYJKwYBBAGCNxUHBC0wKwYjKwYBBAGCNxUIhorlOcPr

# DIadiwndkzuHjPAAPqb1CYWVxXgCAWQCAQowEwYDVR0lBAwwCgYIKwYBBQUHAwMw

# DgYDVR0PAQH/BAQDAgeAMBsGCSsGAQQBgjcVCgQOMAwwCgYIKwYBBQUHAwMwHQYD

# VR0OBBYEFAkUh200U2U2epAoy2ZvT7nwAYGBMB8GA1UdIwQYMBaAFGH9f5zBKdw3

# /jc4vh75Oxcpj7KzMD4GA1UdHwQ3MDUwM6AxoC+GLWh0dHA6Ly9wa2kucWVkaW51

# eC5iZS9Ib21lJTIwSXNzdWluZyUyMENBLmNybDBJBggrBgEFBQcBAQQ9MDswOQYI

# KwYBBQUHMAKGLWh0dHA6Ly9wa2kucWVkaW51eC5iZS9Ib21lJTIwSXNzdWluZyUy

# MENBLmNydDAuBgNVHREEJzAloCMGCisGAQQBgjcUAgOgFQwTRGVjZW1icnkuUUBo

# b21lLmxhbjAKBggqhkjOPQQDAgNJADBGAiEAh39vHCgqIDL4XazyHPiChMbu0by+

# aFP7rdzlJmM0K6ACIQCaP4CXolxlzdfkJsoIoDIJUrunYIlZ0yxs9OSnG1qmCjGC

# Ad8wggHbAgEBMD4wJzELMAkGA1UEBhMCQkUxGDAWBgNVBAMTD0hvbWUgSXNzdWlu

# ZyBDQQITUQAAADCaQpvPWvM4GAAAAAAAMDAJBgUrDgMCGgUAoHgwGAYKKwYBBAGC

# NwIBDDEKMAigAoAAoQKAADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDAcBgor

# BgEEAYI3AgELMQ4wDAYKKwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQUTwwlarCH

# sN/VgYl9fsEMMFZBmcUwDQYJKoZIhvcNAQEBBQAEggEAGfPg88H01s8INIZF7OTo

# R/6oSZJPUnmRmlp+tAW2kn85ST7wyGoTHy/lDx1sGT8S54P3HgccoOHpf5d//oaT

# x2CQHvPdRXzYUJPvgewpCrD2mW13Ep71w6QCE/F9S5gUJXz8DO5Y1tZLiigmXj6m

# k1gFXLNDnZ1x9+k0nURU/aVaTbj+zGPXPByS4vh6s6r7gDmPpoMXMkXXxC1Mnl6m

# KzeglpkmoxXD3OWJJxAZvYEtjr+lsINixRg6puPLgQdQaMCgQr9AgjtkMPS1lBu/

# 5maPeMsXTs5VlMwjySyLV0BmSvGFKn01puwh7M/uSUu5WU15grcbE4mKpWELWVMN

# dw==

# SIG # End signature block