Skip to content

Set-TeamViewerDeviceCustomFieldConfiguration.md

Latest commit

 

History

History
120 lines (83 loc) · 2.38 KB

Set-TeamViewerDeviceCustomFieldConfiguration.md

File metadata and controls

120 lines (83 loc) · 2.38 KB
Raw

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

Set-TeamViewerDeviceCustomFieldConfiguration

SYNOPSIS

Updates a device custom field definition.

SYNTAX

Set-TeamViewerDeviceCustomFieldConfiguration [-APIToken] <SecureString> [-Id] <Guid> [-FieldKey] <String> [[-Description] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates an existing company-level device custom field definition.

PARAMETERS

-APIToken

The TeamViewer API access token.

Type: SecureString
Parameter Sets: (All)
Aliases: None

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

The unique identifier of the custom field definition. Alias: FieldKeyId.

Type: Guid
Parameter Sets: (All)
Aliases: FieldKeyId

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FieldKey

The name of the custom field.

Type: String
Parameter Sets: (All)
Aliases: None

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

An optional description of the custom field.

Type: String
Parameter Sets: (All)
Aliases: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

EXAMPLES

Example 1

Set-TeamViewerDeviceCustomFieldConfiguration -APIToken $apiToken -Id $fieldId -FieldKey 'AssetTag'

Updates the custom field identified by $fieldId and sets its key to AssetTag.

Example 2

Set-TeamViewerDeviceCustomFieldConfiguration -Id 'c0cb303a-8a85-4e54-b657-a4757c791aef' -FieldKey 'AssetTag' -Description 'Inventory asset tag number'

Updates the custom field key and sets a description in a single call.

Example 3

Set-TeamViewerDeviceCustomFieldConfiguration -FieldKeyId 'c0cb303a-8a85-4e54-b657-a4757c791aef' -FieldKey 'Location' -Description ''

Uses the FieldKeyId alias to rename the field to Location and clears its description.

OUTPUTS

TeamViewerPS.DeviceCustomFieldConfiguration

Returns the updated device custom field definition.