servers

Manage server hardware, configuration, and services.

get /disks

Arguments
  • No arguments...

Definition
get /disks
Attributes
  • idinteger

    -

  • hostnamestring

    -

  • serverinteger

    -

  • rolestring

    [unassigned, mon, osd, journal, other, raid, deleting, updating, mon_unused, old_osd, old_mon]

  • serialstring

    -

  • capacityinteger

    -

  • namestring

    -

  • pathstring

    -

  • infostring

    -

  • deviceClassstring

    [hdd, ssd, nvme]

  • lastSeennumber

    Duration in seconds.

  • serverLastSeennumber

    Duration in seconds.

  • partitionsinteger

    -

  • usedPartitionsinteger

    -

  • journalDiskinteger

    -

  • journalPartitioninteger

    -

  • osdIdinteger

    -

  • smartobject

    -

    • statusstring

      -

    • detailsstring

      -

  • missingboolean

    -

  • daemonRunningboolean

    -

  • bluestoreboolean

    -

  • wwnstring

    -

  • encryptedboolean

    -

  • identifyLedboolean

    -

  • notesstring

    User-defined notes for this disk

Example response
[ { "id": 0, "hostname": "string", "server": 0, "role": "unassigned", "serial": "string", "capacity": 0, "name": "string", "path": "string", "info": "string", "deviceClass": "hdd", "lastSeen": , "serverLastSeen": , "partitions": 0, "usedPartitions": 0, "journalDisk": 0, "journalPartition": 0, "osdId": 0, "smart": { "status": "string", "details": "string" }, "missing": true, "daemonRunning": true, "bluestore": true, "wwn": "string", "encrypted": true, "identifyLed": true, "notes": "string" } ]

post /disks/create-osds

Arguments
  • bodyoptional

    -

Definition
post /disks/create-osds
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
[ { "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" } ]

delete /disks/{diskId}

Arguments
  • diskIdrequiredinteger

    -

Definition
delete /disks/{diskId}

post /disks/{diskId}/benchmark/basic

Arguments
  • diskIdrequiredinteger

    -

Definition
post /disks/{diskId}/benchmark/basic
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

get /services/iscsi/{serviceId}/disks

Get configured iSCSI RBDs

Arguments
  • serviceIdrequiredinteger

    -

Definition
get /services/iscsi/{serviceId}/disks
Attributes
  • disksarray

    -

Example response
{ "disks": [ "string" ] }

put /services/iscsi/{serviceId}/groups/{group}

Create a new host group.

Arguments
  • serviceIdrequiredinteger

    -

  • grouprequiredstring

    -

Definition
put /services/iscsi/{serviceId}/groups/{group}

delete /services/iscsi/{serviceId}/groups/{group}

Delete a host group.

Arguments
  • serviceIdrequiredinteger

    -

  • grouprequiredstring

    -

Definition
delete /services/iscsi/{serviceId}/groups/{group}

patch /services/iscsi/{serviceId}/disks/{pool}/{image}

Update parameters for an exported RBD image.

Arguments
  • serviceIdrequiredinteger

    -

  • poolrequiredstring

    -

  • imagerequiredstring

    -

  • bodyoptional

    -

Definition
patch /services/iscsi/{serviceId}/disks/{pool}/{image}

get /services/iscsi/{serviceId}

Get configuration of an iSCSI gateway

Arguments
  • serviceIdrequiredinteger

    -

Definition
get /services/iscsi/{serviceId}
Attributes
  • iqnstring

    -

  • gatewaysarray

    -

    • namestring

      -

    • ipstring

      -

  • clientsarray

    -

    • namestring

      -

    • groupstring

      -

    • usernamestring

      -

    • passwordstring

      -

    • lunsarray

      -

      • poolstring

        -

      • imagestring

        -

      • idinteger

        -

      • wwnstring

        -

  • groupsarray

    -

    • namestring

      -

    • membersarray

      -

    • lunsarray

      -

      • poolstring

        -

      • imagestring

        -

      • idinteger

        -

      • wwnstring

        -

  • gatewayVersioninteger

    -

