PowerShell cmdlets

1414 views 0

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

Cmdlet Brief description
Get-TPHubPrinter Retrieves the printer list from the ThinPrint Client
Add-TPHubPrinter Creates a new printer on the ThinPrint Client
Set-TPHubPrinter Modifies an existing printer in the ThinPrint Client
Get-TPHubAvailableUSB Imports the printers connected to the USB interfaces of the Hub
Remove-TPHubPrinter Removes a printer from the ThinPrint Client
Remove-TPHubAllPrinter Removes all printers from the ThinPrint Client
Get-TPHubDefaultPrinter Reads the default (or the current) printer of the ThinPrint Client
Set-TPHubDefaultPrinter Sets the default (or the current) printer of the ThinPrint Client

Find Printers

Cmdlet Brief description
Set-TPHubFindPrintersSettings Enables the search for printers in the local subnet of the hub and the automatic addition of found printers to the printer list
Get-TPHubFindPrintersSettings Displays 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-TPHubFindPrinters Searches for printers in the Hub’s local subnet
Set-TPHubDiscoveredPrinter Enables searching printers in the Hub’s local subnet
Get-TPHubDiscoveredPrinter Searches for printers in the Hub’s local subnet
Add-TPHubDiscoveredPrinterBlacklist Marks printers as hidden
Remove-TPHubDiscoveredPrinterBlacklist Removes the attribute hidden

Global SNMP Settings

Cmdlet Brief description
Get-TPHubSnmpGlobal Reads the SNMP configuration with which the printers are addressed
Set-TPHubSnmpGlobal Selects and configures SNMP protocol with which the printers are addressed
Get-TPHubPrinterSnmp
Set-TPHubPrinterSnmp
Get-TPHubPrinterSnmpStatus

Network

Cmdlet Brief description
Get-TPHubNetworkDesc Reads 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-TPHubNetworkDesc Modifies the Hostname and the Comments and Location description fields of the Hub
Get-TPHubNetworkIPV4 Reads the Ipv4 configuration from the Hub
Set-TPHubNetworkIPV4 Modifies the Hub’s IPv4 configuration
Get-TPHubNetworkIPV6 Reads the Hub IPv6 configuration
Get-TPHubNetworkIEEE802.1X Reads the configuration of the EAP network authentication for Ethernet
Set-TPHubNetworkIEEE802.1X Sets the configuration for EAP network authentication for Ethernet

Hub Monitoring

Cmdlet Brief description
Get-TPHubSnmpAgentV1
Set-TPHubSnmpAgentV1
Get-TPHubSnmpAgentV3
Set-TPHubSnmpAgentV3
Get-TPHubSnmpProxy
Set-TPHubSnmpProxy

Remote Management

Cmdlet Brief description
Get-TPHubEzeepCloudManagement Checks the activation of the cloud management of ezeep Blue
Set-TPHubEzeepCloudManagement Enables cloud management of ezeep Blue (prerequisite for Hub claiming)
Get-TPHubStrato Reads the remote management settings for the use of Stratodesk NoTouch Center
Set-TPHubStrato Modifies the remote management settings for the use of Stratodesk NoTouch Center
Get-TPHubStratoTestConnection Tests the connection to the Stratodesk NoTouch Center. Corresponds to the Test Connec­tion function in the web console.
Get-TPHubStratoSyncNow Retrieves the Hub configuration from the Stratodesk NoTouch Center. Corresponds to the Synchronize Now function in the web console.

Cloud Connect

Cmdlet Brief description
Connect-TPHubEzeep Connects 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-TPHubEzeep Displays the properties of the connection made with Connect-TPHubEzeep to ezeep Blue (in the Azure cloud).
Disconnect-TPHubEzeep Disconnects the Hub from ezeep Blue (in the Azure cloud).

ThinPrint

Cmdlet Brief description
Get-TPHubThinPrintConfig Reads the ThinPrint Client configuration
Set-TPHubThinPrintConfig Modifies the ThinPrint Client configuration
Get-TPHubThinPrintConSvcConfig Reads the ThinPrint Client Connection Service configuration
Set-TPHubThinPrintConSvcConfig Modifies the ThinPrint Client Connection Service configuration
Get-TPHubThinPrintConSvcConfigTest Tests the connection to the ThinPrint Connection Service. Corresponds to the Test Connec­tion function in the web console.

