Open navigation

PowerShell cmdlets • Overview

Printers

Finding Printers

Printer Monitoring

Network

Hub Monitoring

Remote Management

Cloud Connect

ThinPrint

Pull Printing and Personal Printing

Certificates

System

Setup and security

Restart, reset and backup

Version information and firmware update

System time and logging


The following is an overview of the Hub's PowerShell commands.

  • Click on the link of the respective command (cmdlet) to get detailed instructions.


Printers

CmdletBrief description
Get-TPHubPrinterRetrieves the printer list from the ThinPrint Client
Add-TPHubPrinterCreates a new printer on the ThinPrint Client
Set-TPHubPrinterModifies an existing printer in the ThinPrint Client
Get-TPHubAvailableUSBImports the printers connected to the USB interfaces of the Hub
Remove-TPHubPrinterRemoves a printer from the ThinPrint Client
Remove-TPHubAllPrinterRemoves all printers from the ThinPrint Client
Get-TPHubDefaultPrinterReads the default (or the current) printer of the ThinPrint Client
Set-TPHubDefaultPrinterSets the default (or the current) printer of the ThinPrint Client


Finding Printers

CmdletBrief description
Set-TPHubFindPrintersSettingsEnables the search for printers in the local subnet of the hub and the automatic addition of found printers to the printer list
Get-TPHubFindPrintersSettingsDisplays the settings whether to search for printers in the local subnet of the hub and whether these printers should be automatically added to the printer list
Get-TPHubFindPrintersSearches for printers in the Hub’s local subnet
Set-TPHubDiscoveredPrinterEnables searching printers in the Hub’s local subnet
Get-TPHubDiscoveredPrinterSearches for printers in the Hub’s local subnet
Add-TPHubDiscoveredPrinterBlacklistMarks printers as hidden
Remove-TPHubDiscoveredPrinterBlacklistRemoves the attribute hidden


Printer Monitoring

CmdletBrief description
Get-TPHubSnmpGlobalReads the SNMP configuration with which the printers are addressed globally
Set-TPHubSnmpGlobalConfigures SNMP globally for all printers
Get-TPHubPrinterSnmpReads the SNMP configuration with which a specific printer is addressed
Set-TPHubPrinterSnmpConfigures SNMP for a specific printer
Get-TPHubPrinterSnmpStatusQueries the SNMP status of a printer
Get-TPHubSnmpProxyChecks whether the current ThinPrint Hub is acting as a proxy
Set-TPHubSnmpProxySet up ThinPrint Hub as a proxy through which the printers can be queried via SNMP


Network

CmdletBrief description
Get-TPHubNetworkDescReads the Hostname and the Comments and Location description fields (and also the software internal Revision hash, to uniquely identify the configuration) from the Hub
Set-TPHubNetworkDescModifies the Hostname and the Comments and Location description fields of the Hub
Get-TPHubNetworkIPV4Reads the Ipv4 configuration from the Hub
Set-TPHubNetworkIPV4Modifies the Hub's IPv4 configuration
Get-TPHubNetworkIPV6Reads the Hub IPv6 configuration
Get-TPHubNetworkIEEE802.1XReads the configuration of the EAP network authentication for Ethernet
Set-TPHubNetworkIEEE802.1XSets the configuration for EAP network authentication for Ethernet


Hub Monitoring

CmdletBrief description
Get-TPHubSnmpAgentV1checks if the current ThinPrint Hub can be monitored with SNMP version 1 or 2c
Set-TPHubSnmpAgentV1determines that the current ThinPrint Hub can be monitored with SNMP version 1 or 2c
Get-TPHubSnmpAgentV3checks whether the current ThinPrint Hub can be monitored with SNMP version 3
Set-TPHubSnmpAgentV3determines that the current ThinPrint Hub can be monitored with SNMP version 3


Remote Management

CmdletBrief description
Get-TPHubEzeepCloudManagementChecks the activation of the cloud management of ezeep Blue
Set-TPHubEzeepCloudManagementEnables cloud management of ezeep Blue (prerequisite for Hub claiming)
Get-TPHubStratoReads the remote management settings for the use of Stratodesk NoTouch Center
Set-TPHubStratoModifies the remote management settings for the use of Stratodesk NoTouch Center
Get-TPHubStratoTestConnectionTests the connection to the Stratodesk NoTouch Center. Corresponds to the Test Connec­tion function in the web console.
Get-TPHubStratoSyncNowRetrieves the Hub configuration from the Stratodesk NoTouch Center. Corresponds to the Synchronize Now function in the web console.


Cloud Connect

CmdletBrief description
Connect-TPHubEzeepConnects the Hub to ezeep Blue to allow printers installed on the  Hub to also be used for cloud printing with ezeep Blue (in the Azure cloud).
Get-TPHubEzeepDisplays the properties of the connection made with Connect-TPHubEzeep to ezeep Blue (in the Azure cloud).
Add-TPHubClaimEzpHubincludes an ezeep Hub into the cloud management of ezeep Blue using its MAC address
Disconnect-TPHubEzeepDisconnects the Hub from ezeep Blue (in the Azure cloud).


ThinPrint