Example response
{ "iqn": "string", "gateways": [ { "name": "string", "ip": "string" } ], "clients": [ { "name": "string", "group": "string", "username": "string", "password": "string", "luns": [ { "pool": "string", "image": "string", "id": 0, "wwn": "string" } ] } ], "groups": [ { "name": "string", "members": [ "string" ], "luns": [ { "pool": "string", "image": "string", "id": 0, "wwn": "string" } ] } ], "gatewayVersion": 0 }

post /services/iscsi/{serviceId}

Add a server to an existing iSCSI gateway service.

Arguments
  • serviceIdrequiredinteger

    -

  • bodyoptional

    -

Definition
post /services/iscsi/{serviceId}
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

delete /services/iscsi/{serviceId}

Delete an iSCSI service.

Arguments
  • serviceIdrequiredinteger

    -

Definition
delete /services/iscsi/{serviceId}

delete /services/iscsi/{serviceId}/servers/{hostname}

Remote a server from an existing iSCSI gateway service.

Arguments
  • serviceIdrequiredinteger

    -

  • hostnamerequiredstring

    -

Definition
delete /services/iscsi/{serviceId}/servers/{hostname}
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

put /services/iscsi/{serviceId}/clients/{name}

Configure a new iSCSI client

Arguments
  • serviceIdrequiredinteger

    -

  • namerequiredstring

    -

  • bodyoptional

    -

Definition
put /services/iscsi/{serviceId}/clients/{name}

delete /services/iscsi/{serviceId}/clients/{name}

Delete an iSCSI client

Arguments
  • serviceIdrequiredinteger

    -

  • namerequiredstring

    -

Definition
delete /services/iscsi/{serviceId}/clients/{name}

patch /services/iscsi/{serviceId}/clients/{name}

Change a client's username/password

Arguments
  • serviceIdrequiredinteger

    -

  • namerequiredstring

    -

  • bodyoptional

    -

Definition
patch /services/iscsi/{serviceId}/clients/{name}

put /services/iscsi/{serviceId}/clients/{name}/disks

Add new disk(s) to an iSCSI client

Arguments
  • serviceIdrequiredinteger

    -

  • namerequiredstring

    -

  • bodyoptional

    RBD image will be created if it doesn't exist yet

Definition
put /services/iscsi/{serviceId}/clients/{name}/disks

delete /services/iscsi/{serviceId}/clients/{name}/disks

Remove a disk from an iSCSI client

Arguments
  • serviceIdrequiredinteger

    -

  • namerequiredstring

    -

  • bodyoptional

    -

Definition
delete /services/iscsi/{serviceId}/clients/{name}/disks

put /services/iscsi/{serviceId}/groups/{group}/disks

Add disks to a host group.

Arguments
  • serviceIdrequiredinteger

    -

  • grouprequiredstring

    -

  • bodyoptional

    -

Definition
put /services/iscsi/{serviceId}/groups/{group}/disks

delete /services/iscsi/{serviceId}/groups/{group}/disks

Remove a disk from a host group.

Arguments
  • serviceIdrequiredinteger

    -

  • grouprequiredstring

    -

  • bodyoptional

    -

Definition
delete /services/iscsi/{serviceId}/groups/{group}/disks

put /services/iscsi/{serviceId}/groups/{group}/hosts/{host}

Add a host to a host group.

Arguments
  • serviceIdrequiredinteger

    -

  • grouprequiredstring

    -

  • hostrequiredstring

    -

Definition
put /services/iscsi/{serviceId}/groups/{group}/hosts/{host}

delete /services/iscsi/{serviceId}/groups/{group}/hosts/{host}

Remove a host from a host group.

Arguments
  • serviceIdrequiredinteger

    -

  • grouprequiredstring

    -

  • hostrequiredstring

    -

Definition
delete /services/iscsi/{serviceId}/groups/{group}/hosts/{host}

put /services/iscsi/{serviceId}/groups/{group}/hosts

