It is very simple to administer the ezeep hub using powershell. Just follow the steps below:
- Install ezeep PowerShell Module
- Initialize ezeep Hub
- List of available cmdlets
- Remote powershell configuration
1. Install ezeep PowerShell Module
Downloading module from the ezeep Hub and install on a windows machine that can access the hub locally.
- Access the ezeep hub console and download the PowerShell module TPHubPS.dll from the ezeep hub console login page.
Note: If you do not know the hub URL, then follow this link: Finding the ezeep Hub in the network
- The module will download to your default "Downloads" Folder.
- Open the TPHubPS.dll file’s properties and check or click on UNBLOCK to lift Windows’ automatic blocking of copied DLLs. Click OK to confirm.
- Open Windows PowerShell as administrator, and run the command below to import the TPHubPS.dll module.
Import-Module .\TPHubPS.dll
2. Initialize ezeep Hub
Initialize the hub to be able to use all cmdlets with a specific Hub. Run the commands below:
# Specifying the URL of the target Hub
Set-TPHubUri -Uri https://192.168.x.x
# Accepting the web console’s certificate by the PowerShell module
Set-TPHubServerCertificateValidation -Option AcceptAlways
# Specifying the password of the target Hub (by default the password is print
Get-TPHubAuthentication -PlainPassword print4life
3. List of available cmdlets
The following is an overview of the Hub’s PowerShell commands.
- The available cmdlets can be viewed using:
Get-Command -Module TPHubPS
Available cmdlets for:
- Printers
- Find Printers
- Global SNMP Settings
- Network Settings
- Hub Monitoring
- Cloud Connect
- Remote Management (Firmware 1.16+)
- Pull Printing (Firmware 1.16+)
- Certificates
- System
- Restart, Reset & Backup
- Version Information & Update
- System Time & Logging
Printers
| Cmdlet | Brief description |
| Get-TPHubPrinter | Retrieves the printer list |
| Add-TPHubPrinter | Creates a new printer |
| Set-TPHubPrinter | Modifies an existing printer |
| Get-TPHubAvailableUSB | Imports the printers connected to the USB interfaces |
| Remove-TPHubPrinter | Removes a printer from |
| Remove-TPHubAllPrinter | Removes all printers |
| Get-TPHubDefaultPrinter | Reads the default (or the current) printer |
| Set-TPHubDefaultPrinter | Sets the default (or the current) printer |
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 Settings
| Cmdlet | Brief description |
| Get-TPHubNetworkDesc | Reads the Hostname, 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,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 |
| Set-TPHubNetworkIEEE802.1X | Sets the configuration for EAP network authentication for Ethernet |
| Get-TPHubNetworkIEEE802.1X | Reads the configuration of the EAP network authentication for Ethernet |
Hub Monitoring
| Cmdlet | Brief description |
| Get-TPHubSnmpAgentV1 | |
| Set-TPHubSnmpAgentV1 | |
| Get-TPHubSnmpAgentV3 | |
| Set-TPHubSnmpAgentV3 |
Remote Management (Firmware 1.16+ only)
| 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) |
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 |
| Get-TPHubEzeep | Displays the properties of the connection made with Connect-TPHubEzeep to ezeep Blue |
| Disconnect-TPHubEzeep | Disconnects the Hub from ezeep Blue |
Pull Printing (Firmware 1.16+ only)
Certificates
System
Restart, Reset & Backup
Version Information & Update
| Cmdlet | Brief description |
| Get-TPHubVersions | Reads out the version information |
| Update-TPHubFirmware | Updates the firmware |
System Time & 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 connection |
| 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 log level |
| Set-TPHubLogVerbosity | Modifies the log level |
| Clear-TPHubLogFile | Removes all log files |
| Get-TPHubRemoteSyslogAddress | Reads the address of the syslog server |
| Set-TPHubRemoteSyslogAddress | Sets the address of the syslog server |
The ezeep Hub can also be controlled remotely (via the cloud).
- Download the module from the gallery: https://www.powershellgallery.com/packages/TPHubPS/1.19.23.1
- Copy to your PC and unzip the package
- Get the mac address of the hub (e.g. b8:27:eb:2f:7a:a1)
- Start Powershell and run the following commands:
Import-Module .\TPHubPS.dll
Set-TPHubServerCertificateValidation -Option AcceptAlways
Add-TPHubClaimEzpHub -Serial <hub mac>
Get-TPHubAuthentication -PlainPassword print4life -ConnectorSerial <hub mac>Now all hub powershell commands from the above table are available for normal use.