Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryanblenis/MeshCentral-ScriptTask
Scripting plugin for MeshCentral
https://github.com/ryanblenis/MeshCentral-ScriptTask
meshcentral meshcentral-plugin
Last synced: 9 days ago
JSON representation
Scripting plugin for MeshCentral
- Host: GitHub
- URL: https://github.com/ryanblenis/MeshCentral-ScriptTask
- Owner: ryanblenis
- License: apache-2.0
- Created: 2019-12-16T23:27:40.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-08T01:24:44.000Z (9 months ago)
- Last Synced: 2024-08-02T15:30:44.900Z (3 months ago)
- Topics: meshcentral, meshcentral-plugin
- Language: JavaScript
- Size: 61.5 KB
- Stars: 52
- Watchers: 9
- Forks: 14
- Open Issues: 25
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# MeshCentral-ScriptTask
A script running plugin for the [MeshCentral2](https://github.com/Ylianst/MeshCentral) Project. The plugin supports PowerShell, BAT, and Bash scripts. Windows, MacOS, and Linux endpoints are all supported. PowerShell can be run on any OS that has PowerShell installed, not just Windows.
## Important Note
**This plugin now supports NeDB and MongoDB**
## Installation
Pre-requisite: First, make sure you have plugins enabled for your MeshCentral installation:
> "plugins": {
> "enabled": true
> },
Restart your MeshCentral server after making this change.
To install, simply add the plugin configuration URL when prompted:
`https://raw.githubusercontent.com/ryanblenis/MeshCentral-ScriptTask/master/config.json`
## Features
- Add scripts to a central store
- Run scripts on single or multiple endpoints simultaneously
-- Supports PowerShell, BAT, and Bash scripts
- Review the return status / value of completed scripts
-- Returns text or parses returned JSON for easy viewing
- Schedule scripts for future runs on either a one-time or interval basis (minutes, hourly, daily, weekly)
- View schedules and histories based on either node (endpoint) or script
- Dead job detection with script replay
## Usage Notes
- *Run* schedules and runs the job instantly.
- *Schedule* puts the events into a queue.
- Queues are checked / run every minute.
- Scheduled jobs only show the *next* scheduled job at any given time.
- History is limited to 200 events per node/script in the viewport.
- Historical events that have completed will delete after 90 days.
- Jobs only run when the endpoint agent is online. They do *not* queue to the agent when offline, then run at the specified time.
- Scripts are cached on the clients and verified via hash at runtime for the latest version.
## Variables
- Variables can be assigned to the following scopes: Global, Script, Mesh, and Node
- Variables with the same name will override each other in the above order (ex. Global variable testVariable will be overridden by Script variable testVariable will be overridden by Mesh variable Test will be overridden by Node variable testVariable if they exist and apply to the node running the script)
- Variables found in a script which do not correspond with a defined variable will be replaced with VAR_NOT_FOUND
- Variables are assigned during job dispatch (e.g. when the job is sent to the node), so the latest script and variable values will be accounted for, should they have changed since a job or scheduled job were defined.
- Variables in scripts must be defined by hashtags on both sides and not contain spaces. (E.g. #myVar#)
## Getting Started
Drag and drop some of your favorite admin scripts on the file tree. You'll then be able to run them immediately on endpoints (nodes).
## Upcoming Features
- Take action on the results of a script
- Variable replacement
## Other Information
This is fairly new and in beta. Testing was mostly done in the latest Chrome and Firefox. No attempt was made to be compatible with older IE browsers. Endpoint testing was done on Windows 10 (1903) and OS X 10.13.
## Screenshots