Add hosts to a host group.

Arguments
  • serviceIdrequiredinteger

    -

  • grouprequiredstring

    -

  • bodyoptional

    -

Definition
put /services/iscsi/{serviceId}/groups/{group}/hosts

delete /services/iscsi/{serviceId}/groups/{group}/hosts

Remove hosts from a host group.

Arguments
  • serviceIdrequiredinteger

    -

  • grouprequiredstring

    -

  • bodyoptional

    -

Definition
delete /services/iscsi/{serviceId}/groups/{group}/hosts

post /services/iscsi/{serviceId}/terminal/connect

Connect to the ceph-iscsi config shell

Arguments
  • serviceIdrequiredinteger

    -

Definition
post /services/iscsi/{serviceId}/terminal/connect
Attributes
  • pathstring

    Connect here.

  • tlsPortinteger

    Connect to this port for TLS.

  • plaintextPortinteger

    Connect to this port for an unencrypted connection.

  • authTokenstring

    Pass as Authorization header.

  • validUntilinteger

    URL is valid until this time, existing connections stay connected afterwards.

  • iscsiboolean

    Whether this is a connection to an iSCSI gateway.

Example response
{ "path": "string", "tlsPort": 0, "plaintextPort": 0, "authToken": "string", "validUntil": 0, "iscsi": true }

post /services/iscsi

Create a new iSCSI gateway service.

Arguments
  • bodyoptional

    -

Definition
post /services/iscsi
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

post /services/nfs-gateways

Create a new NFS gateway service.

Arguments
  • bodyoptional

    -

Definition
post /services/nfs-gateways
Attributes
  • idinteger

    -

Example response
{ "id": 0 }

get /services/nfs-gateways/{serviceId}

Get a NFS gateway configuration.

Arguments
  • serviceIdrequiredinteger

    -

Definition
get /services/nfs-gateways/{serviceId}
Attributes
  • serversarray

    -

  • exportsarray

    -

    • idinteger

      Id of this export, assigned by the server on creation.

    • nfsPathstring

      The path on the NFS server at which this export is available.

    • pathstring

      The path to export.

    • accessarray

      Clients allowed to access this export.

      • subnetstring

        -

      • rwboolean

        -

    • protocolsobject

      -

      • configStringstring

        -

      • nfs3boolean

        -

      • nfs4boolean

        -

Example response
{ "servers": [ 0 ], "exports": [ { "id": 0, "nfsPath": "string", "path": "string", "access": [ { "subnet": "string", "rw": true } ], "protocols": { "configString": "string", "nfs3": true, "nfs4": true } } ] }

patch /services/nfs-gateways/{serviceId}

Update a NFS gateway service.

Arguments
  • serviceIdrequiredinteger

    -

  • bodyoptional

    -

Definition
patch /services/nfs-gateways/{serviceId}

get /services/nfs-gateways/{serviceId}/exports

Get exports of a NFS gateway.

Arguments
  • serviceIdrequiredinteger

    -

Definition
get /services/nfs-gateways/{serviceId}/exports
Attributes
  • idinteger

    Id of this export, assigned by the server on creation.

  • nfsPathstring

    The path on the NFS server at which this export is available.

  • pathstring

    The path to export.

  • accessarray

    Clients allowed to access this export.

    • subnetstring

      -

    • rwboolean

      -

  • protocolsobject

    -

    • configStringstring

      -

    • nfs3boolean

      -

    • nfs4boolean

      -

Example response
[ { "id": 0, "nfsPath": "string", "path": "string", "access": [ { "subnet": "string", "rw": true } ], "protocols": { "configString": "string", "nfs3": true, "nfs4": true } } ]

post /services/nfs-gateways/{serviceId}/exports

Add an export to the NFS gateway.

Arguments
  • serviceIdrequiredinteger

    -

  • bodyoptional

    -

