Skip to content

Latest commit

 

History

History
131 lines (98 loc) · 2.57 KB

Add-CWCSessionNote.md

File metadata and controls

131 lines (98 loc) · 2.57 KB
external help file ConnectWiseControlAPI-help.xml
Module Name ConnectWiseControlAPI
online version https://github.com/christaylorcodes/ConnectWiseControlAPI
schema 2.0.0

Add-CWCSessionNote

SYNOPSIS

Adds a note to a session.

SYNTAX

Add-CWCSessionNote [-GUID] <Guid> [-Note] <String> [[-Group] <String[]>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Queues an AddedNote session event.

Credentials connections: PageService.AddSessionEvents. The note is attributed to the connected user and needs the AddNote permission in -Group.

API secret connections: the RESTful API Manager extension's AddNoteToSession. The note is attributed to the extension's RESTfulUserName setting ("RESTful API" by default); -Group is ignored.

EXAMPLES

EXAMPLE 1

Add-CWCSessionNote -GUID $SessionID -Note 'Rebooted for patching'

PARAMETERS

-GUID

Session ID.

Type: Guid
Parameter Sets: (All)
Aliases: SessionID

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

-Note

Note text.

Type: String
Parameter Sets: (All)
Aliases:

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

-Group

Session group containing the session (credentials connections only). Defaults to 'All Machines'.

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

Required: False
Position: 3
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

Author: Chris Taylor

RELATED LINKS

https://github.com/christaylorcodes/ConnectWiseControlAPI