daos
Configure and manage DAOS.
get /daos
Retrieve all DAOS configs.
Responses
default response
default response
array
Array of SimpleDaosConfig objects
Examples
No request body required
post /daos
Create a DAOS cluster.
Parameters
body object
Request to create a new DAOS cluster.
Responses
default response
default response
object
Examples
Request Body
{
"name": "string",
"servers": [
{
"id": 42,
"nics": [
42
],
"port": 42,
"scms": [
42
],
"nvmes": [
42
],
"targets": 42,
"threads": 42,
"provider": "string",
"accessPoint": true
}
],
"targets": 42,
"threads": 42,
"provider": "string",
"clusterName": "string",
"description": "string"
}post /daos/verify
Verify if the servers can be used to set up DAOS.
Parameters
body object
Request to create a new DAOS cluster.
Responses
default response
default response
object
Examples
Request Body
{
"name": "string",
"servers": [
{
"id": 42,
"nics": [
42
],
"port": 42,
"scms": [
42
],
"nvmes": [
42
],
"targets": 42,
"threads": 42,
"provider": "string",
"accessPoint": true
}
],
"targets": 42,
"threads": 42,
"provider": "string",
"clusterName": "string",
"description": "string"
}get /daos/{daosId}
Retrieve a DAOS cluster by ID.
Parameters
daosId integer path Required
Responses
default response
default response
object
Examples
No request body required
delete /daos/{daosId}
Delete a DAOS cluster.
Parameters
daosId integer path Required
Responses
default response
default response
object
Examples
No request body required
get /daos/{daosId}/certs
Retrieve a list of certificates for the DAOS cluster.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
post /daos/{daosId}/certs
Add a new client certificate to the DAOS cluster.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
body object
Responses
default response
default response
object
Examples
Request Body
{
"name": "string",
"description": "string"
}get /daos/{daosId}/disks
Retrieve all DAOS disks.
Parameters
daosId integer path Required
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
post /daos/{daosId}/disks
Create a new DAOS disk.
Parameters
daosId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"name": "string",
"pool": "string",
"size": 42,
"oclass": "string",
"container": "string"
}get /daos/{daosId}/pools
List all DAOS pools.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
post /daos/{daosId}/pools
Create a DAOS pool.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
body object
Examples
Request Body
{
"name": "string",
"size": 42,
"ranks": [
42
],
"nranks": 42,
"scmPerc": 42,
"properties": {}
}get /daos/{daosId}/members
Retrieve member states of the DAOS cluster.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
post /daos/{daosId}/servers
Add a server as client to DAOS.
Parameters
daosId integer path Required
body object
Server to add as a client to a DAOS cluster.
Responses
default response
default response
object
Examples
Request Body
{
"id": 42,
"nics": [
42
],
"port": 42,
"targets": 42,
"threads": 42,
"provider": "string"
}post /daos/{daosId}/ssh-test
Simple ssh test
Parameters
daosId integer path Required
DAOS cluster ID in croit.
sleep integer query
How many seconds to sleep for, repeated 5 times.
Examples
No request body required
get /daos/{daosId}/containers
Retrieve all DAOS containers in the cluster.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
get /daos/{daosId}/pool-props
Retrieve a list of known available pool properties for DAOS.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
Responses
default response
default response
array
Array of DaosProperty objects
Examples
No request body required
post /daos/{daosId}/stop-ranks
Stop a list of ranks.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
body object
Examples
Request Body
{
"ranks": [
42
]
}post /daos/{daosId}/start-ranks
Start a list of ranks.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
body object
Examples
Request Body
{
"ranks": [
42
]
}get /daos/{daosId}/pools/simple
List all DAOS pools without any query information.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
Responses
default response
default response
array
Array of DaosPoolResponse objects
Examples
No request body required
get /daos/{daosId}/pools/{pool}
Get detailed info on a single pool.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
Responses
default response
default response
object
List of items on this page. May be less than the requested limit if not enough items are available.
Examples
No request body required
delete /daos/{daosId}/pools/{pool}
Delete a DAOS pool.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
Examples
No request body required
patch /daos/{daosId}/certs/{certId}
Update a client certificate's name or description.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
certId integer path Required
Certificate ID in croit.
body object
Examples
Request Body
{
"name": "string",
"description": "string"
}delete /daos/{daosId}/certs/{certId}
Delete a client certificate from the DAOS cluster. The admin/agent/server and CA certificates cannot be deleted.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
certId integer path Required
Certificate ID in croit.
Responses
default response
default response
object
Examples
No request body required
get /daos/{daosId}/container-props
Retrieve a list of known available container properties for DAOS.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
Responses
default response
default response
array
Array of DaosProperty objects
Examples
No request body required
get /daos/{daosId}/pools/{pool}/acl
Get pool ACL.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
Responses
default response
default response
object
Examples
No request body required
put /daos/{daosId}/pools/{pool}/acl
Overwrite the pool ACL.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
body object
Examples
Request Body
{
"aclFile": "string",
"entries": [
{
"kind": "string"
}
],
"ownerUser": "string",
"ownerGroup": "string"
}post /daos/{daosId}/pools/{pool}/acl
Update or add a pool ACL entry.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
body object
Responses
default response
default response
object
Examples
Request Body
{
"acl": {
"kind": "string"
}
}delete /daos/{daosId}/pools/{pool}/acl
Delete a pool ACL entry.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
body object
Responses
default response
default response
object
Examples
Request Body
{
"acl": {
"kind": "string"
},
"group": true,
"principal": "string"
}delete /daos/{daosId}/disks/{daosDiskId}
Remove a DAOS disk.
Parameters
daosId integer path Required
daosDiskId integer path Required
Responses
default response
default response
object
Examples
No request body required
get /daos/{daosId}/pools/{pool}/props
Get pool properties.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
put /daos/{daosId}/pools/{pool}/props
Set a pool property.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
body object
Examples
Request Body
{
"name": "string",
"value": "string"
}delete /daos/{daosId}/servers/{serverId}
Remove a server from a DAOS cluster.
Parameters
daosId integer path Required
serverId integer path Required
Responses
default response
default response
object
Examples
No request body required
get /daos/{daosId}/pools/{pool}/aclFile
Get pool ACL file.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
Responses
default response
default response
string
Examples
No request body required
post /daos/{daosId}/certs/reparse-expiries
Reparse all expiries from the CRT files.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
Responses
default response
default response
object
Examples
No request body required
get /daos/{daosId}/certs/{certId}/crtFile
Download the crt file of the given certificate.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
certId integer path Required
Certificate ID in croit.
Responses
default response
default response
object
Examples
No request body required
get /daos/{daosId}/certs/{certId}/keyFile
Download the key file of the given certificate.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
certId integer path Required
Certificate ID in croit.
Responses
default response
default response
object
Examples
No request body required
get /daos/{daosId}/pools/{pool}/containers
List all DAOS containers with details in a pool.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
post /daos/{daosId}/pools/{pool}/containers
Create a DAOS container.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
body object
Responses
default response
default response
object
List of items on this page. May be less than the requested limit if not enough items are available.
Examples
Request Body
{
"name": "string",
"type": "POSIX",
"chunkSize": 42,
"properties": {},
"objectClass": "string",
"fileObjectClass": "string",
"directoryObjectClass": "string"
}post /daos/{daosId}/pools/{pool}/reintegrate
Reintegrate a DAOS rank, or all ranks available, for a pool.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
body object
Responses
default response
default response
object
Examples
Request Body
{
"rank": 42
}get /daos/{daosId}/pools/{pool}/acl-structured
Get pool ACL.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
Responses
default response
default response
array
Array of DaosAclEntry objects
Examples
No request body required
get /daos/{daosId}/pools/{pool}/containers/list
List all DAOS containers in a pool.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
post /daos/{daosId}/servers/{serverId}/reconfigure
Reconfigure and restart DAOS on the server.
Parameters
daosId integer path Required
serverId integer path Required
Responses
default response
default response
object
Examples
No request body required
get /daos/{daosId}/certs/{certId}/daos-configs.{type}
Download a tar package containing all necessary files to connect to DAOS with the chosen certificate.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
certId integer path Required
Certificate ID in croit.
type string path Required
Download as tar or as zip file.
withAdmin boolean query
Include admin config and certificate files.
Responses
default response
default response
object
Examples
No request body required
get /daos/{daosId}/pools/{pool}/containers/{container}
Get detailed info on a single container.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
container string path Required
Either the container name or the container UUID.
Responses
default response
default response
object
List of items on this page. May be less than the requested limit if not enough items are available.
Examples
No request body required
delete /daos/{daosId}/pools/{pool}/containers/{container}
Delete a DAOS container.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
container string path Required
Either the container name or the container UUID.
force boolean query
Force delete the container.
Examples
No request body required
get /daos/{daosId}/pools/{pool}/containers/{container}/acl
Get container ACL.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
container string path Required
Either the container name or the container UUID.
Responses
default response
default response
object
Examples
No request body required
put /daos/{daosId}/pools/{pool}/containers/{container}/acl
Overwrite the container ACL.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
container string path Required
Either the container name or the container UUID.
body object
Examples
Request Body
{
"aclFile": "string",
"entries": [
{
"kind": "string"
}
],
"ownerUser": "string",
"ownerGroup": "string"
}post /daos/{daosId}/pools/{pool}/containers/{container}/acl
Update or add a container ACL entry.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
container string path Required
Either the container name or the container UUID.
body object
Responses
default response
default response
object
Examples
Request Body
{
"acl": {
"kind": "string"
}
}delete /daos/{daosId}/pools/{pool}/containers/{container}/acl
Delete a container ACL entry.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
container string path Required
Either the container name or the container UUID.
body object
Responses
default response
default response
object
Examples
Request Body
{
"acl": {
"kind": "string"
},
"group": true,
"principal": "string"
}put /daos/{daosId}/pools/{pool}/containers/{container}/owner
Set a container property.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
container string path Required
Either the container name or the container UUID.
body object
Examples
Request Body
{
"group": true,
"owner": "string"
}get /daos/{daosId}/pools/{pool}/containers/{container}/props
Get container properties.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
container string path Required
Either the container name or the container UUID.
pagination object query
Pagination request. When supplied, the result will be filtered, sorted and limited according to this request object.
Responses
default response
default response
object
A paginated result.
Examples
No request body required
put /daos/{daosId}/pools/{pool}/containers/{container}/props
Set a container property.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
container string path Required
Either the container name or the container UUID.
body object
Examples
Request Body
{
"name": "string",
"value": "string"
}get /daos/{daosId}/pools/{pool}/containers/{container}/aclFile
Get container ACL file.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
container string path Required
Either the container name or the container UUID.
Responses
default response
default response
string
Examples
No request body required
get /daos/{daosId}/pools/{pool}/containers/{container}/acl-structured
Get container ACL.
Parameters
daosId integer path Required
DAOS cluster ID in croit.
pool string path Required
Either the pool name or the pool UUID.
container string path Required
Either the container name or the container UUID.
Responses
default response
default response
array
Array of DaosAclEntry objects
Examples
No request body required