From 93f4d89b7de324e9aba0c6ad70afbdd2c7d25ac1 Mon Sep 17 00:00:00 2001 From: Tim Moore Date: Mon, 21 Aug 2017 12:27:56 -0400 Subject: [PATCH 1/3] Remove (Coming Soon) from SysAdm issues tracker --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a5a7b5..61ae93a 100644 --- a/README.md +++ b/README.md @@ -162,7 +162,7 @@ Due to the number of repositories under the TrueOS "umbrella", the TrueOS Projec * [trueos-core](https://github.com/trueos/trueos-core) : Used for general TrueOS issues, Pico issues, and feature requests. * [lumina](https://github.com/trueos/lumina) : Issues related to using the Lumina Desktop Environment. -* (Coming Soon) [sysadm](https://github.com/trueos/sysadm) : Issues with using the SysAdm client or server. +* [sysadm](https://github.com/trueos/sysadm) : Issues with using the SysAdm client or server. * [trueos-docs](https://github.com/trueos/trueos-docs) : Issues related to the TrueOS Handbook. * [lumina-docs](https://github.com/trueos/lumina-docs) : Issues related to the Lumina Handbook. * [sysadm-docs](https://github.com/trueos/sysadm-docs) : Issues related to the SysAdm API Guide, Client, and Server Handbooks. From cf5b11a53930271db298827d7ee21b25c1a1f29d Mon Sep 17 00:00:00 2001 From: ZackaryWelch Date: Thu, 24 Aug 2017 11:26:23 -0400 Subject: [PATCH 2/3] Added a man page for the sysadm cli client --- src/sysadm.8 | 197 ++++++++++++++++++++++++++++++++++++++++++++++++ src/sysadm.8.gz | Bin 0 -> 1726 bytes src/sysadm.pro | 3 + 3 files changed, 200 insertions(+) create mode 100644 src/sysadm.8 create mode 100644 src/sysadm.8.gz diff --git a/src/sysadm.8 b/src/sysadm.8 new file mode 100644 index 0000000..4ca0c13 --- /dev/null +++ b/src/sysadm.8 @@ -0,0 +1,197 @@ +.Dd August 23, 2017 +.Dt SYSADM 8 +.Os SysAdm Client +.Sh NAME +.Nm sysadm +.Nd Command line client to interact with a SysAdm server +.Sh SYNOPSIS +.Nm +.Op Fl u Ao username Ac +.Op Fl p Ao password Ac +.Op Fl ip Ao ip address Ac +.Op Fl id Ao request identifier Ac +.Fl n +.Ao name Ac +.Fl ns +.Ao namespace Ac +.Fl a +.Ao JSON Arguments Ac +.Nm +.Op Fl u Ao username Ac +.Op Fl p Ao password Ac +.Op Fl ip Ao ip address Ac +.Fl f +.Ao filename Ac +.Nm +.Op Fl u Ao username Ac +.Op Fl p Ao password Ac +.Op Fl ip Ao ip address Ac +.Fl s +.Sh DESCRIPTION +The +.Nm +client utility communicates with the +.Nm +api through WebSocket +requests in order to retrieve information about a system and other +services. +.Sh OPTIONS +The +.Nm +client supports these options: +.Bp +.Bl -tag -width indent +.It Fl n +The +.Em name +is the specific class or service the request tries to access. +It is required as part of any request. +See the SysAdm API Reference Guide for a complete listing of names. +.Pp +Example: +.Dl sysadm -n firewall -ns sysadm -a '{"action":"known_ports"}' +.It Fl ns +The +.Em namespace +is the general organization associated with the request. +It is also required as part of any request. +Most requests are part of the sysadm namespace. +See the SysAdm API Reference Guide for a complete listing of possible +namespaces. +.Pp +Example: +.Dl sysadm -n dispatcher -ns rpc -a '{"action":"list"}' +.It Fl id +The request identifier. +If not supplied than it is set to the number representing the order the +requests are sent, starting with 0. +Replies are only recieved from an id matching the id of a sent request. +.It Fl ip +IP address of the SysAdm server. +The default is 127.0.0.1. +If different from localhost, then a username and password is required. +A SysAdm server must be running from the specified ip for a request to be sent. +.It Fl u +Username for the server. +If not provided, the default is the current user on the system. +The user must be registered with the SysAdm server for a request to be sent. +.It Fl p +Password to connect to the server. +This is not required when connecting to a local host. +.Pp +.It Fl s +Read full JSON from another process in the command line. +This is used in conjunction with another command to recieve the request. +.Pp +Example: +.Dl cat jsonFile | sysadm -s +.It Fl f +Read full JSON from a file. +The file can connect a single WebSocket request or a JSON array. +.Pp +Example: +.Dl sysadm -f jsonfile +.It Fl a +Arguments for the request are received from the command line. +Always used together with -n, -ns, and -id. +This is used for quick, single request instances. +.Pp +Example: +.Dl sysadm -u admin -p password -ip 142.37.213.52 -n moused +.Dl -ns sysadm -id klank -a '{"action":"list_devices"}' +.El +.Sh EXAMPLES +This is an example of a WebSocket Request. It can be sent through the command +line with -s or put into a file and read with -f. The order the parameters are +listed does not matter: +.Pp +.Bd -literal +{ + "id" : "fooid", + "namespace" : "sysadm", + "name" : "moused", + "args" : { + "action" : "list_devices" + } +} +.Ed +.Pp +If multiple requests are desired, then they must be placed in an array: +.Pp +.Bd -literal +[ { + "args" : { + "action" : "listcron" + }, + "name" : "lifepreserver", + "namespace" : "sysadm", + "id" : "fooid" +}, +{ + "id" : "fooid", + "args" : { + "action" : "memorystats" + }, + "namespace" : "sysadm", + "name" : "systemmanager" +} ] +.Ed +.Pp +If the above array was sent, then the following response would return: +.Pp +.Bd -literal +{ + "args": { + "listcron": { + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" +} + +{ + "args": { + "memorystats": { + "active": "256", + "cache": "0", + "free": "2193", + "inactive": "2061", + "wired": "3168" + } + }, + "id": "fooid", + "name": "response", + "namespace": "sysadm" +} +.Ed +.Pp +Here is a detailed request with the corresponding WebSocket response: +.Bd -literal +% sysadm -u zwelch -p password -ip 127.0.0.1 -id 72 -n systemmanager -ns sysadm +-a '{"action":"cputemps"}' +{ + "args": { + "cputemps": { + "acpithermal": "29.9C", + "cpu0": "42.0C", + "cpu1": "40.0C", + "cpu2": "40.0C", + "cpu3": "41.0C" + } + }, + "id": "72", + "name": "response", + "namespace": "sysadm" +} +.Ed +.Sh SEE ALSO +.Xr sysadm-server(8) +.Pp +See +.Em https://api.sysadm.us +for details on formatting WebSocket requests and a list of +possible names and namespaces. +.Sh AUTHOR +.An Zackary Welch +.Aq welch.zackary@gmail.com diff --git a/src/sysadm.8.gz b/src/sysadm.8.gz new file mode 100644 index 0000000000000000000000000000000000000000..78db6a10ed16f2c8312211634b94fc6388452201 GIT binary patch literal 1726 zcmV;v20{5BiwFo%3a$~QaMx6X+G%y8Ae>uQ z%350^~HLuML`002qJ)xT`|d3e)6k zZ5CvS+Yw-#Rmt=pNqVGtShO=Jb_|-usiiECwee9b#iP#y3?OhB91O0FU7Gg{+2HO` z#KNzE!A;*GvQP#CTmXuNH2PCpH1BPu(F}QPhEEemS?~2_p^|9uVLWq$dpPQxaNI&R00jlKp0ty;@^*w!qcyDP$WZtikkLsl#crCMEAkPJSW^((8O>cT=FZZH z5h<3GS!W;LsWNPERh%xXDmglf%+Z!+jmJ|?J6Chr6r9p%yr1skXT*u;dd?-Pga5*2 zvbaLwhhz!Ov|=)v{zzZFiAs~nx<^sc&bkEFjWLu3TkcITk_Fv`UWj9B=?Tg)=GG){ zI^T4b4YVn>6|0=RK_PPvwx1(?%^JsfQ38OvYg!OlfQ02SRJB06DAymF^`yQUZk3#M z=s=rUV^kKKXH^SChkq1(9Ka$&Su9@Fr&{cXmDO5{pb^KoaI*zH2bzB}%qatwwMM zGc@{nobK(XSPMHU1s>EIfgq`yn<0BO$gfU-)klde{!4_hEto>-tIT>QC>tW*_?~98@Q{2rx+x$l)l}+9j2JSqOeP1S7ck^9*Rb^O+o!u zH_mLqHAEkhS=C$g;OtB9_!H+7Fj;T3HWdgv_kDRtew91g=F9H;5cU-j>KisSe)6<+ z5tW(5eTj6to0_>(;i1vsU=t= zk4zdjcV=C%np4618zi_oSg-UCJ)ZrvR7G}mpJ=;F6LaZ4bM0DB_UJa*AlVEwr^<>6 z_KQ`Ghqjco(zIquS#SxSr_W#Bt8CTmk`n7+cbjs=%H8eC@k7czR*p#dU}^Wq-%?ll zuZHPVOkU4Ulk}}?f!qnS^y9Oixbk?v;Mbt5x~}}e Date: Thu, 24 Aug 2017 13:21:10 -0400 Subject: [PATCH 3/3] Moved the SysAdm client manpage to the client repo --- src/sysadm.8 | 197 ------------------------------------------------ src/sysadm.8.gz | Bin 1726 -> 0 bytes src/sysadm.pro | 3 - 3 files changed, 200 deletions(-) delete mode 100644 src/sysadm.8 delete mode 100644 src/sysadm.8.gz diff --git a/src/sysadm.8 b/src/sysadm.8 deleted file mode 100644 index 4ca0c13..0000000 --- a/src/sysadm.8 +++ /dev/null @@ -1,197 +0,0 @@ -.Dd August 23, 2017 -.Dt SYSADM 8 -.Os SysAdm Client -.Sh NAME -.Nm sysadm -.Nd Command line client to interact with a SysAdm server -.Sh SYNOPSIS -.Nm -.Op Fl u Ao username Ac -.Op Fl p Ao password Ac -.Op Fl ip Ao ip address Ac -.Op Fl id Ao request identifier Ac -.Fl n -.Ao name Ac -.Fl ns -.Ao namespace Ac -.Fl a -.Ao JSON Arguments Ac -.Nm -.Op Fl u Ao username Ac -.Op Fl p Ao password Ac -.Op Fl ip Ao ip address Ac -.Fl f -.Ao filename Ac -.Nm -.Op Fl u Ao username Ac -.Op Fl p Ao password Ac -.Op Fl ip Ao ip address Ac -.Fl s -.Sh DESCRIPTION -The -.Nm -client utility communicates with the -.Nm -api through WebSocket -requests in order to retrieve information about a system and other -services. -.Sh OPTIONS -The -.Nm -client supports these options: -.Bp -.Bl -tag -width indent -.It Fl n -The -.Em name -is the specific class or service the request tries to access. -It is required as part of any request. -See the SysAdm API Reference Guide for a complete listing of names. -.Pp -Example: -.Dl sysadm -n firewall -ns sysadm -a '{"action":"known_ports"}' -.It Fl ns -The -.Em namespace -is the general organization associated with the request. -It is also required as part of any request. -Most requests are part of the sysadm namespace. -See the SysAdm API Reference Guide for a complete listing of possible -namespaces. -.Pp -Example: -.Dl sysadm -n dispatcher -ns rpc -a '{"action":"list"}' -.It Fl id -The request identifier. -If not supplied than it is set to the number representing the order the -requests are sent, starting with 0. -Replies are only recieved from an id matching the id of a sent request. -.It Fl ip -IP address of the SysAdm server. -The default is 127.0.0.1. -If different from localhost, then a username and password is required. -A SysAdm server must be running from the specified ip for a request to be sent. -.It Fl u -Username for the server. -If not provided, the default is the current user on the system. -The user must be registered with the SysAdm server for a request to be sent. -.It Fl p -Password to connect to the server. -This is not required when connecting to a local host. -.Pp -.It Fl s -Read full JSON from another process in the command line. -This is used in conjunction with another command to recieve the request. -.Pp -Example: -.Dl cat jsonFile | sysadm -s -.It Fl f -Read full JSON from a file. -The file can connect a single WebSocket request or a JSON array. -.Pp -Example: -.Dl sysadm -f jsonfile -.It Fl a -Arguments for the request are received from the command line. -Always used together with -n, -ns, and -id. -This is used for quick, single request instances. -.Pp -Example: -.Dl sysadm -u admin -p password -ip 142.37.213.52 -n moused -.Dl -ns sysadm -id klank -a '{"action":"list_devices"}' -.El -.Sh EXAMPLES -This is an example of a WebSocket Request. It can be sent through the command -line with -s or put into a file and read with -f. The order the parameters are -listed does not matter: -.Pp -.Bd -literal -{ - "id" : "fooid", - "namespace" : "sysadm", - "name" : "moused", - "args" : { - "action" : "list_devices" - } -} -.Ed -.Pp -If multiple requests are desired, then they must be placed in an array: -.Pp -.Bd -literal -[ { - "args" : { - "action" : "listcron" - }, - "name" : "lifepreserver", - "namespace" : "sysadm", - "id" : "fooid" -}, -{ - "id" : "fooid", - "args" : { - "action" : "memorystats" - }, - "namespace" : "sysadm", - "name" : "systemmanager" -} ] -.Ed -.Pp -If the above array was sent, then the following response would return: -.Pp -.Bd -literal -{ - "args": { - "listcron": { - } - }, - "id": "fooid", - "name": "response", - "namespace": "sysadm" -} - -{ - "args": { - "memorystats": { - "active": "256", - "cache": "0", - "free": "2193", - "inactive": "2061", - "wired": "3168" - } - }, - "id": "fooid", - "name": "response", - "namespace": "sysadm" -} -.Ed -.Pp -Here is a detailed request with the corresponding WebSocket response: -.Bd -literal -% sysadm -u zwelch -p password -ip 127.0.0.1 -id 72 -n systemmanager -ns sysadm --a '{"action":"cputemps"}' -{ - "args": { - "cputemps": { - "acpithermal": "29.9C", - "cpu0": "42.0C", - "cpu1": "40.0C", - "cpu2": "40.0C", - "cpu3": "41.0C" - } - }, - "id": "72", - "name": "response", - "namespace": "sysadm" -} -.Ed -.Sh SEE ALSO -.Xr sysadm-server(8) -.Pp -See -.Em https://api.sysadm.us -for details on formatting WebSocket requests and a list of -possible names and namespaces. -.Sh AUTHOR -.An Zackary Welch -.Aq welch.zackary@gmail.com diff --git a/src/sysadm.8.gz b/src/sysadm.8.gz deleted file mode 100644 index 78db6a10ed16f2c8312211634b94fc6388452201..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1726 zcmV;v20{5BiwFo%3a$~QaMx6X+G%y8Ae>uQ z%350^~HLuML`002qJ)xT`|d3e)6k zZ5CvS+Yw-#Rmt=pNqVGtShO=Jb_|-usiiECwee9b#iP#y3?OhB91O0FU7Gg{+2HO` z#KNzE!A;*GvQP#CTmXuNH2PCpH1BPu(F}QPhEEemS?~2_p^|9uVLWq$dpPQxaNI&R00jlKp0ty;@^*w!qcyDP$WZtikkLsl#crCMEAkPJSW^((8O>cT=FZZH z5h<3GS!W;LsWNPERh%xXDmglf%+Z!+jmJ|?J6Chr6r9p%yr1skXT*u;dd?-Pga5*2 zvbaLwhhz!Ov|=)v{zzZFiAs~nx<^sc&bkEFjWLu3TkcITk_Fv`UWj9B=?Tg)=GG){ zI^T4b4YVn>6|0=RK_PPvwx1(?%^JsfQ38OvYg!OlfQ02SRJB06DAymF^`yQUZk3#M z=s=rUV^kKKXH^SChkq1(9Ka$&Su9@Fr&{cXmDO5{pb^KoaI*zH2bzB}%qatwwMM zGc@{nobK(XSPMHU1s>EIfgq`yn<0BO$gfU-)klde{!4_hEto>-tIT>QC>tW*_?~98@Q{2rx+x$l)l}+9j2JSqOeP1S7ck^9*Rb^O+o!u zH_mLqHAEkhS=C$g;OtB9_!H+7Fj;T3HWdgv_kDRtew91g=F9H;5cU-j>KisSe)6<+ z5tW(5eTj6to0_>(;i1vsU=t= zk4zdjcV=C%np4618zi_oSg-UCJ)ZrvR7G}mpJ=;F6LaZ4bM0DB_UJa*AlVEwr^<>6 z_KQ`Ghqjco(zIquS#SxSr_W#Bt8CTmk`n7+cbjs=%H8eC@k7czR*p#dU}^Wq-%?ll zuZHPVOkU4Ulk}}?f!qnS^y9Oixbk?v;Mbt5x~}}e