servers
Manage server hardware, configuration, and services.
List of all disks across all servers.
Parameters[
{
"id": 0,
"wwn": "string",
"info": "string",
"name": "string",
"path": "string",
"role": "unassigned",
"size": 0,
"type": "normal",
"wwns": {
"wwn": "string",
"wwnWithExtension": "string"
},
"notes": "string",
"osdId": 0,
"smart": {
"status": "string",
"details": "string",
"temperature": 0
},
"stats": {
"read": 0,
"write": 0,
"ioLoad": 0,
"iopsRead": 0,
"iopsWrite": 0,
"readFormatted": "string",
"writeFormatted": "string",
"ioLoadFormatted": "string",
"iopsReadFormatted": 0,
"iopsWriteFormatted": 0
},
"daosId": 0,
"dbDisk": 0,
"serial": "string",
"server": 0,
"status": {},
"missing": true,
"pathRaw": "string",
"serials": {
"serial": "string",
"nvmeSerial": "string",
"scsiSerial": "string",
"shortSerial": "string",
"scsiIdentSerial": "string"
},
"walDisk": 0,
"capacity": 0,
"hostname": "string",
"lastSeen": 0,
"numaNode": 0,
"bluestore": true,
"encrypted": true,
"mpathInfo": {
"info": "string",
"paths": [
{
"state": "string",
"active": true,
"diskId": 0,
"devName": "string"
}
],
"numMax": 0,
"healthy": true,
"numTotal": 0,
"numActive": 0,
"stateLabel": "string",
"pathsFormatted": "string"
},
"roleLabel": "string",
"partitions": 0,
"pciAddress": "string",
"dbPartition": 0,
"deviceClass": "hdd",
"identifyLed": true,
"multipathed": true,
"walPartition": 0,
"daemonRunning": true,
"pathFormatted": "string",
"serviceHealth": {
"memory": 0,
"uptime": 0,
"memoryFormatted": "string",
"uptimeFormatted": "string"
},
"sizeFormatted": "string",
"serverLastSeen": 0,
"usedPartitions": 0,
"osdFragmentation": 0,
"numaNodeFormatted": "string"
}
]
List all servers.
Parameters[
{
"id": 0,
"ip": "string",
"ips": [
"string"
],
"ipmi": {
"id": 0,
"ip": "string",
"mac": "string",
"vlan": 0
},
"macs": [
"string"
],
"osds": 0,
"image": "string",
"notes": "string",
"state": "booting",
"daosId": 0,
"health": {
"uptime": 0,
"freeRam": 0,
"clockDrift": 0,
"hwDetectTime": 0,
"runningImage": "string",
"cephDiskProcs": 0,
"uptimeFormatted": "string",
"freeRamFormatted": "string"
},
"hardware": {
"cpu": "string",
"ram": 0,
"cpus": 0,
"ipmi": {
"ip": "string",
"mac": "string",
"vlan": "string",
"subnet": "string"
},
"cpuArch": "string",
"cpuFreq": 0,
"mainboard": "string",
"coresPerCpu": 0,
"ramFormatted": "string",
"mainboardSerial": "string",
"cpuFreqFormatted": "string"
},
"hostname": "string",
"lastSeen": 0,
"services": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"machineId": "string",
"usedPorts": [
0
],
"stateLabel": "string",
"nrHugepages": 0,
"osdsRunning": 0,
"servicesMap": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
},
"hasSambaSssd": true,
"daemonVersion": 0,
"macsFormatted": "string",
"servicesRunning": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"imageDescription": "string",
"ramUsageFormatted": "string",
"servicesRunningMap": {
"additionalProp1": true,
"additionalProp2": true,
"additionalProp3": true
}
}
]
Wipe disks on servers.
Parameters{
"disks": [
{
"disk": 0,
"serial": "string",
"server": 0,
"destroy": true
}
]
}
{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0
}
List of all known multipath disk paths across all servers.
Parameters{
"data": [
{
"state": "string",
"active": true,
"diskId": 0,
"devName": "string"
}
],
"after": 0,
"limit": 0,
"total": 0
}
List all IP addresses in use.
{
"nic": [
{
"ip": "string",
"nicId": 0,
"serverId": 0
}
],
"smb": [
{
"ip": "string",
"serviceId": 0
}
],
"vlan": [
{
"ip": "string",
"nicId": 0,
"vlanId": 0,
"serverId": 0
}
],
"hagroup": [
{
"ip": "string",
"haGroupId": 0
}
]
}
List all nics.
Parameters[
{
"id": 0,
"ip": "string",
"ip6": "string",
"mac": "string",
"bond": 0,
"lldp": [
{
"rid": "string",
"port": {
"id": {
"type": "string",
"value": "string"
},
"descr": "string"
},
"vlan": [
{
"vlanId": "string"
}
],
"chassis": {
"additionalProp1": {
"id": {
"type": "string",
"value": "string"
},
"descr": "string",
"mgmtIp": [
"string"
]
},
"additionalProp2": {
"id": {
"type": "string",
"value": "string"
},
"descr": "string",
"mgmtIp": [
"string"
]
},
"additionalProp3": {
"id": {
"type": "string",
"value": "string"
},
"descr": "string",
"mgmtIp": [
"string"
]
}
}
}
],
"name": "string",
"port": "string",
"type": "normal",
"notes": "string",
"speed": 0,
"vlans": [
{
"id": 0,
"ip": "string",
"ip6": "string",
"nic": 0,
"vlan": 0
}
],
"daosId": 0,
"server": 0,
"virtual": true,
"bondType": "lacp",
"lastSeen": 0,
"neighbor": "string",
"numaNode": 0,
"linuxName": "string",
"bondedNics": [
0
],
"bondPrimary": 0,
"ipFormatted": "string",
"vlansJoined": "string",
"ip6Formatted": "string",
"bondFormatted": "string",
"bondTypeLabel": "string",
"infinibandMac": "string",
"serverLastSeen": 0,
"speedFormatted": "string",
"numaNodeFormatted": "string",
"bondedNicsFormatted": "string"
}
]
{
"ip": "string",
"image": "string",
"notes": "string",
"hostname": "string",
"nrHugepages": 0
}
{
"servers": [
0
]
}
{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"question": {
"token": "string",
"message": "string",
"timeout": 0,
"priority": "Standard",
"timeLeft": 0,
"defaultResponse": "string",
"responseOptions": [
"string"
]
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0,
"interactive": true
}
List free IP addresses in a subnet.
Parameters[
"string"
]
{
"osds": [
{
"disk": 0,
"dbDisk": 0,
"server": 0,
"walDisk": 0,
"encrypted": true,
"reuseOsdId": 0,
"crushDeviceClass": "string"
}
]
}
[
{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0
}
]
List nics on the server.
Parameters[
{
"id": 0,
"ip": "string",
"ip6": "string",
"mac": "string",
"bond": 0,
"lldp": [
{
"rid": "string",
"port": {
"id": {
"type": "string",
"value": "string"
},
"descr": "string"
},
"vlan": [
{
"vlanId": "string"
}
],
"chassis": {
"additionalProp1": {
"id": {
"type": "string",
"value": "string"
},
"descr": "string",
"mgmtIp": [
"string"
]
},
"additionalProp2": {
"id": {
"type": "string",
"value": "string"
},
"descr": "string",
"mgmtIp": [
"string"
]
},
"additionalProp3": {
"id": {
"type": "string",
"value": "string"
},
"descr": "string",
"mgmtIp": [
"string"
]
}
}
}
],
"name": "string",
"port": "string",
"type": "normal",
"notes": "string",
"speed": 0,
"vlans": [
{
"id": 0,
"ip": "string",
"ip6": "string",
"nic": 0,
"vlan": 0
}
],
"daosId": 0,
"server": 0,
"virtual": true,
"bondType": "lacp",
"lastSeen": 0,
"neighbor": "string",
"numaNode": 0,
"linuxName": "string",
"bondedNics": [
0
],
"bondPrimary": 0,
"ipFormatted": "string",
"vlansJoined": "string",
"ip6Formatted": "string",
"bondFormatted": "string",
"bondTypeLabel": "string",
"infinibandMac": "string",
"serverLastSeen": 0,
"speedFormatted": "string",
"numaNodeFormatted": "string",
"bondedNicsFormatted": "string"
}
]
Replace an OSDs by creating one on another disk.
Parameters{
"osds": [
{
"osd": 0,
"disk": 0,
"dbDisk": 0,
"walDisk": 0,
"encrypted": true,
"keepDbWal": true,
"resizeOsd": true
}
]
}
{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"question": {
"token": "string",
"message": "string",
"timeout": 0,
"priority": "Standard",
"timeLeft": 0,
"defaultResponse": "string",
"responseOptions": [
"string"
]
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0,
"interactive": true
}
Get the SSH keys allowed to access the managed servers.
[
"string"
]
Replace all SSH keys allowed to access the managed servers.
Parameters{
"keys": [
"string"
]
}
List disks on the server.
Parameters[
{
"id": 0,
"wwn": "string",
"info": "string",
"name": "string",
"path": "string",
"role": "unassigned",
"size": 0,
"type": "normal",
"wwns": {
"wwn": "string",
"wwnWithExtension": "string"
},
"notes": "string",
"osdId": 0,
"smart": {
"status": "string",
"details": "string",
"temperature": 0
},
"stats": {
"read": 0,
"write": 0,
"ioLoad": 0,
"iopsRead": 0,
"iopsWrite": 0,
"readFormatted": "string",
"writeFormatted": "string",
"ioLoadFormatted": "string",
"iopsReadFormatted": 0,
"iopsWriteFormatted": 0
},
"daosId": 0,
"dbDisk": 0,
"serial": "string",
"server": 0,
"status": {},
"missing": true,
"pathRaw": "string",
"serials": {
"serial": "string",
"nvmeSerial": "string",
"scsiSerial": "string",
"shortSerial": "string",
"scsiIdentSerial": "string"
},
"walDisk": 0,
"capacity": 0,
"hostname": "string",
"lastSeen": 0,
"numaNode": 0,
"bluestore": true,
"encrypted": true,
"mpathInfo": {
"info": "string",
"paths": [
{
"state": "string",
"active": true,
"diskId": 0,
"devName": "string"
}
],
"numMax": 0,
"healthy": true,
"numTotal": 0,
"numActive": 0,
"stateLabel": "string",
"pathsFormatted": "string"
},
"roleLabel": "string",
"partitions": 0,
"pciAddress": "string",
"dbPartition": 0,
"deviceClass": "hdd",
"identifyLed": true,
"multipathed": true,
"walPartition": 0,
"daemonRunning": true,
"pathFormatted": "string",
"serviceHealth": {
"memory": 0,
"uptime": 0,
"memoryFormatted": "string",
"uptimeFormatted": "string"
},
"sizeFormatted": "string",
"serverLastSeen": 0,
"usedPartitions": 0,
"osdFragmentation": 0,
"numaNodeFormatted": "string"
}
]
List free IP addresses in a subnet.
Parameters[
{
"ip": "string",
"subnetShort": "string"
}
]
List services on the server.
Parameters[
{
"id": "string",
"ip": "string",
"name": "string",
"port": 0,
"type": "osd",
"state": "creating",
"daosId": 0,
"health": {
"memory": 0,
"uptime": 0,
"memoryFormatted": "string",
"uptimeFormatted": "string"
},
"server": 0,
"status": "string",
"mdsInfo": {
"name": "string",
"rank": 0,
"status": "string",
"filesystemId": 0
},
"rgwZone": "string",
"running": true,
"sslPort": 0,
"subState": "ACTIVE",
"typeLabel": "string",
"rgwDnsName": "string",
"multiServer": [
0
]
}
]
Get the SSH host keys configured on the servers as pairs of key type, public key.
{
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
Get server passwords.
{
"ipmiPassword": "string",
"rootPassword": "string"
}
Set server passwords
Parameters{
"ipmiPassword": "string",
"rootPassword": "string"
}
{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"question": {
"token": "string",
"message": "string",
"timeout": 0,
"priority": "Standard",
"timeLeft": 0,
"defaultResponse": "string",
"responseOptions": [
"string"
]
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0,
"interactive": true
}
List all used IP addresses with their subnet.
Parameters[
{
"ip": "string",
"type": "NIC",
"subnet": {
"id": 0,
"ip": "string",
"mtu": 0,
"type": "other",
"gateway": "string",
"netmask": 0,
"poolEnd": "string",
"poolStart": "string",
"description": "string"
},
"serverId": 0,
"serviceId": 0,
"inDHCPPool": true,
"subnetShort": "string",
"serverHostname": "string"
}
]
{
"name": "string",
"nics": [
0
],
"primary": 0,
"activePassive": true
}
{
"ip": "string",
"ip6": "string",
"mac": "string",
"bond": {
"nics": [
0
],
"primary": 0,
"activePassive": true
},
"notes": "string"
}
{
"role": "unassigned",
"notes": "string",
"partitions": 0,
"identifyLed": true
}
Simple ssh test
Parameters{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0
}
List vlans configured on the nic.
Parameters[
{
"id": 0,
"ip": "string",
"ip6": "string",
"nic": 0,
"vlan": 0
}
]
{
"ip": "string",
"ip6": "string",
"vlan": 0
}
{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0
}
{
"ip": "string",
"diskId": 0
}
{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0
}
{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0
}
{
"status": "string",
"details": "string",
"temperature": 0
}
{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0
}
Start a rbd mirror daemon on the server. Only one rbd mirror daemon is allowed to run on each server.
Parameters{
"id": 0,
"done": true,
"name": "string",
"state": "WAITING",
"object": "string",
"output": "string",
"result": {},
"progress": {
"total": 0,
"complete": 0
},
"startedAt": 0,
"startedBy": "string",
"statusCode": 0
}
{
"ip": "string",
"ip6": "string",
"vlan": 0
}
Stop a service.
ParametersStart a service.
ParametersRestart a service.
ParametersStop a service or OSD.
ParametersStart a service or OSD.
ParametersRestart a service or OSD.
Parameters