PSIGEL

1.0.0

API functions for use with UMS of IGEL TECHNOLOGY

Minimum PowerShell version

7.0

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name PSIGEL

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name PSIGEL

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) 2018 Falk Heiland. Alle Rechte vorbehalten.

Package Details

Author(s)

  • Falk Heiland

Tags

IGEL UMS IMI

Functions

Get-UMSAssetHistory Get-UMSAssetInfo Get-UMSDevice Get-UMSDeviceAssignment Get-UMSDeviceDirectory Get-UMSDeviceDirectoryAssignment Get-UMSDeviceView Get-UMSDirectoryRecursive Get-UMSFirmware Get-UMSMasterProfile Get-UMSMasterProfileAssignment Get-UMSMasterProfileDirectory Get-UMSProfile Get-UMSProfileAssignment Get-UMSProfileDirectory Get-UMSStatus Get-UMSTemplateKey Move-UMSDevice Move-UMSDeviceDirectory Move-UMSMasterProfile Move-UMSMasterProfileDirectory Move-UMSProfile Move-UMSProfileDirectory New-UMSAPICookie New-UMSDevice New-UMSDeviceDirectory New-UMSDeviceDirectoryTemplateKey New-UMSDeviceTemplateKey New-UMSMasterProfileAssignment New-UMSMasterProfileDirectory New-UMSProfileAssignment New-UMSProfileDirectory New-UMSTemplateKey New-UMSTemplateKeyValue Remove-UMSAPICookie Remove-UMSDevice Remove-UMSDeviceDirectory Remove-UMSMasterProfile Remove-UMSMasterProfileAssignment Remove-UMSMasterProfileDirectory Remove-UMSProfile Remove-UMSProfileAssignment Remove-UMSProfileDirectory Reset-UMSDevice Restart-UMSDevice Send-UMSDeviceSetting Start-UMSDevice Stop-UMSDevice Update-UMSDevice Update-UMSDeviceDirectory Update-UMSMasterProfile Update-UMSMasterProfileDirectory Update-UMSProfile Update-UMSProfileDirectory

PSEditions

Core

Dependencies

This module has no dependencies.

Release Notes

## [1.0.0] - 2026-11-06

### Security

* **BREAKING**: the UMS server certificate is validated. Until now every call skipped the check, so credentials and session cookie went to any server that answered. For a UMS with a self-signed certificate add the new switch -SkipCertificateCheck to every call, or better replace the certificate with one the client trusts. Use the host name the certificate is issued for (usually the FQDN) as -Computername.
* **BREAKING**: Remove-UMSAPICookie no longer outputs the session cookie value. It returns an object with Computername and LoggedOut; the warning after a failed logout names the cookie, not its value.
* New-UMSAPICookie marks the session cookie Secure and HttpOnly.

### Added