Definition
post /services/nfs-gateways/{serviceId}/exports
Attributes
  • idinteger

    Id of this export, assigned by the server on creation.

  • nfsPathstring

    The path on the NFS server at which this export is available.

  • pathstring

    The path to export.

  • accessarray

    Clients allowed to access this export.

    • subnetstring

      -

    • rwboolean

      -

  • protocolsobject

    -

    • configStringstring

      -

    • nfs3boolean

      -

    • nfs4boolean

      -

Example response
{ "id": 0, "nfsPath": "string", "path": "string", "access": [ { "subnet": "string", "rw": true } ], "protocols": { "configString": "string", "nfs3": true, "nfs4": true } }

get /services/nfs-gateways/{serviceId}/servers

Get servers running this service.

Arguments
  • serviceIdrequiredinteger

    -

Definition
get /services/nfs-gateways/{serviceId}/servers
Attributes
Example response
[ 0 ]

put /services/nfs-gateways/{serviceId}/exports/{exportId}

Replace an export entry on the NFS gateway.

Arguments
  • serviceIdrequiredinteger

    -

  • exportIdrequiredinteger

    -

  • bodyoptional

    -

Definition
put /services/nfs-gateways/{serviceId}/exports/{exportId}

delete /services/nfs-gateways/{serviceId}/exports/{exportId}

Remove an export entry from the NFS gateway.

Arguments
  • serviceIdrequiredinteger

    -

  • exportIdrequiredinteger

    -

Definition
delete /services/nfs-gateways/{serviceId}/exports/{exportId}

delete /servers/{id}/disks/{diskId}

Arguments
  • idrequiredinteger

    -

  • diskIdrequiredinteger

    -

Definition
delete /servers/{id}/disks/{diskId}

patch /servers/{id}/disks/{diskId}

Arguments
  • idrequiredinteger

    -

  • diskIdrequiredinteger

    -

  • bodyoptional

    -

Definition
patch /servers/{id}/disks/{diskId}

delete /servers/{id}/nics/{nicId}

Arguments
  • idrequiredinteger

    -

  • nicIdrequiredinteger

    -

Definition
delete /servers/{id}/nics/{nicId}

patch /servers/{id}/nics/{nicId}

Arguments
  • idrequiredinteger

    -

  • nicIdrequiredinteger

    -

  • bodyoptional

    -

Definition
patch /servers/{id}/nics/{nicId}

get /servers

Arguments
  • No arguments...

Definition
get /servers
Attributes
  • idinteger

    -

  • hostnamestring

    -

  • statestring

    [booting, running, offline, rebooting]

  • macstring

    -

  • ipstring

    -

  • imagestring

    -

  • hardwareobject

    -

    • ramnumber

      -

    • cpustring

      -

    • cpusinteger

      -

    • coresPerCpuinteger

      -

    • cpuFreqnumber

      -

    • mainboardstring

      -

    • mainboardSerialstring

      -

    • ipmiobject

      -

      • ipstring

        -

      • subnetstring

        -

      • macstring

        -

      • vlanstring

        -

  • lastSeennumber

    Duration in seconds.

  • servicesobject

    Number of services configured on the server by type.

  • servicesRunningobject

    Number of services currently running on the server by type.

  • osdsinteger

    Number of disks currently mounted as OSD.

  • osdsRunninginteger

    Number of OSD daemons currently running.

  • ipsarray

    IPs configured on all NICs, only these are valid for the main IP.

  • healthobject

    -

    • uptimenumber

      Duration in seconds.

    • hwDetectTimenumber

      Duration in seconds.

    • cephDiskProcsinteger

      -

    • runningImagestring

      -

    • clockDriftnumber

      Approximate time difference between this server and the management server, negative values indicate the server is behind.

  • ipmiobject

    -

    • idinteger

      -

    • ipstring

      -

    • macstring

      -

    • vlaninteger

      -

  • notesstring

    User-defined notes for this server

