Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 2.17 KB

File metadata and controls

115 lines (81 loc) · 2.17 KB
external help file TeamViewerPS-help.xml
Module Name TeamViewerPS
online version https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/Remove-TeamViewerGroup.md
schema 2.0.0

Remove-TeamViewerGroup

SYNOPSIS

Delete a group from the Computers & Contacts list.

SYNTAX

Remove-TeamViewerGroup [-ApiToken] <SecureString> [-Group] <Object> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Deletes an existing group from the Computers & Contacts list. If the group is not owned, but only shared with the current user's account it will just be unshared.

EXAMPLES

Example 1

PS /> Remove-TeamViewerGroup -Group 'g1234'

PARAMETERS

-ApiToken

The TeamViewer API access token.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts 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: False

-Group

Object 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.

Type: Object
Parameter Sets: (All)
Aliases: Id, GroupId

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

-WhatIf

Shows 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: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Object

OUTPUTS

NOTES

RELATED LINKS