-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4611f13
commit b5fc33d
Showing
1 changed file
with
37 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,38 @@ | ||
# PSTruPortal | ||
|
||
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/erwindevreugd) | ||
|
||
A PowerShell module for the Interlogix TruPortal API. | ||
|
||
## Cmdlet Name Collision | ||
|
||
To avoid name collision between the cmdlet in this module and other cmdlets you can import this module with a prefix. | ||
|
||
```powershell | ||
Import-Module -Name PSTruPortal -Prefix TP | ||
``` | ||
|
||
## Donation | ||
|
||
# PSTruPortal | ||
|
||
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/erwindevreugd) | ||
|
||
A PowerShell module for the Interlogix TruPortal API. | ||
|
||
## Cmdlet Name Collision | ||
|
||
To avoid name collision between the cmdlet in this module and other cmdlets you can import this module with a prefix. | ||
|
||
```powershell | ||
Import-Module -Name PSTruPortal -Prefix TP | ||
``` | ||
|
||
## Getting Started | ||
|
||
### Getting a Session Key | ||
|
||
Before you can send commands to the TruPortal you need to get a session key. | ||
You can save than save the session key to the script context so subsequent commands will be able to use the session key as long as the key is valid. | ||
|
||
```powershell | ||
Invoke-LoginUser -Host 192.168.1.1 -Username user -Password 1234 | Set-ScriptContext | ||
``` | ||
|
||
To signout a session key that is saved to the script context you can retrieve the key and pipe it to the logout cmdlet. | ||
|
||
```powershell | ||
Get-SessionKeyFromScriptContext | Invoke-LogoutUser | ||
``` | ||
|
||
## Trademark Acknowledgements | ||
|
||
* Interlogix and TruPortal are registered trademarks of Interlogix United Technologies. | ||
|
||
## Donation | ||
|
||
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/erwindevreugd) |