TeamViewerPS

TeamViewerPS is a PowerShell module for interacting with the TeamViewer Web API and managing a locally installed TeamViewer client.

Installation

Install the latest released version from the PowerShell Gallery:

Install-Module -Name TeamViewerPS

If the module is already installed, update it with:

Update-Module -Name TeamViewerPS

If you need to load the module explicitly after install:

Import-Module TeamViewerPS

Prerequisites

TeamViewerPS supports:

• Windows PowerShell 5.1 on Windows
• PowerShell Core 6+ on Windows and Linux
• PowerShell 7+ on Windows and Linux

Quick Start

Connect to the TeamViewer Web API

Create a TeamViewer API access token in the TeamViewer user profile, then connect:

$apiToken = Read-Host -Prompt 'TeamViewer API token' -AsSecureString
Connect-TeamViewerApi -ApiToken $apiToken

Once connected, you can call Web API commands without specifying the token again:

Get-TeamViewerUser
Get-TeamViewerGroup
Get-TeamViewerPolicy

Disconnect from the Web API

Disconnect-TeamViewerApi

Usage Examples

Retrieve company users

Get-TeamViewerUser

Get local TeamViewer client information

Get-TeamViewerId
Get-TeamViewerVersion
Get-TeamViewerInstallationDirectory
Get-TeamViewerLogFilePath

Test connectivity

Test-TeamViewerConnectivity

Configuration

Use a proxy

If your environment requires a proxy for web API requests, configure it with:

Set-TeamViewerPSProxy -ProxyUri 'http://proxy.example.com:3128'

To remove the configured proxy:

Remove-TeamViewerPSProxy

Discover commands and help

List available TeamViewerPS commands:

Get-Command -Module TeamViewerPS

Read module help and specific command help:

Get-Help TeamViewerPS
Get-Help -Full Connect-TeamViewerApi
Get-Help -Full Get-TeamViewerUser

Documentation

For a full list of supported commands and detailed reference documentation, see:

• Docs/TeamViewerPS.md
• Docs/Help

Contributing

We welcome contributions to improve and expand TeamViewerPS.

• Fork the repository and create a feature branch.
• Open an issue first if you are unsure about the change.
• Add tests for new behavior when applicable.
• Keep code style consistent with existing PowerShell module conventions.

To run the repository tests locally:

Invoke-Pester -Path .

If you want to lint the module before submitting a pull request:

Invoke-ScriptAnalyzer -Path . -Recurse -Settings .\Linters\PSScriptAnalyzer.psd1

Please submit pull requests against the main branch.

License

Please see the file LICENSE.md.

Links

• TeamViewerPS on GitHub
• TeamViewerPS on PowerShell Gallery
• TeamViewer Web API docs
• TeamViewer company website