Example response
[ { "id": 0, "hostname": "string", "state": "booting", "mac": "string", "ip": "string", "image": "string", "hardware": { "ram": , "cpu": "string", "cpus": 0, "coresPerCpu": 0, "cpuFreq": , "mainboard": "string", "mainboardSerial": "string", "ipmi": { "ip": "string", "subnet": "string", "mac": "string", "vlan": "string" } }, "lastSeen": , "services": {}, "servicesRunning": {}, "osds": 0, "osdsRunning": 0, "ips": [ "string" ], "health": { "uptime": , "hwDetectTime": , "cephDiskProcs": 0, "runningImage": "string", "clockDrift": }, "ipmi": { "id": 0, "ip": "string", "mac": "string", "vlan": 0 }, "notes": "string" } ]

get /servers/{id}/disks

Arguments
  • idrequiredinteger

    -

Definition
get /servers/{id}/disks
Attributes
  • idinteger

    -

  • hostnamestring

    -

  • serverinteger

    -

  • rolestring

    [unassigned, mon, osd, journal, other, raid, deleting, updating, mon_unused, old_osd, old_mon]

  • serialstring

    -

  • capacityinteger

    -

  • namestring

    -

  • pathstring

    -

  • infostring

    -

  • deviceClassstring

    [hdd, ssd, nvme]

  • lastSeennumber

    Duration in seconds.

  • serverLastSeennumber

    Duration in seconds.

  • partitionsinteger

    -

  • usedPartitionsinteger

    -

  • journalDiskinteger

    -

  • journalPartitioninteger

    -

  • osdIdinteger

    -

  • smartobject

    -

    • statusstring

      -

    • detailsstring

      -

  • missingboolean

    -

  • daemonRunningboolean

    -

  • bluestoreboolean

    -

  • wwnstring

    -

  • encryptedboolean

    -

  • identifyLedboolean

    -

  • notesstring

    User-defined notes for this disk

Example response
[ { "id": 0, "hostname": "string", "server": 0, "role": "unassigned", "serial": "string", "capacity": 0, "name": "string", "path": "string", "info": "string", "deviceClass": "hdd", "lastSeen": , "serverLastSeen": , "partitions": 0, "usedPartitions": 0, "journalDisk": 0, "journalPartition": 0, "osdId": 0, "smart": { "status": "string", "details": "string" }, "missing": true, "daemonRunning": true, "bluestore": true, "wwn": "string", "encrypted": true, "identifyLed": true, "notes": "string" } ]

get /servers/{id}/nics

Arguments
  • idrequiredinteger

    -

Definition
get /servers/{id}/nics
Attributes
  • idinteger

    -

  • serverinteger

    -

  • macstring

    -

  • speednumber

    -

  • namestring

    -

  • ipstring

    -

  • ip6string

    -

  • typestring

    [normal, bond]

  • bondedNicsarray

    -

  • lastSeennumber

    Duration in seconds.

  • serverLastSeennumber

    Duration in seconds.

  • vlansarray

    -

    • idinteger

      -

    • nicinteger

      -

    • vlaninteger

      -

    • ipstring

      -

    • ip6string

      -

  • linuxNamestring

    -

  • lldparray

    -

    • chassisobject

      -

    • portobject

      -

      • idobject

        -

        • typestring

          -

        • valuestring

          -

      • descrstring

        -

    • vlanobject

      -

      • vlanIdstring

        -

    • ridstring

      -

  • bondTypestring

    [lacp, active_passive]

  • bondPrimaryinteger

    -

  • notesstring

    User-defined notes for this NIC

Example response
[ { "id": 0, "server": 0, "mac": "string", "speed": , "name": "string", "ip": "string", "ip6": "string", "type": "normal", "bondedNics": [ 0 ], "lastSeen": , "serverLastSeen": , "vlans": [ { "id": 0, "nic": 0, "vlan": 0, "ip": "string", "ip6": "string" } ], "linuxName": "string", "lldp": [ { "chassis": {}, "port": { "id": { "type": "string", "value": "string" }, "descr": "string" }, "vlan": { "vlanId": "string" }, "rid": "string" } ], "bondType": "lacp", "bondPrimary": 0, "notes": "string" } ]

get /servers/nics

Arguments
  • No arguments...

