View source for Plugin:exec-solusvm-bandwidth.sh

{{Infobox Plugin
  | Name=collectd-solusvm-bw.sh
  | Type=read
  | Callbacks=''n/a''
  | Status=external
  | FirstVersion=''n/a''
  | Copyright=''2016'' Fredrik Lundhag
  | License={{MIT License}}
  | Manpage=''n/a''
}}

'''[https://gist.github.com/joltcan/718653fe18cf431612895b7c5a86f74b#file-collectd-solusvm-bw-sh collectd-solusvm-bw.sh]''' is a shell script which read bandwidth statistics from ''SolusVM'', a common platform for VPS providers. The script requires the {{Plugin|Exec}}, [http://curl.haxx.se/ curl] and grep with -P ''(--perl-regexp'' support) to run and was written by ''Fredrik Lundhag''.

== Synopsis ==

To use this script, do the following:
* Download or copy the gist [https://gist.github.com/joltcan/718653fe18cf431612895b7c5a86f74b#file-collectd-solusvm-bw-sh collectd-solusvm-bw.sh] from GitHub into /etc/collectd.
* Enable API in the VPS SolusVM control panel, then copy your API key + hash and put them into the script together with the path to the API.
* I recommend you to run the script manually first to make sure that the output looks correct and that the API URL works.
* Add the section below the configuration of the {{Plugin|Exec}}:

 LoadPlugin exec
 <Plugin exec>
     Exec <user>[:group] "/etc/collectd/collectd-solusvm-bw.sh" 
 </Plugin>

== Example graphs ==

[[File:Collectd-Solus-bw.png]]

== Dependencies ==

* [[Plugin:Exec]]
* Bash
* grep (with -P, --perl-regexp support)
* [https://curl.haxx.se/ curl]

== See also ==

* [https://documentation.solusvm.com/display/DOCS/Functions SolusVM documentation]

[[Category:Plugins]]
[[Category:Exec Plugins]]
{{DEFAULTSORT:collectd-solus-bw.sh}}