Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 1.79 KB

README.md

File metadata and controls

64 lines (40 loc) · 1.79 KB

letheanSDP - the PowerShell module for the Lethean Binary API

Functionality to simplify using LTHN

This PowerShell module is automatically generated by the OpenAPI Generator project:

  • API version: 1.2.2
  • SDK version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PowerShellClientCodegen For more information, please visit https://lt.hn

Frameworks supported

  • PowerShell 6.2 or later

Dependencies

Installation

To install from the source, run the following command to build and install the PowerShell module locally:

Build.ps1
Import-Module -Name '.\src\letheanSDP' -Verbose

To avoid function name collision, one can use -Prefix, e.g. Import-Module -Name '.\src\letheanSDP' -Prefix prefix

To uninstall the module, simply run:

Remove-Module -FullyQualifiedName @{ModuleName = "letheanSDP"; ModuleVersion = "1.0.0"}

Tests

To install and run Pester, please execute the following commands in the terminal:

Install-module -name Pester -force

Invoke-Pester

For troubleshooting, please run $DebugPreference = 'Continue' to turn on debugging and disable it with $DebugPreference = 'SilentlyContinue' when done with the troubleshooting.

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
LetheanSDPVpnApi Start-letheanSDPLetheand GET /letheand/start

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.