* Get-UMSAssetHistory: GET /v3/assethistory — returns asset history for all, a specific asset, or a specific thin client
* Get-UMSAssetInfo: GET /v3/assetinfo — returns asset information for all, a specific asset, or a specific thin client
* Get-UMSTemplateKey: GET /v3/template/{id}/read — returns all values defined for a template key
* New-UMSTemplateKey: PUT /v3/template — creates a new template key
* New-UMSTemplateKeyValue: PUT /v3/template/{id}/value — creates or updates a value for a template key
* New-UMSDeviceTemplateKey: PUT /v3/template/assign/tc — assigns a template key value to a thin client
* New-UMSDeviceDirectoryTemplateKey: PUT /v3/template/assign/dir — assigns a template key value to a device directory
* added support for networkadapters and deviceattributes to Get-UMSDevice
* added support for deviceattributes to Update-UMSDevice
* Sampler-based build pipeline (build.ps1, build.yaml, RequiredModules.psd1)
* Codeberg release task (Publish_Release_To_Codeberg via Gitea API)
* Get-UMSMasterProfile, Get-UMSMasterProfileAssignment, Get-UMSMasterProfileDirectory (Closes #44)
* Move-UMSMasterProfile, Move-UMSMasterProfileDirectory
* New-UMSMasterProfileAssignment, New-UMSMasterProfileDirectory
* Remove-UMSMasterProfile, Remove-UMSMasterProfileAssignment, Remove-UMSMasterProfileDirectory
* Update-UMSMasterProfile, Update-UMSMasterProfileDirectory
* Get-UMSDeviceView: GET /v3/thinclientview/{viewId} — requires UMS 6.10.110+ (Closes #46)
* references/IMI-API-v3.md: comprehensive IMI v3 API reference (86+ endpoints, data types, error codes)

### Changed

* **BREAKING**: dropped Windows PowerShell 5.1 (Desktop) support — PowerShell 7+ (Core) required
* **BREAKING**: all public functions: $Computername now validated as non-null/non-empty
* **BREAKING**: all public functions: $WebSession now typed as [WebRequestSession]
* support for german "Umlaute"
* changed casting of properties version to String (Get-UMSStatus and Get-UMSFirmware)
* migrated all repository URLs from GitHub (IGEL-Community/PSIGEL) to Codeberg (falkheiland/PSIGEL)
* Update-UMSDevice: replaced array += loop with foreach output collection for DeviceAttributes
* Update-UMSDevice: added -Depth 3 to ConvertTo-Json to correctly serialize nested DeviceAttributes
* module built via ModuleBuilder (merged single psm1 in output/)
* **BREAKING**: -SecurityProtocol accepts only Tls12 and Tls13. Tls, Tls11 and Ssl3 did not work on PowerShell 7 anyway.
* Build dependencies pinned in RequiredModules.psd1, tests migrated to Pester 6
* Integration tests replaced: phased suite in Tests/Integration against a containerized UMS test fixture with a fixed baseline; Tests/Config.psd1 and Tests/Pester.ps1 removed

### Fixed

* Invoke-UMSRestMethod: HTTP errors now use `Write-Error` with `ErrorCategory` instead of `Write-Warning` — callers can control behaviour via `-ErrorAction`
* Invoke-UMSRestMethod: API error codes (ITG-0A*, ITG-0B*, ITG-FF*) parsed from response body and included in error messages
* New-UMSDeviceDirectoryTemplateKey, New-UMSDeviceTemplateKey, New-UMSTemplateKeyValue: fix `ShouldProcess` format-string bug — multiple `-f` arguments inside a .NET method call were parsed as separate method arguments
* fixed links to license and online help
* Update-UMSDevice: fixed stray tab character in DeviceAttributes block
* New-UMSAPICookie -WhatIf (or -Confirm answered with No) logged in anyway and left an open session on the UMS.
* New-UMSAPICookie writes an error when the login answer contains no session cookie, instead of returning a session that fails on the next call.
* -SecurityProtocol with more than one value failed in every cmdlet except New-UMSAPICookie and Remove-UMSAPICookie: the values were joined into one string that the validation rejected.
* Get-UMSStatus no longer throws "Version string portion was too short or too long" on UMS 12. RmGuiServerVersion and ActiveMqVersion take the leading numeric part of the version string and are $null when the UMS returns an empty string.
* New-UMSDevice and Update-UMSDevice accept device names up to 100 characters (the UMS column length) instead of 15.
* Get-UMSDevice -Filter loginhistory failed: the internal filter helper did not accept the value.
* Remove-UMSAPICookie warns "Could not remove Cookie" when the logout fails (e.g. expired session); the failure check before was always true.
* Invoke-UMSRestMethod: errors with an unmapped HTTP status code now name the code ("HTTP 503 error") instead of "HTTP  error".

FileList

Version History

Version Downloads Last updated
1.0.0 (current version) 50 11/6/2026
0.10.0 11,717 4/29/2020
0.9.0 293 3/10/2019