diff --git a/README.md b/README.md index 57a153b..63be43b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,46 @@ # Meshbook -A way to programmatically manage MeshCentral-managed machines, a bit like Ansible does. +A way to programmatically manage MeshCentral-managed machines, a bit like Ansible does.
+What problem does it solve? Well, what I wanted to be able to do is to automate system updates through [MeshCentral](https://github.com/ylianst/meshcentral).
+And many people will be comfortable with YAML configurations! It's almost like JSON, but different!
+ +# Quick-start: + +The quickest way to start is to grab a template from the templates folder in this repository.
+Make sure to correctly pass the MeshCentral websocket API as `wss:///control.ashx`.
+And make sure to fill in the credentails of an account which has remote commands permissions.
+Then make a yaml with a target and some commands! See below examples as a guideline. And do not forget to look at the bottom's notice. # Example: +For the example, I used the following yaml file: + +```yaml +--- +name: Ping a single Point +company: Temp-Agents +tasks: + - name: Ping Cloudflare + command: "ping 1.1.1.1 -c 4" +``` + +The above group: `Temp-Agents` has four devices, of which one is offline.
+You can expand the command chain as follows:
+ +```yaml +--- +name: Ping Multiple Points +company: Temp-Agents +tasks: + - name: Ping Cloudflare + command: "ping 1.1.1.1 -c 4" + + - name: Ping Google + command: "ping 8.8.8.8 -c 4" +``` + +The following response it received when executing the first yaml of the above files. + ```shell python3 meshbook.py --playbook examples/ping.yaml --silent 3 @@ -34,7 +71,17 @@ Running task: {'name': 'Ping Cloudflare', 'command': 'ping 1.1.1.1 -c 4'} } 0 ``` +Please ignore the module output in the example, I will remove that in a later version. -# P.S.: +# Important Notice: -If you want to use this, make sure to use NON-BLOCKING commands. MeshCentral does not work if you send it commands that wait. \ No newline at end of file +If you want to use this, make sure to use `NON-BLOCKING` commands. MeshCentral does not work if you send it commands that wait.
+A couple examples of `BLOCKING COMMANDS` which will never get back to the main MeshCentral server: + +```shell +apt upgrade # without -y. + +sleep infinity + +ping 1.1.1.1 # without a -c flag (because it pings forever). +``` \ No newline at end of file