Remove-TeamViewerDeviceCustomField.md

---

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

Remove-TeamViewerDeviceCustomField

SYNOPSIS

Deletes a custom field value from a managed device.

SYNTAX

Remove-TeamViewerDeviceCustomField [-APIToken] <SecureString> [-ManagedDeviceId] <Object> [-FieldConfigurationId] <Guid> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Removes a custom field value from a specific managed device. The custom field definition remains intact and can be reassigned with a new value.

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: Id, ManagedDevice, Device, DeviceId
Required: True

-FieldConfigurationId

The unique identifier of the custom field definition (FieldKeyId).

Type: Guid
Aliases: FieldKeyId
Required: True

EXAMPLES

Example 1

Remove-TeamViewerDeviceCustomField -APIToken $apiToken -ManagedDeviceId 'd12345678' -FieldConfigurationId '00000000-0000-0000-0000-000000000001'

Removes the custom field value from the specified managed device.

Example 2

Remove-TeamViewerDeviceCustomField -Device 'd12345678' -FieldKeyId 'c0cb303a-8a85-4e54-b657-a4757c791aef'

Removes the custom field value using the Device and FieldKeyId aliases.

Example 3

$device = Get-TeamViewerManagedDevice -Name 'Server01'

Remove-TeamViewerDeviceCustomField -ManagedDevice $device -FieldConfigurationId '730ee15a-1ea4-4d80-9cfe-5a01709d0a2f'

Removes the custom field value from a managed device object retrieved with Get-TeamViewerManagedDevice.

OUTPUTS

None

This cmdlet does not return output.