Skip to content

New-CWCRemoteWorkforceAssignment.md

Latest commit

 

History

History
142 lines (108 loc) · 2.81 KB

New-CWCRemoteWorkforceAssignment.md

File metadata and controls

142 lines (108 loc) · 2.81 KB
Raw
external help file ConnectWiseControlAPI-help.xml
Module Name ConnectWiseControlAPI
online version https://github.com/christaylorcodes/ConnectWiseControlAPI
schema 2.0.0

New-CWCRemoteWorkforceAssignment

SYNOPSIS

Assigns machines to a Remote Workforce user.

SYNTAX

New-CWCRemoteWorkforceAssignment [-GUID] <Guid[]> [-Username] <String> [[-DisplayName] <String>]
 [[-Group] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Calls the Remote Workforce extension's AddAssignmentNoteToSession, which adds an assignment note (AddedNote) to each session. The user can then launch the machine from the Remote Workforce page.

EXAMPLES

EXAMPLE 1

New-CWCRemoteWorkforceAssignment -GUID $SessionID -Username 'jdoe' -DisplayName 'Jane Doe'

PARAMETERS

-GUID

One or more session IDs.

Type: Guid[]
Parameter Sets: (All)
Aliases:

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

-Username

ScreenConnect user name of the assignee.

Type: String
Parameter Sets: (All)
Aliases:

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

-DisplayName

Display name of the assignee.

Type: String
Parameter Sets: (All)
Aliases:

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

-Group

Session group containing the sessions: a name, or the path parts of a nested group. Defaults to 'All Machines'.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: All Machines
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

-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

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

OUTPUTS

NOTES

Requires Connect-CWC -Credentials and the Remote Workforce extension. Author: Chris Taylor

RELATED LINKS

https://github.com/christaylorcodes/ConnectWiseControlAPI