| external help file | Module Name | online version | schema |
|---|---|---|---|
TeamViewerPS-help.xml |
TeamViewerPS |
2.0.0 |
Change a device entry in the Computers & Contacts list.
Set-TeamViewerDevice -ApiToken <SecureString> -Device <Object> [-Name <String>] [-Description <String>]
[-Password <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>]Set-TeamViewerDevice -ApiToken <SecureString> -Device <Object> [-Group <Object>] [-Name <String>]
[-Description <String>] [-Password <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>]Set-TeamViewerDevice -ApiToken <SecureString> -Device <Object> [-Policy <Object>] [-Name <String>]
[-Description <String>] [-Password <SecureString>] [-WhatIf] [-Confirm] [<CommonParameters>]Changes an existing device entry in the Computers & Contacts list.
PS /> Set-TeamViewerDevice -DeviceId 'd1234' -Name 'My Updated Device Alias'Change the device entry alias in the Computers & Contacts list.
PS /> Set-TeamViewerDevice -DeviceId 'd1234' -GroupId 'g5678'Move the device entry to a different group in the Computers & Contacts list.
PS /> Set-TeamViewerDevice -DeviceId 'd1234' -Policy 'inherit'Set the policy of the device entry to inherit from group.
The TeamViewer API access token.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOptional descriptive text for the device entry.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseObject that can be used to identify the device entry. This can either be the device ID or a device object that has been received using other module functions.
Type: Object
Parameter Sets: (All)
Aliases: Id, DeviceId
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseObject that can be used to identify the group. This can either be the group ID or a group object that has been received using other module functions.
Cannot be used in conjunction with the -Policy parameter.
Type: Object
Parameter Sets: ChangeGroup
Aliases: GroupId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOptional alias of the device in the Computers & Contacts list of this account.
Type: String
Parameter Sets: (All)
Aliases: Alias
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOptional password that will be used when connecting to the device with the TeamViewer desktop client.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseObject that can be used to identify the policy. This can either be the policy ID (as string or GUID) or a policy object that has been received using other module functions.
Cannot be used in conjunction with the -Group parameter.
Type: Object
Parameter Sets: ChangePolicy
Aliases: PolicyId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.