Skip to content

Get-TeamViewerDeviceCustomField.md

Latest commit

 

History

History
75 lines (48 loc) · 1.67 KB

Get-TeamViewerDeviceCustomField.md

File metadata and controls

75 lines (48 loc) · 1.67 KB
Raw

external help file: TeamViewerPS-help.xml Module Name: TeamViewerPS online version: https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/Get-TeamViewerDeviceCustomField.md schema: 2.0.0

Get-TeamViewerDeviceCustomField

SYNOPSIS

Retrieves the custom field values set for a managed device.

SYNTAX

Get-TeamViewerDeviceCustomField [-APIToken] <SecureString> [-ManagedDeviceId] <Object> [<CommonParameters>]

DESCRIPTION

Retrieves all custom field values associated with a specific managed device. These are the values assigned to the custom field definitions, not the definitions themselves.

PARAMETERS

-APIToken

The TeamViewer API access token.

Type: SecureString
Required: True

-ManagedDeviceId

The unique identifier of the managed device. Can be a device Id string or a TeamViewerPS.ManagedDevice object.

Type: Object
Aliases: ManagedDevice, Device, DeviceId
Required: True

EXAMPLES

Example 1

Get-TeamViewerDeviceCustomField -APIToken $apiToken -ManagedDeviceId 'd12345678'

Retrieves all custom field values for the specified managed device.

Example 2

$device | Get-TeamViewerDeviceCustomField -APIToken $apiToken

Retrieves custom field values by piping a managed device object.

Example 3

Get-TeamViewerManagedDevice -APIToken $apiToken | Get-TeamViewerDeviceCustomField -APIToken $apiToken

Retrieves the custom field values for every managed device by piping the results of Get-TeamViewerManagedDevice.

OUTPUTS

TeamViewerPS.DeviceCustomField

Returns device custom field value objects containing the field key Id and value.