Skip to content

Set-TeamViewerGroup.md

Latest commit

 

History

History
189 lines (133 loc) · 3.54 KB

Set-TeamViewerGroup.md

File metadata and controls

189 lines (133 loc) · 3.54 KB
Raw

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

Set-TeamViewerGroup

SYNOPSIS

Change a group in the Computers & Contacts list.

SYNTAX

ByParameters (Default)

Set-TeamViewerGroup -APIToken <SecureString> -Group <Object> [-Name <String>] [-Policy <Object>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

ByProperties

Set-TeamViewerGroup -APIToken <SecureString> -Group <Object> -Property <Hashtable> [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Changes a group in the Computers & Contacts list.

EXAMPLES

Example 1

Set-TeamViewerGroup -Group 'g1234' -Name 'New Group Name'

Change the name of the group with the given group Id.

Example 2

Set-TeamViewerGroup -Group 'g1234' -Policy '730ee15a-1ea4-4d80-9cfe-5a01709d0a2f'

Assign the given policy to the group with the given group Id.

Example 3

Set-TeamViewerGroup -Group 'g1234' -Property @{ name = 'New Group Name'; policy_id = '730ee15a-1ea4-4d80-9cfe-5a01709d0a2f' }

Change the name and policy of the group with the given group Id using property parameters.

PARAMETERS

-APIToken

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: 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: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

The new name of the group.

Type: String
Parameter Sets: ByParameters
Aliases:

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

-Policy

Change the policy assigned to the group and assign it to the given policy.

Type: Object
Parameter Sets: ByParameters
Aliases: PolicyId

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

-Property

Change group information using a hashtable object. Valid hashtable keys are: name, policy_id

Type: Hashtable
Parameter Sets: ByProperties
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
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