TeamViewerPS allows to interact with the TeamViewer Web API as well as a locally installed TeamViewer client.
Downloads and installs TeamViewerPS from the Powershell Gallery using the following command:
Install-Module TeamViewerPSExecute the following command to update an existing installation of TeamViewerPS:
Update-Module TeamViewerPSThe following example code shows how to interact with the TeamViewer Web API functions by retrieving the list of users of a TeamViewer company:
# Stores API token for Powershell session
# 1. Create a TeamViewer API access token in the Management Console: https://login.teamviewer.com
# 2. Enter the API token in the shown dialog
Connect-TeamViewerApi
# Retrieves users of a TeamViewer company
Get-TeamViewerUserAnother example below shows how to display the TeamViewer ID as well as the version of the locally installed TeamViewer client:
# Returns the TeamViewer Id of the locally installed TeamViewer client
Get-TeamViewerId
# Returns the version of the locally installed TeamViewer client
Get-TeamViewerVersionThe documentation and help can be accessed using the following commands:
# Starting point of the documentation
Get-Help TeamViewerPS
# List of available commands of this module
Get-Command -Module TeamViewerPS
# Help for specific module functions
Get-Help -Full Get-TeamViewerUser # ... or any other commandThe module provides functions for the following categories:
- Computers & Contacts list
- User management
- User groups
- Roles
- Managed groups
- Policy management
- Single Sign-On (SSO) management
- Local TeamViewer utilities
Please see the TeamViewerPS article for a more detailed list.
TeamViewerPS requires one of the following environments to run:
- PowerShell 5.1 (Windows)
- PowerShell Core 6 (Windows, Linux)
- PowerShell 7 (Windows, Linux)
Please see the file LICENSE.md.
