List Virtual server
Lists all virtual servers available to a machine.
Request
Method |
URL |
POST |
/smserver/smsadm.ReadListVServer |
RAW |
POST /smserver/smsadm.ReadListVServer HTTP/1.1 Cache-Control: no-cache Connection: Keep-Alive Pragma: no-cache Content-Type: application/json; charset=UTF-8 Accept: */* Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
[ {} ] |
Explained |
Reads the list of all virtual servers. |
Response
Method |
URL |
RAW |
Accept-Encoding: synlz,gzip Content-Type: application/json; charset=UTF-8
{"result":[ [ { "VServer" : "default", "AllowDataCollection" : true, "Status" : "green", "StatusArrow" : "up", "StatusTip" : "systems UP", "nodes" : [ { "VServer" : "default", "NodeID" : "Z5ENP7AZMPRERDQHUEWBSICAKI", "Name" : "XE10", "MongoDBHost" : "127.0.0.1", "MongoDBPort" : "28038", "Bindings" : [ { "Active" : true, "Protocol" : "SSH", "IPAddr" : "0.0.0.0", "Port" : 22, "IPVer" : 4, "HostName" : "" }, { "Active" : true, "Protocol" : "FTP", "IPAddr" : "0.0.0.0", "Port" : 21, "IPVer" : 4, "HostName" : "" }, { "Active" : true, "Protocol" : "FTPData", "IPAddr" : "0.0.0.0", "Port" : 20, "IPVer" : 4, "HostName" : "" }, { "Active" : true, "Protocol" : "FTPS", "IPAddr" : "0.0.0.0", "Port" : 990, "IPVer" : 4, "HostName" : "" }, { "Active" : true, "Protocol" : "FTPSData", "IPAddr" : "0.0.0.0", "Port" : 989, "IPVer" : 4, "HostName" : "" } ], "ProcMem" : 3.917e+007, "SysMem" : NumberLong(8589398016), "SysFree" : NumberLong(6546980864), "DeltaSrv" : 4, "DeltaLog" : 5, "DeltaRest" : 2, "Status" : "green", "StatusArrow" : "up", "StatusTip" : "systems UP" } ] }, { "VServer" : "newvserver", "AllowDataCollection" : true, "Status" : "green", "StatusArrow" : "up", "StatusTip" : "systems UP", "nodes" : [ { "VServer" : "newvserver", "NodeID" : "Z5ENP7AZMPRERDQHUEWBSICAKI", "Name" : "Work vserver", "MongoDBHost" : "127.0.0.1", "MongoDBPort" : "28038", "Bindings" : [ { "Active" : true, "Protocol" : "SSH", "IPAddr" : "0.0.0.0", "Port" : 1022, "IPVer" : 4, "HostName" : "" }, { "Active" : true, "Protocol" : "FTP", "IPAddr" : "0.0.0.0", "Port" : 1021, "IPVer" : 4, "HostName" : "" }, { "Active" : true, "Protocol" : "FTPData", "IPAddr" : "0.0.0.0", "Port" : 1020, "IPVer" : 4, "HostName" : "" }, { "Active" : true, "Protocol" : "FTPS", "IPAddr" : "0.0.0.0", "Port" : 10990, "IPVer" : 4, "HostName" : "" }, { "Active" : true, "Protocol" : "FTPSData", "IPAddr" : "0.0.0.0", "Port" : 10989, "IPVer" : 4, "HostName" : "" } ], "ProcMem" : 4.07265e+007, "SysMem" : NumberLong(8589398016), "SysFree" : NumberLong(6547136512), "DeltaSrv" : 15, "DeltaLog" : 5, "DeltaRest" : 2, "Status" : "green", "StatusArrow" : "up", "StatusTip" : "systems UP" } ] } ] ],"id":7721} |
Explained |
Returns an array of all virtual servers, and for each virtual server:
VServer : virtual server name AllowDataCollection : true or false, allow this vserver to send anonymous usage data to Syncplify for statistical purposes Status: virtual server status ("green","yellow","red") StatusArrow: virtual server status ("up","down") StatusTip : description of the virtual server status nodes: JSON array containing the list of all nodes belonging to the virtual server, and for each node: VServer: again, name of the virtual server (as reported by the node) NodeID: unique ID of the node (example: "Z5ENP7AZMPRERDQHUEWBSICAKI") Name: Fiendly name, usually the name of the machine that hosts the node (example: "WIN8472-SRV") MongoDBHost: host name or IP address of the MongoDB server MongoDBPort: port of the MongoDB server Bindings: a JSON array with all bindings for this node, and for each bindings: Active: true or false Protocol: protocol name ("SSH","FTP","FTPData","FTPS","FTPSData") IPAddr: binding host (ex: 0.0.0.0) Port: biding port (ex: 22) IPVer: IP protocol version (4 or 6) HostName: optional ProcMem: total process memory of the main SFTP/FTPS server SysMem: total system memory SysFree: free memory (global system value) DeltaSrv: seconds since the last heartbeat of the main SFTP/FTPS server DeltaLog: seconds since the last heartbeat of the log server DeltaRest: seconds since the last heartbeat of the web/REST server Status: node status ("green","yellow","red") StatusArrow: node status ("up","down") StatusTip: description of the node status |