Create Virtual server

<< Click to Display Table of Contents >>

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

Create Virtual server

Creates a new virtual server.

 

Request

Method

URL

POST

/smserver/smsadm.CreateVServer

RAW

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

 

[

{

           "vserver" : "newVserver",

           "mongoDBhost" : "127.0.0.1",

           "mongoDBport" : 28038,

           "adminname" : "admin",

           "adminpass" : "12345678",

           "name" : "Work vserver",

           "bindssh" : "0.0.0.0",

           "bindsshport" : 1022,

           "bindftp" : "0.0.0.0",

           "bindftpport" : 1021,

           "bindftpdata" : "0.0.0.0",

           "bindftpdataport" : 1020,

           "bindftps" : "0.0.0.0",

           "bindftpsport" : 10990,

           "bindftpsdata" : "0.0.0.0",

           "bindftpsdataport" : 10989,

           "allowedUserTypes" : [

               "SMS",

               "Windows",

               "WinGroup",

               "AD",

               "ADGroup"

           ],

           "allowedVFSTypes" : [

               "Disk",

               "DiskAES256"

           ],

           "intendedUse" : "PCI",

           "maxuser" : 25,

           "maxConn" : 1,

           "allowedRoots" : [

               "C:\\"

           ],

           "MachineId" : "Z5ENP7AZMPRERDQHUEWBSICAKI",

           "nodeid" : "Z5ENP7AZMPRERDQHUEWBSICAKI"

       }

]

Explained

Used to create a new virtual server.

 

vserver: unique name of the virtual server (no spaces, no special characters, only letters and numbers)

mongoDBhost: host name or IP address of the MongoDB host to be used as backend database by this virtual server

mongoDBport: TCP port of the MongoDB host

adminname: username of the first admin profile

adminpass: password of the first admin profile

name: friendly name of the virtual server (can be anything but we recommend to keep it short)

bindssh: IP address to bind the SSH service to

bindsshport: port to bind the SSH service to

bindftp: IP address to bind the FTP service to

bindftpport: port to bind the FTP service to

bindftpdata: IP address to bind the FTP data service to

bindftpdataport: port to bind the FTP data service to

bindftps: IP address to bind the implicit FTPS service to

bindftpsport: port to bind the implicit FTPS service to

bindftpsdata: IP address to bind the implicit FTPS data service to

bindftpsdataport: port to bind the implicit FTPS data service to

allowedUserTypes: user types that this virtual server will be allowed to use ("SMS","Windows","WinGroup","AD","ADGroup") (1)

allowedVFSTypes: VFS types that are allowed for this virtual server (["Disk","DiskAES256"]) (1)

intendedUse:  initial security configuration for the newly created virtual server ("PCI","BROAD","UCP") (2)

maxuser: maximum number of users that administrators will be allowed to create in this virtual server

maxConn: initial value for the maximum number of concurrent client connections (can be changed later by any admin)

allowedRoots: Restrict user home and virtual directories within these values (example: ["C:\\","D:\\Data\\"])

MachineId: the ID of the machine where the virtual server has to be created ("Z5ENP7AZMPRERDQHUEWBSICAKI") (3)

nodeid: node ID, usually the same as machine ID ("Z5ENP7AZMPRERDQHUEWBSICAKI") (3)

 

 

Notes:

(1) these settings depend on the license, and shall be obtained via GetConsts

(2) "pci" = PCI compliant, "broad" = broadly compatible, "ucp" = ideal as Cisco UC backup target

(3) we can obtain this information via smsadm.ListMachines

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

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

 

 

{"result":[

   {

       "Result" : 1,

       "ResultMsg" : "Created",

   },

],"id":7721}

Explained

Result:

  1 = success

  any other value different from 1 = error

 

ResultMsg: a friendly message (success or error message) explaining what happened