| external help file | Module Name | online version | schema |
|---|---|---|---|
TeamViewerPS-help.xml |
TeamViewerPS |
2.0.0 |
Returns the devices of the current account's Computers & Contacts list.
Get-TeamViewerDevice -ApiToken <SecureString> [-TeamViewerId <Int32>] [-FilterOnlineState <String>]
[-Group <Object>] [<CommonParameters>]Get-TeamViewerDevice -ApiToken <SecureString> [-Id <String>] [<CommonParameters>]Returns a list of contacts in the user's Computers & Contacts list that match the criteria given in the parameters.
PS /> Get-TeamViewerDeviceList all devices of the Computers & Contacts list.
PS /> Get-TeamViewerDevice -Id 'd1234'Get the device entry with the given ID.
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: FalseOptional filter for devices in a certain online state.
Type: String
Parameter Sets: FilteredList
Aliases:
Accepted values: Online, Busy, Away, Offline
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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. If given, the command only returns device entries that are part of that group.
Type: Object
Parameter Sets: FilteredList
Aliases: GroupId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDevice identifier used to get only a single specific device list entry.
Type: String
Parameter Sets: ByDeviceId
Aliases: DeviceId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOptional return only the device that has the given TeamViewer Remote control ID.
Type: Int32
Parameter Sets: FilteredList
Aliases:
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.