daos
Configure and manage DAOS.
Retrieve all DAOS configs.
[
{
"id": 0,
"name": "string",
"clusterName": "string",
"description": "string"
}
]
Create a DAOS cluster.
Parameters{
"name": "string",
"servers": [
{
"id": 0,
"nics": [
0
],
"port": 0,
"scms": [
0
],
"nvmes": [
0
],
"targets": 0,
"threads": 0,
"provider": "string",
"accessPoint": true
}
],
"targets": 0,
"threads": 0,
"provider": "string",
"clusterName": "string",
"description": "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
}
Verify if the servers can be used to set up DAOS.
Parameters{
"name": "string",
"servers": [
{
"id": 0,
"nics": [
0
],
"port": 0,
"scms": [
0
],
"nvmes": [
0
],
"targets": 0,
"threads": 0,
"provider": "string",
"accessPoint": true
}
],
"targets": 0,
"threads": 0,
"provider": "string",
"clusterName": "string",
"description": "string"
}
{
"errors": [
{
"id": "string",
"message": "string"
}
],
"warnings": [
{
"id": "string",
"message": "string"
}
],
"daosConfig": {
"id": 0,
"name": "string",
"servers": [
{
"port": 0,
"engines": [
{
"id": 0,
"nic": {
"id": 0,
"ip": "string",
"ip6": "string",
"mac": "string",
"server": 0,
"numaNode": 0,
"linuxName": "string"
},
"port": 0,
"scms": [
{
"id": 0,
"path": "string",
"size": 0,
"server": 0,
"numaNode": 0,
"pciAddress": "string"
}
],
"nvmes": [
{
"id": 0,
"path": "string",
"size": 0,
"server": 0,
"numaNode": 0,
"pciAddress": "string"
}
],
"targets": 0,
"threads": 0,
"numaNode": 0
}
],
"provider": "string",
"serverId": 0,
"clientNode": true,
"accessPoint": true,
"nrHugepages": 0
}
],
"targets": 0,
"threads": 0,
"version": {
"major": 0,
"minor": 0,
"revision": 0
},
"provider": "string",
"clusterName": "string",
"description": "string",
"upgradeVersion": {
"major": 0,
"minor": 0,
"revision": 0
}
}
}
Retrieve a DAOS cluster by ID.
Parameters{
"id": 0,
"name": "string",
"servers": [
{
"port": 0,
"engines": [
{
"id": 0,
"nic": {
"id": 0,
"ip": "string",
"ip6": "string",
"mac": "string",
"server": 0,
"numaNode": 0,
"linuxName": "string"
},
"port": 0,
"scms": [
{
"id": 0,
"path": "string",
"size": 0,
"server": 0,
"numaNode": 0,
"pciAddress": "string"
}
],
"nvmes": [
{
"id": 0,
"path": "string",
"size": 0,
"server": 0,
"numaNode": 0,
"pciAddress": "string"
}
],
"targets": 0,
"threads": 0,
"numaNode": 0
}
],
"provider": "string",
"serverId": 0,
"clientNode": true,
"accessPoint": true,
"nrHugepages": 0
}
],
"targets": 0,
"threads": 0,
"version": {
"major": 0,
"minor": 0,
"revision": 0
},
"provider": "string",
"clusterName": "string",
"description": "string",
"upgradeVersion": {
"major": 0,
"minor": 0,
"revision": 0
}
}
Delete a DAOS cluster.
Parameters{
"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
}
Retrieve a list of certificates for the DAOS cluster.
Parameters{
"data": [
{
"id": 0,
"name": "string",
"type": "CA",
"expiry": 0,
"description": "string"
}
],
"after": 0,
"limit": 0,
"total": 0
}
Add a new client certificate to the DAOS cluster.
Parameters{
"name": "string",
"description": "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
}
Retrieve all DAOS disks.
Parameters{
"data": [
{
"id": 0,
"name": "string",
"pool": "string",
"size": 0,
"error": {
"message": "string",
"severity": "INFO"
},
"daosId": 0,
"oclass": "string",
"container": "string",
"poolLabel": "string",
"nvmeofDisks": [
0
],
"usedByNvmeof": true,
"sizeFormatted": "string",
"containerLabel": "string",
"nvmeofGateways": [
0
],
"nvmeofGatewayLabels": [
"string"
]
}
],
"after": 0,
"limit": 0,
"total": 0
}
Create a new DAOS disk.
Parameters{
"name": "string",
"pool": "string",
"size": 0,
"oclass": "string",
"container": "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 DAOS pools.
Parameters{
"data": [
{
"name": "string",
"uuid": "string",
"state": "Creating",
"daosId": 0,
"leader": 0,
"status": 0,
"rebuild": {
"state": "IDLE",
"record": 0,
"status": 0,
"objects": 0,
"stateRaw": "string"
},
"version": 0,
"stateRaw": "string",
"tierStats": [
{
"max": 0,
"min": 0,
"free": 0,
"mean": 0,
"total": 0,
"mediaType": "SCM",
"mediaTypeRaw": "string"
}
],
"enginesTotal": 0,
"targetsTotal": 0,
"targetsActive": 0,
"targetsDisabled": 0,
"poolLayoutVersion": 0,
"upgradeLayoutVersion": 0
}
],
"after": 0,
"limit": 0,
"total": 0
}
Create a DAOS pool.
Parameters{
"name": "string",
"size": 0,
"ranks": [
0
],
"nranks": 0,
"scmPerc": 0,
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
Retrieve member states of the DAOS cluster.
Parameters{
"data": [
{
"addr": "string",
"info": "string",
"rank": 0,
"uuid": "string",
"state": "AwaitFormat",
"serverId": 0,
"stateRaw": "string",
"fabricUri": "string",
"lastUpdate": "string",
"faultDomain": "string",
"incarnation": 0,
"fabricContexts": 0
}
],
"after": 0,
"limit": 0,
"total": 0
}
Add a server as client to DAOS.
Parameters{
"id": 0,
"nics": [
0
],
"port": 0,
"targets": 0,
"threads": 0,
"provider": "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
}
Simple ssh test
ParametersRetrieve all DAOS containers in the cluster.
Parameters{
"data": [
{
"name": "string",
"pool": "string",
"type": "POSIX",
"uuid": "string",
"hints": "string",
"daosId": 0,
"typeRaw": "string",
"openTime": 0,
"chunkSize": 0,
"numHandles": 0,
"objectClass": "string",
"numSnapshots": 0,
"dirObjectClass": "string",
"latestSnapshot": 0,
"closeModifyTime": 0,
"fileObjectClass": "string",
"redundancyFactor": 0
}
],
"after": 0,
"limit": 0,
"total": 0
}
Retrieve a list of known available pool properties for DAOS.
Parameters[
{
"name": "string",
"type": "String",
"unit": "Percentage",
"allowed": [
{}
],
"editable": true,
"description": "string"
}
]
Stop a list of ranks.
Parameters{
"ranks": [
0
]
}
Start a list of ranks.
Parameters{
"ranks": [
0
]
}
List all DAOS pools without any query information.
Parameters[
{
"name": "string",
"uuid": "string"
}
]
Get detailed info on a single pool.
Parameters{
"name": "string",
"uuid": "string",
"state": "Creating",
"daosId": 0,
"leader": 0,
"status": 0,
"rebuild": {
"state": "IDLE",
"record": 0,
"status": 0,
"objects": 0,
"stateRaw": "string"
},
"version": 0,
"stateRaw": "string",
"tierStats": [
{
"max": 0,
"min": 0,
"free": 0,
"mean": 0,
"total": 0,
"mediaType": "SCM",
"mediaTypeRaw": "string"
}
],
"enginesTotal": 0,
"targetsTotal": 0,
"targetsActive": 0,
"targetsDisabled": 0,
"poolLayoutVersion": 0,
"upgradeLayoutVersion": 0
}
Delete a DAOS pool.
ParametersUpdate a client certificate's name or description.
Parameters{
"name": "string",
"description": "string"
}
Delete a client certificate from the DAOS cluster. The admin/agent/server and CA certificates cannot be deleted.
Parameters{
"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
}
Retrieve a list of known available container properties for DAOS.
Parameters[
{
"name": "string",
"type": "String",
"unit": "Percentage",
"allowed": [
{}
],
"editable": true,
"description": "string"
}
]
Get pool ACL.
Parameters{
"entries": [
{}
],
"ownerUser": "string",
"entriesRaw": [
"string"
],
"ownerGroup": "string"
}
Overwrite the pool ACL.
Parameters{
"aclFile": "string",
"entries": [
{}
],
"ownerUser": "string",
"ownerGroup": "string"
}
Update or add a pool ACL entry.
Parameters{
"acl": {}
}
{
"entries": [
{}
],
"ownerUser": "string",
"entriesRaw": [
"string"
],
"ownerGroup": "string"
}
Delete a pool ACL entry.
Parameters{
"acl": {},
"group": true,
"principal": "string"
}
{
"entries": [
{}
],
"ownerUser": "string",
"entriesRaw": [
"string"
],
"ownerGroup": "string"
}
Remove a DAOS disk.
Parameters{
"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 pool properties.
Parameters{
"data": [
{
"name": "string",
"value": {},
"description": "string"
}
],
"after": 0,
"limit": 0,
"total": 0
}
Set a pool property.
Parameters{
"name": "string",
"value": "string"
}
Remove a server from a DAOS cluster.
Parameters{
"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 pool ACL file.
Parameters"string"
Reparse all expiries from the CRT files.
Parameters{
"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
}
Download the crt file of the given certificate.
Parameters{
"url": "string",
"fileName": "string",
"fileContents": "string"
}
Download the key file of the given certificate.
Parameters{
"url": "string",
"fileName": "string",
"fileContents": "string"
}
List all DAOS containers with details in a pool.
Parameters{
"data": [
{
"name": "string",
"pool": "string",
"type": "POSIX",
"uuid": "string",
"hints": "string",
"daosId": 0,
"typeRaw": "string",
"openTime": 0,
"chunkSize": 0,
"numHandles": 0,
"objectClass": "string",
"numSnapshots": 0,
"dirObjectClass": "string",
"latestSnapshot": 0,
"closeModifyTime": 0,
"fileObjectClass": "string",
"redundancyFactor": 0
}
],
"after": 0,
"limit": 0,
"total": 0
}
Create a DAOS container.
Parameters{
"name": "string",
"type": "POSIX",
"chunkSize": 0,
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"objectClass": "string",
"fileObjectClass": "string",
"directoryObjectClass": "string"
}
{
"name": "string",
"pool": "string",
"type": "POSIX",
"uuid": "string",
"hints": "string",
"daosId": 0,
"typeRaw": "string",
"openTime": 0,
"chunkSize": 0,
"numHandles": 0,
"objectClass": "string",
"numSnapshots": 0,
"dirObjectClass": "string",
"latestSnapshot": 0,
"closeModifyTime": 0,
"fileObjectClass": "string",
"redundancyFactor": 0
}
Reintegrate a DAOS rank, or all ranks available, for a pool.
Parameters{
"rank": 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
}
Get pool ACL.
Parameters[
{}
]
List all DAOS containers in a pool.
Parameters{
"data": [
{
"name": "string",
"uuid": "string"
}
],
"after": 0,
"limit": 0,
"total": 0
}
Reconfigure and restart DAOS on the server.
Parameters{
"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
}
Download a tar package containing all necessary files to connect to DAOS with the chosen certificate.
Parameters{
"url": "string",
"fileName": "string",
"fileContents": "string"
}
Get detailed info on a single container.
Parameters{
"name": "string",
"pool": "string",
"type": "POSIX",
"uuid": "string",
"hints": "string",
"daosId": 0,
"typeRaw": "string",
"openTime": 0,
"chunkSize": 0,
"numHandles": 0,
"objectClass": "string",
"numSnapshots": 0,
"dirObjectClass": "string",
"latestSnapshot": 0,
"closeModifyTime": 0,
"fileObjectClass": "string",
"redundancyFactor": 0
}
Delete a DAOS container.
ParametersGet container ACL.
Parameters{
"entries": [
{}
],
"ownerUser": "string",
"entriesRaw": [
"string"
],
"ownerGroup": "string"
}
Overwrite the container ACL.
Parameters{
"aclFile": "string",
"entries": [
{}
],
"ownerUser": "string",
"ownerGroup": "string"
}
Update or add a container ACL entry.
Parameters{
"acl": {}
}
{
"entries": [
{}
],
"ownerUser": "string",
"entriesRaw": [
"string"
],
"ownerGroup": "string"
}
Delete a container ACL entry.
Parameters{
"acl": {},
"group": true,
"principal": "string"
}
{
"entries": [
{}
],
"ownerUser": "string",
"entriesRaw": [
"string"
],
"ownerGroup": "string"
}
Set a container property.
Parameters{
"group": true,
"owner": "string"
}
Get container properties.
Parameters{
"data": [
{
"name": "string",
"value": {},
"description": "string"
}
],
"after": 0,
"limit": 0,
"total": 0
}
Set a container property.
Parameters{
"name": "string",
"value": "string"
}
Get container ACL file.
Parameters"string"
Get container ACL.
Parameters[
{}
]