From 62c0f5daf7fc26042e27015b643488fbca5888ed Mon Sep 17 00:00:00 2001 From: Daan Date: Wed, 27 Nov 2024 16:41:34 +0100 Subject: [PATCH] Added readme.md --- README.md | 40 +++++++++++++++++++++++++++++++++++++ meshbook/examples/ping.yaml | 13 ++---------- 2 files changed, 42 insertions(+), 11 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..57a153b --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Meshbook + +A way to programmatically manage MeshCentral-managed machines, a bit like Ansible does. + +# Example: + +```shell +python3 meshbook.py --playbook examples/ping.yaml --silent +3 +Running task: {'name': 'Ping Cloudflare', 'command': 'ping 1.1.1.1 -c 4'} +-=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=--=- +{ + "action": "msg", + "type": "runcommands", + "result": "PING 1.1.1.1 (1.1.1.1) 56(84) bytes of data.\n64 bytes from 1.1.1.1: icmp_seq=1 ttl=59 time=6.74 ms\n64 bytes from 1.1.1.1: icmp_seq=2 ttl=59 time=6.41 ms\n64 bytes from 1.1.1.1: icmp_seq=3 ttl=59 time=6.53 ms\n64 bytes from 1.1.1.1: icmp_seq=4 ttl=59 time=6.55 ms\n\n--- 1.1.1.1 ping statistics ---\n4 packets transmitted, 4 received, 0% packet loss, time 3005ms\nrtt min/avg/max/mdev = 6.412/6.555/6.736/0.116 ms\n", + "responseid": "meshctrl", + "nodeid": "" +} +1 +{ + "action": "msg", + "type": "runcommands", + "result": "PING 1.1.1.1 (1.1.1.1) 56(84) bytes of data.\n64 bytes from 1.1.1.1: icmp_seq=1 ttl=57 time=6.12 ms\n64 bytes from 1.1.1.1: icmp_seq=2 ttl=57 time=6.05 ms\n64 bytes from 1.1.1.1: icmp_seq=3 ttl=57 time=5.89 ms\n64 bytes from 1.1.1.1: icmp_seq=4 ttl=57 time=6.00 ms\n\n--- 1.1.1.1 ping statistics ---\n4 packets transmitted, 4 received, 0% packet loss, time 3004ms\nrtt min/avg/max/mdev = 5.887/6.013/6.119/0.084 ms\n", + "responseid": "meshctrl", + "nodeid": "" +} +2 +{ + "action": "msg", + "type": "runcommands", + "result": "PING 1.1.1.1 (1.1.1.1) 56(84) bytes of data.\n64 bytes from 1.1.1.1: icmp_seq=1 ttl=59 time=7.11 ms\n64 bytes from 1.1.1.1: icmp_seq=2 ttl=59 time=6.51 ms\n64 bytes from 1.1.1.1: icmp_seq=3 ttl=59 time=6.55 ms\n64 bytes from 1.1.1.1: icmp_seq=4 ttl=59 time=6.51 ms\n\n--- 1.1.1.1 ping statistics ---\n4 packets transmitted, 4 received, 0% packet loss, time 3004ms\nrtt min/avg/max/mdev = 6.508/6.670/7.113/0.255 ms\n", + "responseid": "meshctrl", + "nodeid": "" +} +0 +``` + +# P.S.: + +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 diff --git a/meshbook/examples/ping.yaml b/meshbook/examples/ping.yaml index a493407..bc6a11f 100644 --- a/meshbook/examples/ping.yaml +++ b/meshbook/examples/ping.yaml @@ -2,14 +2,5 @@ name: Ping Multiple Points company: Temp-Agents tasks: - - name: Ping CloudFlare - command: "ping 1.1.1.1 -c 4" - - - name: ping Googoogle - command: "ping 8.8.8.8 -c 4" - - - name: ping Systemec - command: "ping ns.systemec.nl -c 4" - - - name: ping quad9 - command: "ping 9.9.9.9 -c 4" \ No newline at end of file + - name: Ping Cloudflare + command: "ping 1.1.1.1 -c 4" \ No newline at end of file