Skip to content

Commit

Permalink
Text adaptions and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristianJ-TV committed Jan 27, 2025
1 parent a0365a7 commit 4ba39d0
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 11 deletions.
24 changes: 16 additions & 8 deletions Docs/Help/Add-TeamViewerAssignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ schema: 2.0.0

## SYNOPSIS

Assigns the device to a company.
Assigns the local device to a TeamViewer company.

## SYNTAX

Expand All @@ -19,21 +19,29 @@ Add-TeamViewerAssignment [-AssignmentId] [-DeviceAlias] [-Retries]

## DESCRIPTION

Assigns the particular device to a company listed in managed devices.
Assignment ID can be obtained from Management console under Design & Deploy.
Assigns the local / current device to a TeamViewer company where it's listed in "managed devices".
The Assignment Id can be obtained from the Management Console (MCO) under Design & Deploy.

## EXAMPLES

### Example 1

```powershell
PS /> Add-TeamViewerAssignment -AssignmentId '0001CoABChCiJnyAKf0R7r6'
PS /> Add-TeamViewerAssignment -AssignmentId '0001CoABChCiJnyAKf0R7r6' -DeviceAlias 'Test Device 1'
PS /> Add-TeamViewerAssignment -AssignmentId '0001CoABChD3RCXwL6IR7pS' -DeviceAlias 'Test Device 2' -Retries 3
Add-TeamViewerAssignment -AssignmentId '0001CoABChCiJnyAKf0R7r6'
```

Assigns the devices with default Hostname or with names `Test Device 1` and `Test Device 2` to a Company with the given assignment id.
Assigns the local device with default alias (hostname of device) to the TeamViewer company corresponding to the Assignment Id.

### Example 2

```powershell
Add-TeamViewerAssignment -AssignmentId '0001CoABChD3RCXwL6IR7pS' -DeviceAlias 'My Test Device' -Retries 3
```

Assigns the local device with alias "My Test Device" to the corresponding TeamViewer company.
Three assignment retries are done.

## PARAMETERS

Expand Down Expand Up @@ -71,7 +79,7 @@ Accept wildcard characters: False
### -Retries
The assignment is retried in case of temporary errors. There is a waiting time of 1 second between each try.
The assignment is retried in case of temporary connection errors. There is a waiting time of 1 second between each try.
```yaml
Type: int
Expand Down
6 changes: 3 additions & 3 deletions Docs/Help/Add-TeamViewerCustomization.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ schema: 2.0.0

## SYNOPSIS

Customizes a TeamViewer Installation.
Adds a customization (custom module) to the local TeamViewer client.

## SYNTAX

```powershell
Add-TeamViewerCustomization [[-Id] || [-Path]] [-RestartGUI][-RemoveExisting]
Add-TeamViewerCustomization [[-Id] || [-Path]] [-RestartGUI] [-RemoveExisting]
```

## DESCRIPTION

Customizes a TeamViewer Installation and includes assignment of the particular device to a company if included.
Adds a customization (custom module) to the local TeamViewer client..
Customization can be perfomed in Management console under Design & Deploy.

## EXAMPLES
Expand Down
8 changes: 8 additions & 0 deletions Docs/Help/Invoke-TeamViewerPackageDownload.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ PS /> Invoke-TeamViewerPackageDownload
PS C:\> Invoke-TeamViewerPackageDownload -PackageType QuickSupport
```

### Example 3

```powershell
PS C:\> Invoke-TeamViewerPackageDownload -PackageType MSI64 -TargetDirectory (Join-Path -Path $env:UserProfile -ChildPath "Downloads")
```

Downloads the MSI for 64-bit architecture and stores the file in the downloads folder of the current user.

## PARAMETERS

### -Force
Expand Down

0 comments on commit 4ba39d0

Please sign in to comment.