CmdletBrief description
Get-TPHubThinPrintConfigReads the ThinPrint Client configuration
Set-TPHubThinPrintConfigModifies the ThinPrint Client configuration
Get-TPHubThinPrintConSvcConfigReads the ThinPrint Client Connection Service configuration
Set-TPHubThinPrintConSvcConfigModifies the ThinPrint Client Connection Service configuration
Get-TPHubThinPrintConSvcConfigTestTests the connection to the ThinPrint Connection Service. Corresponds to the Test Connec­tion function in the web console.


Pull Printing and Personal Printing

CmdletBrief description
Get-TPHubPPConfigurationDisplays the Personal Printing settings of the current Hub or Release Station
Set-TPHubPPConfigurationSets specific Personal Printing properties of a Hub or Release Station
Get-TPHubPPServerCheckTests the connection to the Personal Printing server. Corresponds to the Test Connec­tion function in the web console
Get-TPHubPPReaderShows the current assignment of the card reader to the USB interface(s)
Set-TPHubPPReaderThis cmdlet allows you to manually assign the card readers to the USB interfaces. Automatic recognition of the USB port assignment is only possible with the web con­sole.
Get-TPHubPPLastIdDisplays the identification number (ID) of the last card held to the card reader and the date and time of this event.
Get-TPHubPullPrintingConfigurationReads the Pull Printing configuration for ezeep Blue (in the Azure cloud) from the Hub or Release Station respectively
Set-TPHubPullPrintingConfigurationSets and configures pull printing for ezeep Blue (in the Azure cloud)


Certificates

CmdletBrief description
Add-TPHubCertificateUploads a certificate onto the Hub
Unlock-TPHubCertificateIf a certificate (just) loaded, with Add-TPHubCertificate, is protected by a password, then unlock it with this Cmdlet.
Get-TPHubUnconfirmedCertificateThis function can be used to check whether a password-protected certificate has been successfully unlocked with Unlock-TPHubCertificate after uploading
Remove-TPHubUnconfirmedCertificateThis Cmdlet has the same function as the Remove . It can only be used following the uploading of a certificate whose password has still not been sent to the Hub with Unlock-TPHubCertificate.
Remove-TPHubCertificateRemoves certificates that are not currently assigned a function with Set-TPHubSsl­Config
Get-TPHubCertificateDisplays all the certificates uploaded with Add-TPHubCertificate – regardless of whether they have already been assigned a function with Set-TPHubSslConfig
Get-TPHubSslConfigIndicates what function has been assigned to which certificate uploaded with Add-TPHubCertificate
Set-TPHubSslConfigApplies one of three functions to certificates uploaded with Add-TPHubCertificate


System

Setup and security

CmdletBrief description
Find-TPHubDevicesSearches for Hubs in the local subnet
Set-TPHubTemporaryNetworkConfigChanges the IP address of a Hub (valid only up to the next system reboot of the device).
Set-TPHubUriDefines web address of the Hub to be configured
Get-TPHubUriShows the current web address of the Hub to be configured
Set-TPHubProxyDefines a proxy server for web access to the Hub to be configured
Get-TPHubProxyDisplays the current proxy server address
Set-TPHubServerCertificateValidationDetermines whether or not the web console certificate will be accepted by the Pow­erShell module
Get-TPHubServerCertificateValidationImports the current setting for accepting the web console certificate through the Pow­erShell module
Get-TPHubLanguageReads the current system language
Set-TPHubLanguageChanges the system language back
Set-TPHubPasswordChanges the system password
Get-TPHubIsHiddenShows whether the function Make ThinPrint Hub invisible for the ThinPrint Hub Finder is enabled, i. e. whether the Hub will become invisible to the Finder after five minutes
Set-TPHubIsHiddenAfter five minutes after a system reboot, the Hub will no longer appear in the Hub Finder
Get-TPHubAuthenticationLogs the current user into the Hub
Clear-TPHubAuthenticationLogs the current user out from the Hub and deletes the tokens of an ezeep login from the Windows registry


Restart, reset and backup

CmdletBrief description
Start-TPHubRebootReboots the system
Start-TPHubFactoryResetResets the Hub to its factory default settings
Get-TPHubRequestTimeoutReads the timeout from the Hub
Set-TPHubRequestTimeoutReads the timeout from the Hub
Export-TPHubBackupSaves the settings in a .json file
Import-TPHubBackupReads the saved settings from the .json backup file and writes them into the Hub
Get-TPHubTaskResultUsed to determine if a save operation of a particular Cmdlet has already completed and was successful (Set-TPHubNetworkIPV4,
Set-TPHubEzeepCloudManagement,
Import-TPHubBackup).


Version information and firmware update

CmdletBrief description
Get-TPHubVersionsReads out the version information
Update-TPHubFirmwareUpdates the firmware


System time and logging

CmdletBrief description
Get-TPHubTimeReads the Hub’s system time
Set-TPHubTimeSets the system time if a time server is not specified and there is no internet connec­tion
Get-TPHubTimeServerSends query to time server in the Hub
Set-TPHubTimeServerDefines a time server
Export-TPHubLogFileSaves the logs completely into a file
Get-TPHubLogVerbosityRetrieves the ThinPrint Client log level
Set-TPHubLogVerbosityModifies the ThinPrint Client log level
Clear-TPHubLogFileRemoves all log files
Get-TPHubRemoteSyslogAddressReads the address of the syslog server
Set-TPHubRemoteSyslogAddressSets the address of the syslog server

 

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.