github-personal/sysadm
1
0
Fork 0
mirror of https://github.com/outbackdingo/sysadm.git synced 2026-01-27 10:20:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add identify RPC call.

Browse Source
This commit is contained in:
dlavigne
2016-05-03 14:20:44 -04:00
parent 4ef706afee
commit 0f9a73de2f
1 changed files with 54 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
api/connection.rst
View File

@@ -410,7 +410,7 @@ When submitting a job to the dispatcher, keep the following points in mind:
* A chain of commands is useful for multi-step operations but is not considered a replacement for a good shell script on the server.
.. index:: query, rpc
.. index:: query, identify, rpc
.. _Server Subsystems:
@@ -418,7 +418,7 @@ Server Subsystems
=================
An RPC query can be issued to probe all the known subsystems and return which ones are currently available and what level of read and write access the user has.
A query contains the following parameters:
An RPC query contains the following parameters:
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| **Parameter** | **Value** | **Description** |
@@ -487,3 +487,55 @@ A query contains the following parameters:
"name": "response",
"namespace": "rpc"
}
To identify the type of SysAdm system, use an "identify" query. Possible identities are "server", "bridge", and "client".
This type of query contains the following parameters:
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| **Parameter** | **Value** | **Description** |
| | | |
+=================================+===============+======================================================================================================================+
| id | | any unique value for the request; examples include a hash, checksum, or uuid |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| name | identify | |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| namespace | rpc | |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| args | | can be any data |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
**REST Request**
.. code-block:: json
PUT /rpc/identify
{}
**WebSocket Request**
.. code-block:: json
{
"args" : {},
"namespace" : "rpc",
"id" : "fooid",
"name" : "identify"
}
**Response**
.. code-block:: json
{
"args": {
"type": "server"
},
"id": "fooid",
"name": "response",
"namespace": "rpc"
}