Definition
get /servers/nics
Attributes
  • idinteger

    -

  • serverinteger

    -

  • macstring

    -

  • speednumber

    -

  • namestring

    -

  • ipstring

    -

  • ip6string

    -

  • typestring

    [normal, bond]

  • bondedNicsarray

    -

  • lastSeennumber

    Duration in seconds.

  • serverLastSeennumber

    Duration in seconds.

  • vlansarray

    -

    • idinteger

      -

    • nicinteger

      -

    • vlaninteger

      -

    • ipstring

      -

    • ip6string

      -

  • linuxNamestring

    -

  • lldparray

    -

    • chassisobject

      -

    • portobject

      -

      • idobject

        -

        • typestring

          -

        • valuestring

          -

      • descrstring

        -

    • vlanobject

      -

      • vlanIdstring

        -

    • ridstring

      -

  • bondTypestring

    [lacp, active_passive]

  • bondPrimaryinteger

    -

  • notesstring

    User-defined notes for this NIC

Example response
[ { "id": 0, "server": 0, "mac": "string", "speed": , "name": "string", "ip": "string", "ip6": "string", "type": "normal", "bondedNics": [ 0 ], "lastSeen": , "serverLastSeen": , "vlans": [ { "id": 0, "nic": 0, "vlan": 0, "ip": "string", "ip6": "string" } ], "linuxName": "string", "lldp": [ { "chassis": {}, "port": { "id": { "type": "string", "value": "string" }, "descr": "string" }, "vlan": { "vlanId": "string" }, "rid": "string" } ], "bondType": "lacp", "bondPrimary": 0, "notes": "string" } ]

post /servers/{id}/nics/bonds

Arguments
  • idrequiredinteger

    -

  • bodyoptional

    -

Definition
post /servers/{id}/nics/bonds

get /servers/{id}/nics/{nicId}/vlans

Arguments
  • idrequiredinteger

    -

  • nicIdrequiredinteger

    -

Definition
get /servers/{id}/nics/{nicId}/vlans
Attributes
  • idinteger

    -

  • nicinteger

    -

  • vlaninteger

    -

  • ipstring

    -

  • ip6string

    -

Example response
[ { "id": 0, "nic": 0, "vlan": 0, "ip": "string", "ip6": "string" } ]

post /servers/{id}/nics/{nicId}/vlans

Arguments
  • idrequiredinteger

    -

  • nicIdrequiredinteger

    -

  • bodyoptional

    -

Definition
post /servers/{id}/nics/{nicId}/vlans

delete /servers/{id}/nics/{nicId}/vlans/{vlanId}

Arguments
  • idrequiredinteger

    -

  • nicIdrequiredinteger

    -

  • vlanIdrequiredinteger

    -

Definition
delete /servers/{id}/nics/{nicId}/vlans/{vlanId}

patch /servers/{id}/nics/{nicId}/vlans/{vlanId}

Arguments
  • idrequiredinteger

    -

  • nicIdrequiredinteger

    -

  • vlanIdrequiredinteger

    -

  • bodyoptional

    -

Definition
patch /servers/{id}/nics/{nicId}/vlans/{vlanId}

delete /servers/{id}

Arguments
  • idrequiredinteger

    -

Definition
delete /servers/{id}

patch /servers/{id}

Arguments
  • idrequiredinteger

    -

  • bodyoptional

    -

Definition
patch /servers/{id}

get /servers/{id}/services

Arguments
  • idrequiredinteger

    -

Definition
get /servers/{id}/services
Attributes
  • idstring

    -

  • typestring

    [osd, mon, mgr, radosgw, mds, nfs_gateway, iscsi, smb, unknown]

  • statestring

    [creating, enabled, disabled, creation_failed]

  • serverinteger

    -

  • ipstring

    -

  • runningboolean

    -

Example response
[ { "id": "string", "type": "osd", "state": "creating", "server": 0, "ip": "string", "running": true } ]

post /servers/{serverId}/services/mon

Arguments
  • serverIdrequiredinteger

    -

  • bodyoptional

    -

