Skip to content

Latest commit

 

History

History
119 lines (82 loc) · 4.25 KB

ConnectWiseControlAPI_Functions.md

File metadata and controls

119 lines (82 loc) · 4.25 KB
Module Name ConnectWiseControlAPI
Module Guid f94fa996-0f01-4c5c-9cd9-3227728ebacb
Download Help Link https://github.com/christaylorcodes/ConnectWiseControlAPI/blob/master/ConnectWiseControlAPI_Functions.md
Help Version 0.5.0
Locale en-US

ConnectWiseControlAPI Module

Description

PowerShell commands for the ConnectWise ScreenConnect (formerly ConnectWise Control) web API. Connect-CWC signs in; Get-Help about_ConnectWiseControlAPI gives an overview.

ConnectWiseControlAPI Cmdlets

Creates the security role required by the Remote Workforce extension.

Adds a note to a session.

Uploads a file to the shared ScreenConnect Toolbox, or creates a Toolbox folder.

Connects to a ConnectWise ScreenConnect server.

Opens the ConnectWise ScreenConnect Host client joined to a session, like Join in the web UI.

Finds sessions by session filter expression, name or ID (API secret connections).

Shows the current audit settings.

Returns audit log entries for a time range.

Returns when a machine was last connected, or whether it connected recently.

DEPRECATED. Use Get-CWCRemoteWorkforceLaunchURL.

Gets a Remote Workforce host launch URL for an assigned machine.

Lists the Remote Workforce machines assigned to the calling user.

Returns the server's security configuration (user sources, roles, users).

Lists sessions of one type in a session group.

Returns the details of a session: session info, events, connections and guest screenshot.

Returns all session groups.

Lists the contents of the ScreenConnect Toolbox.

Creates or repairs the session group used by the Remote Workforce extension.

Runs a command on a session's machine and returns its output.

Sends a wake (Wake-on-LAN) request to sessions.

Gets an access token for joining a session.

Creates a new authenticator-app (TOTP) secret for a ScreenConnect user.

Assigns machines to a Remote Workforce user.

Creates a session.

Creates an internal user.

Disconnects one connection (for example a host) from a session.

Deletes sessions, optionally uninstalling the Access client first.

Removes notes from a session.

Deletes a file or folder from the shared ScreenConnect Toolbox.

Deletes an internal user.

Sends a chat message to a session's guest.

Queues a Toolbox item to run on a session.

Sets one custom property of a session.

Renames a session.

Updates an internal user.