Reference Guide for the network CLI?

[madfordmac]

I'm just installing folding at home on a few of my systems. As I was having a little fun troubleshooting the network config for a remote FAHControl, I discovered that the network socket seems like it's actually a little CLI. I'd like to add some monitoring of F@H into my Nagios and/or Elasticsearch systems, and this seems like a potentially good way to get that data. Is there a reference guide for that interface? I tried the obvious "help" and "?" and there doesn't seem to be integrated help.

[uyaem]

Code: Select all

fahclient --help

prints a LOT of information for me, maybe that contains something you could use?

[ChristianVirtual]

You can Telnet on port 36330 and remote control quite easy that way. Might be easier to integrate in external systems.

[madfordmac]

@ChristianVirtual: Exactly, but what are the commands you can use there?

Edit: @uyaem: The help from the client doesn't seem to have info on the network protocol.

[uyaem]

Yeah, sorry, I think i read your question wrong

[ChristianVirtual]

@ChristianVirtual: Exactly, but what are the commands you can use there?

Log in there, use 127.0.0.0 for no password and then I think “help” ...
Then a list of remote commands show up.
Basically around slot configurations, parameter settings, running workunits, the basic data for visualization.

Sorry, no FAHclient running right now but just telnet in and enter “help” or “h”

The main issue you might face is that the response comes in PyON format, not 100% JSON. Therefore are minor differences (e.g. with Boolean values).

I used that in my early years to connect to a zabbix Monitoring; and added temperature recordings from CPU and GPU ... was easy to do. But that Server is on the boneyard.

[Joe_H]

There is a page on the defined API for connecting to FAHClient - https://github.com/FoldingAtHome/fah-co ... Client-API

[bruce]

FACT: Both WebControl and FAHControl use this API to gather all the information they display and to make any changes they can make to the daemon FAHClient that's running in the background.

[ChristianVirtual]

There is a page on the defined API for connecting to FAHClient - https://github.com/FoldingAtHome/fah-co ... Client-API

Nice one, was looking for the old web page. This is better place

[madfordmac]

Many thanks, @Joe_H! That is exactly what I was looking for.

There was one piece missing that I stumbled across an example to figure out and now I'm cooking with gas: If the client is configured for authentication, you must use the `auth <passphrase>` command before anything else will work, even help.

[ChristianVirtual]

now I'm cooking with gas: If the client is configured for authentication, you must use the `auth <passphrase>` command before anything else will work, even help.

In general yes, but i think via localhost you can skip; good for testing but sure later you need.