Definition
post /servers/{serverId}/services/mon
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

post /servers/{serverId}/services/mds

Arguments
  • serverIdrequiredinteger

    -

Definition
post /servers/{serverId}/services/mds
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

post /servers/{serverId}/services/rgw

Arguments
  • serverIdrequiredinteger

    -

Definition
post /servers/{serverId}/services/rgw
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

delete /servers/{id}/services/{serviceId}

Arguments
  • idrequiredinteger

    -

  • serviceIdrequiredinteger

    -

Definition
delete /servers/{id}/services/{serviceId}
Attributes
  • objectstring

    -

  • idinteger

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • namestring

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • outputstring

    -

Example response
{ "object": "string", "id": 0, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "name": "string", "state": "WAITING", "result": {}, "output": "string" }

post /servers/{id}/reboot

Arguments
  • idrequiredinteger

    -

Definition
post /servers/{id}/reboot

post /servers/{id}/shutdown

Arguments
  • idrequiredinteger

    -

Definition
post /servers/{id}/shutdown

post /servers/reboot

Arguments
  • bodyoptional

    -

Definition
post /servers/reboot
Attributes
  • objectstring

    -

  • doneboolean

    -

  • resultobject

    -

  • idinteger

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • namestring

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • outputstring

    -

Example response
{ "object": "string", "done": true, "result": {}, "id": 0, "statusCode": 0, "startedAt": 0, "startedBy": "string", "name": "string", "state": "WAITING", "output": "string" }

delete /servers/{id}/disks/{diskId}/wipe

Arguments
  • idrequiredinteger

    -

  • diskIdrequiredinteger

    -

  • bodyoptional

    -

Definition
delete /servers/{id}/disks/{diskId}/wipe
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

post /servers/{id}/redetect

Arguments
  • idrequiredinteger

    -

Definition
post /servers/{id}/redetect

post /servers/{serverId}/services/{type}/{serviceId}/start

Start a service.

Arguments
  • serverIdrequiredinteger

    -

  • typerequiredstring

    -

  • serviceIdrequiredinteger

    -

Definition
post /servers/{serverId}/services/{type}/{serviceId}/start

post /servers/{serverId}/services/{type}/{serviceId}/stop

Stop a service.

Arguments
  • serverIdrequiredinteger

    -

  • typerequiredstring

    -

  • serviceIdrequiredinteger

    -

Definition
post /servers/{serverId}/services/{type}/{serviceId}/stop

post /servers/{serverId}/services/{type}/{serviceId}/restart

Restart a service.

Arguments
  • serverIdrequiredinteger

    -

  • typerequiredstring

    -

  • serviceIdrequiredinteger

    -

Definition
post /servers/{serverId}/services/{type}/{serviceId}/restart

post /services/smb

Create a new simple SMB gateway service.

Arguments
  • bodyoptional

    -

Definition
post /services/smb
Attributes
  • idinteger

    -

Example response
{ "id": 0 }

post /services/smb/active-directory-authentication

Create a new SMB gateway service using Active Directory for authentication.

Arguments
  • bodyoptional

    -

Definition
post /services/smb/active-directory-authentication
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

get /services/smb/{serviceId}

Get SMB gateway config and state.

Arguments
  • serviceIdrequiredinteger

    -

Definition
get /services/smb/{serviceId}
Attributes
  • typestring

    [SIMPLE, ADS]

  • serversarray

    -

    • serverinteger

      -

    • nicinteger

      Interface on which HA virtual IPs will be bound.

    • vlaninteger

      VLAN tag on the selected interface.

    • virtualIpsarray

      Virtual IPs currently bound on the server.

    • healthyboolean

      true if all health checks succeeded.

  • virtualIpsarray

    Virtual IP addresses to be distributed evenly across all healthy servers.

  • sharesarray

    -

    • sharestring

      Name of the SMB share.

    • pathstring

      Path in CephFS to export.

  • domainstring

    -

  • netbiosDomainNamestring

    -

  • domainControllerstring

    -

  • dnsServersarray

    -