Pull Printing and Personal Printing

Cmdlet Brief description
Get-TPHubPPConfiguration Displays the Personal Printing settings of the current Hub or Release Station
Set-TPHubPPConfiguration Sets specific Personal Printing properties of a Hub or Release Station
Get-TPHubPPServerCheck Tests the connection to the Personal Printing server. Corresponds to the Test Connec­tion function in the web console
Get-TPHubPPReader Shows the current assignment of the card reader to the USB interface(s)
Set-TPHubPPReader This 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-TPHubPPLastId Displays the identification number (ID) of the last card held to the card reader and the date and time of this event.
Get-TPHubPullPrintingConfiguration Reads the Pull Printing configuration for ezeep Blue (in the Azure cloud) from the Hub or Release Station respectively
Set-TPHubPullPrintingConfiguration Sets and configures pull printing for ezeep Blue (in the Azure cloud)

Certificates

Cmdlet Brief description
Add-TPHubCertificate Uploads a certificate onto the Hub
Unlock-TPHubCertificate If a certificate (just) loaded, with Add-TPHubCertificate, is protected by a password, then unlock it with this Cmdlet.
Get-TPHubUnconfirmedCertificate This function can be used to check whether a password-protected certificate has been successfully unlocked with Unlock-TPHubCertificate after uploading
Remove-TPHubUnconfirmedCertificate This 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-TPHubCertificate Removes certificates that are not currently assigned a function with Set-TPHubSsl­Config
Get-TPHubCertificate Displays all the certificates uploaded with Add-TPHubCertificate – regardless of whether they have already been assigned a function with Set-TPHubSslConfig
Get-TPHubSslConfig Indicates what function has been assigned to which certificate uploaded with Add-TPHubCertificate
Set-TPHubSslConfig Applies one of three functions to certificates uploaded with Add-TPHubCertificate

System

Setup and security

Cmdlet Brief description
Find-TPHubDevices Searches for Hubs in the local subnet
Set-TPHubTemporaryNetworkConfig Changes the IP address of a Hub (valid only up to the next system reboot of the device).
Set-TPHubUri Defines web address of the Hub to be configured
Get-TPHubUri Shows the current web address of the Hub to be configured
Set-TPHubProxy Defines a proxy server for web access to the Hub to be configured
Get-TPHubProxy Displays the current proxy server address
Set-TPHubServerCertificateValidation Determines whether or not the web console certificate will be accepted by the Pow­erShell module
Get-TPHubServerCertificateValidation Imports the current setting for accepting the web console certificate through the Pow­erShell module
Get-TPHubLanguage Reads the current system language
Set-TPHubLanguage Changes the system language back
Set-TPHubPassword Changes the system password
Get-TPHubIsHidden Shows 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-TPHubIsHidden After five minutes after a system reboot, the Hub will no longer appear in the Hub Finder
Get-TPHubAuthentication Logs the current user into the Hub
Clear-TPHubAuthentication Logs the current user out from the Hub

Restart, reset and backup

Cmdlet Brief description
Start-TPHubReboot Reboots the system
Start-TPHubFactoryReset Resets the Hub to its factory default settings
Get-TPHubRequestTimeout Reads the timeout from the Hub
Set-TPHubRequestTimeout Reads the timeout from the Hub
Export-TPHubBackup Saves the settings in a .json file
Import-TPHubBackup Reads the saved settings from the .json backup file and writes them into the Hub
Get-TPHubTaskResult

Version information and firmware update

Cmdlet Brief description
Get-TPHubVersions Reads out the version information
Update-TPHubFirmware Updates the firmware

System time and logging

Cmdlet Brief description
Get-TPHubTime Reads the Hub’s system time
Set-TPHubTime Sets the system time if a time server is not specified and there is no internet connec­tion
Get-TPHubTimeServer Sends query to time server in the Hub
Set-TPHubTimeServer Defines a time server
Export-TPHubLogFile Saves the logs completely into a file
Get-TPHubLogVerbosity Retrieves the ThinPrint Client log level
Set-TPHubLogVerbosity Modifies the ThinPrint Client log level
Clear-TPHubLogFile Removes all log files
Get-TPHubRemoteSyslogAddress
Set-TPHubRemoteSyslogAddress

 

Previous Page
Next Page

Was this helpful?