List Machines Function

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > SuperAdmin API > Utility >

List Machines Function

Lists all available machines (known to the connected database).

 

Request

Method

URL

POST

/smserver/smsadm.ListMachines

RAW

POST /smserver/smsadm.ListMachines 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

Returns the list of all machines known to the database backend.

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Type: application/json; charset=UTF-8

 

 

{"result":[

[

       {

           "_id" : "Z5ENP7AZMPRERDQHUEWBSICAKI",

           "RegTo" : "UNREGISTERED",

           "LicType" : "FREE FOR PERSONAL USE",

           "MaxVserver" : 1,

           "conCurrent" : 1,

           "SystemID" : "KPN/bXWjdhBr8JEh",

           "Version" : "4.0.0.1",

           "DirLimit" : [

               "C:\\"

           ],

           "MachineId" : "Z5ENP7AZMPRERDQHUEWBSICAKI",

           "Name" : "XE10",

           "MongoDBHost" : "127.0.0.1",

           "MongoDBPort" : "28038",

           "RESTbindaddr" : "0.0.0.0",

           "RESTbindport" : "443",

           "WebSvcAddr" : "192.168.172.99",

           "WebSvcPort" : "443",

           "CreatedVServer" : 1,

           "MinLic" : 2

       },

       {

           "_id" : "NPFS3SNTFBLUVFJNCLUZPUEB4E",

           "RegTo" : "UNREGISTERED",

           "LicType" : "FREE FOR PERSONAL USE",

           "MaxVserver" : 1,

           "conCurrent" : 1,

           "SystemID" : "KPN/bdmePBtnIIn2",

           "Version" : "4.0.0.1",

           "DirLimit" : [

               "C:\\",

               "D:\\"

           ],

           "MachineId" : "NPFS3SNTFBLUVFJNCLUZPUEB4E",

           "Name" : "WIN-7NU6CONHSM8",

           "MongoDBHost" : "192.168.172.99",

           "MongoDBPort" : "28038",

           "RESTbindaddr" : "0.0.0.0",

           "RESTbindport" : "443",

           "WebSvcAddr" : "192.168.172.100",

           "WebSvcPort" : "443",

           "CreatedVServer" : 1,

           "MinLic" : 2

       }

   ]

],"id":7721}

Explained

A JSON array, each element represents an available machine, and for each machine we have:

 

MachineId: unique ID of the machine (used as NodeID when the machine is added as node to an HA virtual server)

RegTo: name of the customer, if the license is not free

LicType: license type

MaxVserver: maximum number of virtual server that can be created (depends on the license type)

conCurrent: concurrent connections

SystemID: unique fingerprint of hardware+operating system

Version: version of the Web/REST server

DirLimit: main limits for browsing directories (initialized during installation)

Name: NetBIOS name of the physical machine or VM

MongoDBHost: host name or IP address of the MongoDB host

MongoDBPort: port used by the MongoDB host

RESTbindaddr: binding IP address for the Web/REST server

RESTbindport: binding port for the Web/REST server

WebSvcAddr: host name or IP address to reach the Web/REST server (mandatory if machine is an HA node of a vserver)

WebSvcPort: porta to reach the Web/REST server

CreatedVServer: virtual servers already existing on this machine

MinLic: minimum license to buy according to the configuration on this machine (0, 1, or 2)