Table of Contents
...
By default, the SOS controller’s REST API runs at the controller’s IP on TCP port 8080. An HTTP client can be used to leverage the API. The popular utility curl is used throughout this document as an example HTTP client. For more information on curl, please refer to curl’s documentation. The following is a general example on how to use curl:
...
which returns, as an example:
| Code Block | ||
|---|---|---|
| ||
% Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 3293 0 3293 0 0 100k 0 --:--:-- --:--:-- --:--:-- 100k { "active-transfers": [ { "buffer-size": "40000", "client": { "ip-address": "10.0.0.2", "mac-address": "00:60:dd:43:ac:79", "tcp-port": "51518" }, "client-side-agent": { "active-transfers": [ "a84adbfb-0dec-4a62-b70f-fee1ad84cf1c" ], "control-port": "9998", "data-port": "9877", "feedback-port": "9997", "ip-address": "10.0.0.1", "mac-address": "00:60:dd:43:ac:72" }, "flow-timeout": "10", "parallel-connections": "4096", "queue-capacity": "5", "route-agent-to-agent": { "destination-device": { "active-transfers": [ "a84adbfb-0dec-4a62-b70f-fee1ad84cf1c" ], "control-port": "9998", "data-port": "9877", "feedback-port": "9997", "ip-address": "10.0.0.3", "mac-address": "90:e2:ba:2b:c9:95" }, "route": [ "[id=00:00:00:60:dd:43:ac:72, port=local]", "[id=00:00:00:60:dd:43:ac:72, port=1]", "[id=00:03:00:01:e8:d7:58:9b, port=25]", "[id=00:03:00:01:e8:d7:58:9b, port=4]", "[id=00:01:00:01:e8:8b:77:db, port=61]", "[id=00:01:00:01:e8:8b:77:db, port=47]", "[id=00:00:90:e2:ba:2b:c9:95, port=1]", "[id=00:00:90:e2:ba:2b:c9:95, port=local]" ], "route-type": "AGENT_2_AGENT", "source-device": { "active-transfers": [ "a84adbfb-0dec-4a62-b70f-fee1ad84cf1c" ], "control-port": "9998", "data-port": "9877", "feedback-port": "9997", "ip-address": "10.0.0.1", "mac-address": "00:60:dd:43:ac:72" } }, "route-client-to-agent": "a84adbfb-0dec-4a62-b70f-fee1ad84cf1c", "route-server-to-agent": { "destination-device": { "active-transfers": [ "a84adbfb-0dec-4a62-b70f-fee1ad84cf1c" ], "control-port": "9998", "data-port": "9877", "feedback-port": "9997", "ip-address": "10.0.0.3", "mac-address": "90:e2:ba:2b:c9:95" }, "route": [ "[id=00:01:00:01:e8:8b:77:db, port=48]", "[id=00:01:00:01:e8:8b:77:db, port=47]", "[id=00:00:90:e2:ba:2b:c9:95, port=1]", "[id=00:00:90:e2:ba:2b:c9:95, port=local]" ], "route-type": "SERVER_2_AGENT", "source-device": { "ip-address": "10.0.0.4", "mac-address": "02:63:1e:4f:ab:f1", "tcp-port": "5001" } }, "server": { "ip-address": "10.0.0.4", "mac-address": "02:63:1e:4f:ab:f1", "tcp-port": "5001" }, "server-side-agent": { "active-transfers": [ "a84adbfb-0dec-4a62-b70f-fee1ad84cf1c" ], "control-port": "9998", "data-port": "9877", "feedback-port": "9997", "ip-address": "10.0.0.3", "mac-address": "90:e2:ba:2b:c9:95" }, "server-side-agent-tcp-port": { "length": "2", "port": "37289" }, "time-init": "Mon Oct 26 14:29:01 EDT 2015", "time-start": "Mon Oct 26 14:29:02 EDT 2015", "time-stop": "none" } ], "agents": [ { "active-transfers": [ "a84adbfb-0dec-4a62-b70f-fee1ad84cf1c" ], "control-port": "9998", "data-port": "9877", "feedback-port": "9997", "ip-address": "10.0.0.1", "mac-address": "00:60:dd:43:ac:72" }, { "active-transfers": [ "a84adbfb-0dec-4a62-b70f-fee1ad84cf1c" ], "control-port": "9998", "data-port": "9877", "feedback-port": "9997", "ip-address": "10.0.0.3", "mac-address": "90:e2:ba:2b:c9:95" } ], "terminated-connections": [], "whitelist-entries": [ { "client-ip-address": "10.0.0.2", "server-ip-address": "10.0.0.4", "server-tcp-port": "5001" } ] } |