ThinScale Management PowerShell Module User Guide
- June 10, 2024
- THINSCALE
Table of Contents
ThinScale Management PowerShell Module
Product Information
Specifications
- Product Name: Thin Scale Management Power Shell Module
- Version: 7.5
- Minimum Power Shell Version: 7.0
- Installation Path: C: Program Files PowerS hell 7 Modules Thin Scale Management
Product Usage Instructions
Prerequisites
- The module will only work on a machine where the ThinScale Management Console is also installed since it depends on some of the installed files.
- The module requires a minimum of version 7.0 of PowerShell.
Installation
- The module can be installed using the ‘Install Module’ icon from within the Thin Scale Management Console.
- Note: Power Shell 7.2 or greater is required.
- This will allow you to install the module for just the current user or all users on the machine (requires administrative privileges).
- Installation Path: C: Program FilesPower Shell 7 Modules Thin Scale Management
Permissions
The module is digitally signed so can be run when the PowerShell execution policy is set to AllSigned.
Frequently Asked Questions
Q: What versions of PowerShell are compatible with the ThinScale Management PowerShell Module?
A: The module requires a minimum of version 7.0 of PowerShell.
Q: How can I install the ThinScale Management PowerShell Module?
A: You can install the module using the ‘Install Module’ icon from within the ThinScale Management Console.
Introduction
- The ThinScale Management PowerShell module allows PowerShell scripts to be written which can call functions present in the ThinScale Management Console.
- This enables certain operations to be automated rather than them having to be performed manually from within the console itself.
How this Guide Works
- ThinScale installation and administration guides are designed to assist with the installation and configuration of ThinScale solutions within your environment by providing an easy-to-follow, comprehensive, step-by-step set of illustrated instructions.
- Throughout this guide, you will see various types of text such as URLs, command line entries, and on-screen text all represented using different styles and formatting to distinguish between the types of text.
The following table shows examples of these different styles:
- On-Screen Text Indicates text shown on the screen, such as menus, options, click buttons, and other text information
- External URL Indicates a link to an external page/website
- Internal URL Indicates a link to an internal web page such as a console
- Command Line Indicates something that you need to type in, such as the command line instructions, scripts, usernames, and passwords
- Commands Indicates a command name or variable
- Section Reference Indicates a reference to another section within the document, such as another page or heading
- server\folder Indicates a path to a folder or a shared folder
Document Revision History
The current version of this document, plus the version history details of what has changed.
Revision/Version | Date | Author(s) | Description |
---|---|---|---|
V3.1.0 | January 2019 | David Coombes | First Release |
V5.0 | January 2020 | David Coombes | Second Release |
V.5.2 | July 2020 | David Coombes | Third Release |
V.5.4 | March 2021 | David Coombes | Fourth Release |
V 7.0 | April 2021 | David Coombes | Fifth Release |
V7.1 | October 2021 | David Coombes | Sixth Release |
V7.2 | November 2021 | Niall AL Rubeai | Seventh Release |
V7.3 | July 2022 | Niall AL Rubeai | Eighth Release |
V7.4 | November 2022 | David Coombes | Ninth Release |
V7.5 | July 2023 | David Coombes | Tenth Release |
Functions
The functions available in this version of the module are as follows:
- Add-TSTMGMTFolderPackageAssignment
- Add-TSTMGMTFolderProfileAssignment
- Add-TSTMGMTProfileRevision
- Connect-TSTMGMTServer
- Disconnect-TSTMGMTServer
- Export-TSTMGMTProfile
- Get-TSTMGMTAllData
- Get-TSTMGMTAccessKey
- Get-TSTMGMTAccessKeys
- Get-TSTMGMTAPResults
- Get-TSTMGMTDevice
- Get-TSTMGMTDevices
- Get-TSTMGMTDeviceInventory
- Get-TSTMGMTFolder
- Get-TSTMGMTFolders
- Get-TSTMGMTLicenseData
- Get-TSTMGMTLicenseUsage
- Get-TSTMGMTProfile
- Get-TSTMGMTProfileObject
- Get-TSTMGMTProfileRevisions
- Get-TSTMGMTProfiles
- Get-TSTMGMTRefreshData
- Get-TSTMGMTRole
- Get-TSTMGMTRoles
- Get-TSTMGMTSite
- Get-TSTMGMTSites
- Get-TSTMGMTUser
- Get-TSTMGMTUsers
- Get-TSTMGMTLogsAudit
- Get-TSTMGMTLogsEvent
- Get-TSTMGMTLogsMonitoring
- Import-TSTMGMTProfileObject
- Invoke-TSTMGMTAdminAction
- Move-TSTMGMTObject
- Move-TSTMGMTObjects
- New-TSTMGMTAddAce
- New- TSTMGMTAccessKey
- New-TSTMGMTDevice
- New-TSTMGMTFolder
- New-TSTMGMTProfile
- New-TSTMGMTProfileObject
- New-TSTMGMTRole
- New-TSTMGMTSite
- New-TSTMGMTUser
- Remove-TSTMGMTFolderPackageAssignment.
- Remove-TSTMGMTFolderProfileAssignment Remove-TSTMGMTObject
- Rename-TSTMGMTObject
- Reset-TSTMGMTDeviceLocationData
- Set-TSTMGMTAccessKey
- Set-TSTMGMTDeviceNotes
- Set-TSTMGMTFolder
- Set-TSTMGMTObjectSecurity
- Set-TSTMGMTRole
- Set-TSTMGMTSite
- Set-TSTMGMTUser
- Test-TSTMGMTObjectExists
- Get-TSTMGMTUserAssignment
- Get-TSTMGMTUserAssignments
- New-TSTMGMTUserAssignment
- Set-TSTMGMTUserAssignment
Prerequisites
- The module will only work on a machine where the ThinScale Management Console is also installed since it depends on some of the installed files.
- The module requires a minimum of version 7.0 of PowerShell.
Installation
- The module can be installed using the ‘Install Module’ icon from within the ThinScale Management Console.
- Note: Powershell 7. 2 or greater is required
- This will allow you to install the module for just the current user or all users on the machine (requires administrative privileges)
- C: \Program Files\PowerShell\7\Modules\ThinScaleManagement
Permissions
The module is digitally signed so can be run when the PowerShell execution policy is set to AllSigned.
Documentation
- The module includes PowerShell-compatible help for all functions.
This can be accessed in two ways:
- Using PowerShell’s Get-Help cmdlet
- Pressing the F1 key with the cursor in a ThinScale Management function when using PowerShell ISE
Usage
-
Once installed, the module is loaded by running the following command:
Import-Module ThinScaleManagement
A connection to a ThinScale Management server must then be made which returns an object which needs to be passed to all further ThinScale functions and should be stored in a variable:
Connect-TSTMGMTServer -URI “https://d7.thinscale.com“ -username bob@thinscale.com“ -password “password” -
An alternative to passing the URI, username and password is to set some, or all, of them in the environment variables THINSCALE_URI, THINSCALE_USERNAME and
-
THINSCALE_PASSWORD respectively.
-
The required function(s) can then be called bypassing the interface variable and other parameters as per the module’s self-contained documentation.
-
For example: $alldata = Get-TSTMGMTAllData
-
Once all operations have been completed, the session should be disconnected using the following command:
Disconnect-TSTMGMTServer
- This will invalidate the interface variable so if subsequent ThinScale functions need to be called, the Connect-TSTMGMTServer function must be called again and a new interface variable stored.
Parameters
- Where existing objects, such as devices or folders, need to be passed as parameters to ThinScale functions, there are two ways of achieving this:
- Specify it as an absolute string path such as Devices\Production\Luxemburg\Device1234
- Specify the unique GUID for the item which can be obtained via the data returned from the Get-TSTMGMTAllData function or a call to New-TSTMGMTFolder or New-TSTMGMTDevice
- All functions that require existing objects to be specified require different parameters to be used depending on whether a string or GUID is being passed to identify that object.
- For example: New-TSTMgmtFolder – FolderName ‘\Devices\Production’
- New-TSTMgmtFolder -FolderName ‘UAT’ -ParentId ‘A7955CE0-8743-44CD-87A1-BD6418085912’ -DeviceState Disabled -DeviceStateMessage ‘Devices in this folder are disabled’
- Where the GUID passed via -parentId is the GUID of the folder \Devices\Production
- WWW.THINSCALE.COM
- © Copyright ThinScale 2023, All Rights Reserved
Documents / Resources
|
THINSCALE ThinScale Management PowerShell
Module
[pdf] User Guide
ThinScale Management PowerShell Module, Management PowerShell Module,
PowerShell Module, Module
---|---
References
- ThinScale | Endpoint Security & Management | All In One Solution
- ThinScale | Endpoint Security & Management | All In One Solution