Example response
{ "type": "SIMPLE", "servers": [ { "server": 0, "nic": 0, "vlan": 0, "virtualIps": [ "string" ], "healthy": true } ], "virtualIps": [ "string" ], "shares": [ { "share": "string", "path": "string" } ], "domain": "string", "netbiosDomainName": "string", "domainController": "string", "dnsServers": [ "string" ] }

delete /services/smb/{serviceId}

Delete an SMB gateway.

Arguments
  • serviceIdrequiredinteger

    -

Definition
delete /services/smb/{serviceId}

patch /services/smb/{serviceId}

Update an SMB gateway.

Arguments
  • serviceIdrequiredinteger

    -

  • bodyoptional

    -

Definition
patch /services/smb/{serviceId}

post /services/smb/{serviceId}/shares

Add a share to an SMB gateway.

Arguments
  • serviceIdrequiredinteger

    -

  • bodyoptional

    -

Definition
post /services/smb/{serviceId}/shares
Attributes
  • idinteger

    -

Example response
{ "id": 0 }

put /services/smb/{serviceId}/shares/{shareId}

Replace a share on an SMB gateway.

Arguments
  • serviceIdrequiredinteger

    -

  • shareIdrequiredinteger

    -

  • bodyoptional

    -

Definition
put /services/smb/{serviceId}/shares/{shareId}

delete /services/smb/{serviceId}/shares/{shareId}

Remove a share from an SMB gateway.

Arguments
  • serviceIdrequiredinteger

    -

  • shareIdrequiredinteger

    -

Definition
delete /services/smb/{serviceId}/shares/{shareId}

post /services/smb/{serviceId}/servers

Add a server to an SMB gateway.

Arguments
  • serviceIdrequiredinteger

    -

  • bodyoptional

    -

Definition
post /services/smb/{serviceId}/servers
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

delete /services/smb/{serviceId}/servers/{serverId}

Remove a server from an SMB gateway.

Arguments
  • serviceIdrequiredinteger

    -

  • serverIdrequiredinteger

    -

Definition
delete /services/smb/{serviceId}/servers/{serverId}
Attributes
  • namestring

    -

  • idinteger

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • resultobject

    -

  • doneboolean

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • objectstring

    -

  • outputstring

    -

Example response
{ "name": "string", "id": 0, "state": "WAITING", "result": {}, "done": true, "statusCode": 0, "startedAt": 0, "startedBy": "string", "object": "string", "output": "string" }

get /server-access/host-keys

Arguments
  • No arguments...

Definition
get /server-access/host-keys
Attributes
Example response
{}

get /server-access/keys

Arguments
  • No arguments...

Definition
get /server-access/keys
Attributes
Example response
[ "string" ]

put /server-access/keys

Arguments
  • bodyoptional

    -

Definition
put /server-access/keys

get /server-access/support-key

Arguments
  • No arguments...

Definition
get /server-access/support-key
Attributes
  • enabledboolean

    -

Example response
{ "enabled": true }

put /server-access/support-key

Arguments
  • bodyoptional

    -

Definition
put /server-access/support-key

get /server-access/passwords

Arguments
  • No arguments...

Definition
get /server-access/passwords
Attributes
  • rootPasswordstring

    -

  • ipmiPasswordstring

    -

Example response
{ "rootPassword": "string", "ipmiPassword": "string" }

patch /server-access/passwords

Arguments
  • bodyoptional

    -

Definition
patch /server-access/passwords
Attributes
  • objectstring

    -

  • doneboolean

    -

  • resultobject

    -

  • idinteger

    -

  • statusCodeinteger

    -

  • startedAtinteger

    -

  • startedBystring

    -

  • namestring

    -

  • statestring

    [WAITING, RUNNING, FINISHED, FAILED, CANCELED]

  • outputstring

    -

Example response
{ "object": "string", "done": true, "result": {}, "id": 0, "statusCode": 0, "startedAt": 0, "startedBy": "string", "name": "string", "state": "WAITING", "output": "string" }