services
Manage services, this includes both Ceph services and croit-specific services running on both the ceph servers and management node.
get /services
List of all services across all servers.
Parameters
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
oneOf A response that can be either paginated or a raw list (depending on the presence of the pagination query parameter).
object
A paginated result.
Examples
No request body required
get /gateways/nfs
List all nfs clusters.
Parameters
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 /gateways/smb
List all SMB clusters with their config.
Parameters
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 /services/smb
Create a new simple SMB cluster.
Parameters
body object
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"shares": [
{
"path": "string",
"type": "string",
"share": "string",
"ro": true,
"rw": true,
"guest": true
}
],
"servers": [
{
"nic": 42,
"vlan": 42,
"server": 42,
"domainAdminUser": "string",
"domainAdminPassword": "string"
}
],
"virtualIps": [
"string"
],
"description": "string",
"adminPassword": "string",
"readonlyPassword": "string"
}post /services/stop
Stop services or OSDs.
Parameters
body array
Array of ServiceControlRequest objects
Examples
Request Body
[
{
"id": 42,
"osd": true,
"server": 42
}
]get /gateways/iscsi
List all iSCSI gateways.
Parameters
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 /services/iscsi
Create a new iSCSI gateway service.
Parameters
body object
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"servers": [
{
"ip": "string",
"serverId": 42
}
],
"description": "string"
}post /services/start
Start services or OSDs.
Parameters
body array
Array of ServiceControlRequest objects
Examples
Request Body
[
{
"id": 42,
"osd": true,
"server": 42
}
]get /gateways/nvmeof
List all NVMe-oF clusters.
Parameters
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 /gateways/nvmeof
Add a new NVMe-oF cluster.
Parameters
body object
Responses
default response
default response
object
Examples
Request Body
{
"name": "string",
"services": [
{
"serverId": 42,
"listeners": [
{
"port": 42,
"type": "TCP",
"nicId": 42,
"secure": true,
"vlanId": 42
}
],
"transports": [
{
"type": "TCP",
"maxIoSize": 42,
"ioUnitSize": 42,
"inCapsuleDataSize": 42,
"maxIoQpairsPerCtrlr": 42
}
],
"description": "string",
"nrHugepages": 42
}
],
"description": "string",
"forceSecure": true,
"transportDefaults": [
{
"type": "TCP",
"maxIoSize": 42,
"ioUnitSize": 42,
"inCapsuleDataSize": 42,
"maxIoQpairsPerCtrlr": 42
}
]
}post /services/restart
Restart services or OSDs.
Parameters
body array
Array of ServiceControlRequest objects
Examples
Request Body
[
{
"id": 42,
"osd": true,
"server": 42
}
]post /services/{id}/stop
Stop a service.
Parameters
id integer path Required
server integer query
Required for multi-server services
Examples
No request body required
get /gateways/smb/shares
List all SMB shares.
Parameters
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 /services/{id}/start
Start a service.
Parameters
id integer path Required
server integer query
Required for multi-server services
Examples
No request body required
get /gateways/iscsi/disks
List all iSCSI disks.
Parameters
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 /gateways/iscsi/hosts
List all iSCSI hosts.
Parameters
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 /gateways/nfs/exports
List all nfs exports.
Parameters
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 /gateways/nfs/servers
List all nfs servers.
Parameters
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 /gateways/smb/servers
List all SMB servers.
Parameters
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
patch /services/{serviceId}
Update a service.
Parameters
serviceId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"port": 42,
"rgwZone": "string",
"sslPort": 42,
"rgwDnsName": "string",
"description": "string"
}delete /services/{serviceId}
Delete a service.
Parameters
serviceId integer path Required
server integer query
Required for multi-server services
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
No request body required
get /gateways/iscsi/groups
List all iSCSI groups.
Parameters
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 /gateways/nvmeof/disks
List all NVMe-oF disks.
Parameters
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 /gateways/nvmeof/disks
Add a new NVMe-oF disk.
Parameters
body object
Responses
default response
default response
object
Examples
Request Body
{
"pool": "string",
"type": "CEPH",
"image": "string",
"daosId": 42,
"oclass": "string",
"cluster": "string",
"daosDisk": 42,
"daosPool": "string",
"blockSize": 42,
"gatewayId": 42,
"namespace": "string",
"totalSize": 42,
"subsystems": [
42
],
"daosDiskName": "string",
"daosContainer": "string"
}get /gateways/nvmeof/hosts
List all NVMe-oF hosts.
Parameters
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 /gateways/nvmeof/hosts
Add a new NVMe-oF host.
Parameters
body object
Responses
default response
default response
object
Examples
Request Body
{
"nqn": "string",
"gatewayId": 42,
"sharedKey": "string",
"subsystems": [
42
]
}post /services/nfs-gateways
Create a new NFS cluster.
Parameters
body object
Responses
default response
default response
object
Examples
Request Body
{
"exports": [
{
"path": "string",
"access": [
{
"rw": true,
"subnet": "string"
}
],
"nfsPath": "string",
"protocols": {
"nfs3": true,
"nfs4": true
},
"filesystem": "string"
}
],
"servers": [
42
],
"description": "string"
}post /services/{id}/restart
Restart a service.
Parameters
id integer path Required
server integer query
Required for multi-server services
Examples
No request body required
get /gateways/iscsi/servers
List all iSCSI servers.
Parameters
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 /gateways/nvmeof/services
List all NVMe-oF services.
Parameters
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 /services/rolling-restart
Performs a rolling restart on the provided services or OSDs.
Each service is restarted one after another. Should one of the services fail to restart, the rolling restart will be stopped. Only one rolling restart will run at a time, i.e.multiple calls to this endpoint won't run in parallel.
Parameters
body array
Array of ServiceControlRequest objects
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
[
{
"id": 42,
"osd": true,
"server": 42
}
]get /services/smb/{serviceId}
Get SMB cluster config and state.
Parameters
serviceId integer path Required
Responses
default response
default response
object
Examples
No request body required
patch /services/smb/{serviceId}
Update an SMB cluster.
Parameters
serviceId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"dnsServers": [
"string"
],
"virtualIps": [
"string"
],
"description": "string",
"adminPassword": "string",
"domainController": "string",
"readonlyPassword": "string"
}delete /services/smb/{serviceId}
Delete an SMB cluster.
Parameters
serviceId integer path Required
Examples
No request body required
get /gateways/nvmeof/listeners
List all NVMe-oF listeners.
Parameters
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 /services/{type}/{id}/stop
Stop a service or OSD.
Parameters
type enum path Required
osdsmonsradosgwsmdsmgrsnfs_gatewaysiscsissmbsrbd_mirrorsdaos_serverdaos_agentnvmf_tgts
id integer path Required
The service ID, or in case of an OSD the daemon ID.
server integer query
Required for multi-server services
Examples
No request body required
get /gateways/nvmeof/subsystems
List all NVMe-oF subsystems.
Parameters
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 /gateways/nvmeof/subsystems
Add a new NVMe-oF subsystem.
Parameters
body object
Responses
default response
default response
object
Examples
Request Body
{
"nqn": "string",
"gatewayId": 42
}get /services/iscsi/{serviceId}
Get configuration of an iSCSI gateway
Parameters
serviceId integer path Required
Responses
default response
default response
object
Examples
No request body required
post /services/iscsi/{serviceId}
Add a server to an existing iSCSI gateway service.
Parameters
serviceId integer path Required
body object
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"ip": "string",
"serverId": 42
}patch /services/iscsi/{serviceId}
Update an iSCSI gateway.
Parameters
serviceId integer path Required
body object
Examples
Request Body
{
"description": "string"
}delete /services/iscsi/{serviceId}
Delete an iSCSI service.
Parameters
serviceId integer path Required
Examples
No request body required
post /services/{type}/{id}/start
Start a service or OSD.
Parameters
type enum path Required
osdsmonsradosgwsmdsmgrsnfs_gatewaysiscsissmbsrbd_mirrorsdaos_serverdaos_agentnvmf_tgts
id integer path Required
The service ID, or in case of an OSD the daemon ID.
server integer query
Required for multi-server services
Examples
No request body required
post /gateways/nvmeof/{gatewayId}
Add a new NVMe-oF service.
Parameters
gatewayId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"serverId": 42,
"listeners": [
{
"port": 42,
"type": "TCP",
"nicId": 42,
"secure": true,
"vlanId": 42
}
],
"transports": [
{
"type": "TCP",
"maxIoSize": 42,
"ioUnitSize": 42,
"inCapsuleDataSize": 42,
"maxIoQpairsPerCtrlr": 42
}
],
"description": "string",
"nrHugepages": 42
}patch /gateways/nvmeof/{gatewayId}
Update name or description of an NVMe-oF cluster.
Parameters
gatewayId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"name": "string",
"description": "string",
"forceSecure": true,
"transportDefaults": [
{
"type": "TCP",
"maxIoSize": 42,
"ioUnitSize": 42,
"inCapsuleDataSize": 42,
"maxIoQpairsPerCtrlr": 42
}
]
}delete /gateways/nvmeof/{gatewayId}
Delete an NVMe-oF cluster. This also deletes all services and configuration associated with the cluster.
Parameters
gatewayId integer path Required
Responses
default response
default response
object
Examples
No request body required
post /services/{type}/{id}/restart
Restart a service or OSD.
Parameters
type enum path Required
osdsmonsradosgwsmdsmgrsnfs_gatewaysiscsissmbsrbd_mirrorsdaos_serverdaos_agentnvmf_tgts
id integer path Required
The service ID, or in case of an OSD the daemon ID.
server integer query
Required for multi-server services
Examples
No request body required
get /gateways/nvmeof/ceph-clusters
List all NVMe-oF ceph cluster configurations.
Parameters
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 /gateways/nvmeof/ceph-clusters
Add a new NVMe-oF ceph cluster configuration.
Parameters
body object
Responses
default response
default response
object
Examples
Request Body
{
"name": "string",
"clientId": "string"
}patch /gateways/nvmeof/disks/{diskId}
Update an NVMe-oF disk.
Parameters
diskId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"size": 42
}delete /gateways/nvmeof/disks/{diskId}
Remove a NVMe-oF disk.
Parameters
diskId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"deleteData": true
}put /gateways/nvmeof/hosts/{hostId}
Update an NVMe-oF host.
Parameters
hostId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"sharedKey": "string"
}delete /gateways/nvmeof/hosts/{hostId}
Remove an NVMe-oF host.
Parameters
hostId integer path Required
Responses
default response
default response
object
Examples
No request body required
post /services/smb/{serviceId}/shares
Add a share to an SMB cluster.
Parameters
serviceId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"path": "string",
"type": "string",
"share": "string"
}get /services/iscsi/{serviceId}/disks
Get configured iSCSI RBDs
Parameters
serviceId integer path Required
details boolean query
Include image details
Responses
default response
default response
object
Examples
No request body required
post /services/smb/{serviceId}/servers
Add a server to an SMB cluster.
Parameters
serviceId integer path Required
body object
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"nic": 42,
"vlan": 42,
"server": 42,
"domainAdminUser": "string",
"domainAdminPassword": "string"
}put /services/iscsi/{serviceId}/target
Set iSCSI target to be used in other endpoints
Parameters
serviceId integer path Required
body string
Examples
Request Body
"string"get /services/nfs-gateways/{serviceId}
Get an NFS cluster configuration.
Parameters
serviceId integer path Required
Responses
default response
default response
object
Examples
No request body required
patch /services/nfs-gateways/{serviceId}
Update an NFS cluster.
Parameters
serviceId integer path Required
body object
Examples
Request Body
{
"servers": [
42
],
"description": "string"
}delete /gateways/nvmeof/ceph-clusters/{name}
Remove a NVMe-oF ceph cluster configuration.
Parameters
name string path Required
Responses
default response
default response
object
Examples
No request body required
patch /services/iscsi/{serviceId}/disks/{wwn}
Update parameters for an exported RBD image.
Parameters
serviceId integer path Required
wwn string path Required
body object
Examples
Request Body
{
"size": 42
}delete /services/iscsi/{serviceId}/disks/{wwn}
Delete an iSCSI-managed disk
Parameters
serviceId integer path Required
wwn string path Required
body object
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"pool": "string",
"image": "string",
"deleteData": true
}post /gateways/nvmeof/{gatewayId}/reconfigure
Reconfigure the NVMe-oF cluster.
Parameters
gatewayId integer path Required
fromScratch boolean query
Responses
default response
default response
object
Examples
No request body required
patch /gateways/nvmeof/subsystems/{subsystemId}
Update an NVMe-oF subsystem.
Parameters
subsystemId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"modelNumber": "string",
"serialNumber": "string",
"maxNamespaces": 42
}delete /gateways/nvmeof/subsystems/{subsystemId}
Remove an NVMe-oF subsystem.
Parameters
subsystemId integer path Required
Responses
default response
default response
object
Examples
No request body required
put /services/iscsi/{serviceId}/clients/{name}
Configure a new iSCSI client
Parameters
serviceId integer path Required
name string path Required
body object
Examples
Request Body
{
"group": "string",
"password": "string",
"username": "string"
}patch /services/iscsi/{serviceId}/clients/{name}
Change a client's username/password
Parameters
serviceId integer path Required
name string path Required
body object
Examples
Request Body
{
"password": "string",
"username": "string"
}delete /services/iscsi/{serviceId}/clients/{name}
Delete an iSCSI client
Parameters
serviceId integer path Required
name string path Required
Examples
No request body required
put /services/iscsi/{serviceId}/groups/{group}
Create a new host group.
Parameters
serviceId integer path Required
group string path Required
Examples
No request body required
delete /services/iscsi/{serviceId}/groups/{group}
Delete a host group.
Parameters
serviceId integer path Required
group string path Required
Examples
No request body required
get /services/nfs-gateways/{serviceId}/exports
Get exports of an NFS cluster.
Parameters
serviceId integer path Required
Responses
default response
default response
array
Array of NfsGatewayExport objects
Examples
No request body required
post /services/nfs-gateways/{serviceId}/exports
Add an export to the NFS cluster.
Parameters
serviceId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"path": "string",
"access": [
{
"rw": true,
"subnet": "string"
}
],
"nfsPath": "string",
"protocols": {
"nfs3": true,
"nfs4": true
},
"filesystem": "string"
}get /services/nfs-gateways/{serviceId}/servers
Get servers that are part of this cluster.
Parameters
serviceId integer path Required
Responses
default response
default response
array
Array of integer items
Examples
No request body required
post /services/smb/{serviceId}/service-dns-name
Change the service DNS name of an SMB cluster.
Parameters
serviceId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"joinServer": 42,
"serviceDnsName": "string",
"domainAdminUser": "string",
"domainAdminPassword": "string"
}put /services/smb/{serviceId}/shares/{shareId}
Replace a share on an SMB cluster.
Parameters
serviceId integer path Required
shareId integer path Required
body object
Examples
Request Body
{
"path": "string",
"type": "string",
"share": "string"
}delete /services/smb/{serviceId}/shares/{shareId}
Remove a share from an SMB cluster.
Parameters
serviceId integer path Required
shareId integer path Required
Examples
No request body required
post /services/iscsi/{serviceId}/terminal/connect
Connect to the ceph-iscsi config shell
Parameters
serviceId integer path Required
Responses
default response
default response
object
Examples
No request body required
delete /services/smb/{serviceId}/servers/{serverId}
Remove a server from an SMB cluster.
Parameters
serviceId integer path Required
serverId integer path Required
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
No request body required
post /services/smb/active-directory-authentication
Create a new SMB cluster using Active Directory for authentication.
Parameters
body object
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
Request Body
{
"domain": "string",
"shares": [
{
"path": "string",
"type": "string",
"share": "string",
"roUsers": [
"string"
],
"rwUsers": [
"string"
]
}
],
"servers": [
{
"nic": 42,
"vlan": 42,
"server": 42,
"domainAdminUser": "string",
"domainAdminPassword": "string"
}
],
"dnsServers": [
"string"
],
"virtualIps": [
"string"
],
"description": "string",
"joinWithSssd": true,
"serviceDnsName": "string",
"domainController": "string",
"netbiosDomainName": "string"
}delete /services/iscsi/{serviceId}/servers/{hostname}
Remove a server from an existing iSCSI gateway service.
Parameters
serviceId integer path Required
hostname string path Required
Responses
default response
default response
object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
Examples
No request body required
put /services/iscsi/{serviceId}/clients/{name}/disks
Add new disk(s) to an iSCSI client
Parameters
serviceId integer path Required
name string path Required
body array
RBD image will be created if it doesn't exist yet (Array of IscsiAddDiskToClientRequest objects)
Examples
Request Body
[
{
"name": "string",
"pool": "string",
"size": 42,
"backstore": "user:rbd"
}
]delete /services/iscsi/{serviceId}/clients/{name}/disks
Unmap a disk from an iSCSI client
Parameters
serviceId integer path Required
name string path Required
body object
Examples
Request Body
{
"name": "string",
"pool": "string"
}put /services/iscsi/{serviceId}/groups/{group}/disks
Add disks to a host group.
Parameters
serviceId integer path Required
group string path Required
body array
Array of IscsiAddDiskToClientRequest objects
Examples
Request Body
[
{
"name": "string",
"pool": "string",
"size": 42,
"backstore": "user:rbd"
}
]delete /services/iscsi/{serviceId}/groups/{group}/disks
Remove a disk from a host group.
Parameters
serviceId integer path Required
group string path Required
body object
Examples
Request Body
{
"name": "string",
"pool": "string"
}put /services/iscsi/{serviceId}/groups/{group}/hosts
Add hosts to a host group.
Parameters
serviceId integer path Required
group string path Required
body array
Array of string items
Examples
Request Body
[
"string"
]delete /services/iscsi/{serviceId}/groups/{group}/hosts
Remove hosts from a host group.
Parameters
serviceId integer path Required
group string path Required
body array
Array of string items
Examples
Request Body
[
"string"
]patch /gateways/nvmeof/{gatewayId}/services/{serviceId}
Update a NVMe-oF service.
Parameters
gatewayId integer path Required
serviceId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"anaState": "optimized",
"listeners": [
{
"port": 42,
"type": "TCP",
"nicId": 42,
"secure": true,
"vlanId": 42
}
],
"transports": [
{
"type": "TCP",
"maxIoSize": 42,
"ioUnitSize": 42,
"inCapsuleDataSize": 42,
"maxIoQpairsPerCtrlr": 42
}
],
"description": "string",
"nrHugepages": 42
}put /services/nfs-gateways/{serviceId}/exports/{exportId}
Replace an export entry on the NFS cluster.
Parameters
serviceId integer path Required
exportId integer path Required
body object
Examples
Request Body
{
"path": "string",
"access": [
{
"rw": true,
"subnet": "string"
}
],
"nfsPath": "string",
"protocols": {
"nfs3": true,
"nfs4": true
},
"filesystem": "string"
}delete /services/nfs-gateways/{serviceId}/exports/{exportId}
Remove an export entry from the NFS cluster.
Parameters
serviceId integer path Required
exportId integer path Required
Examples
No request body required
post /gateways/nvmeof/subsystems/{subsystemId}/attach-disks
Attach disks to an NVMe-oF subsystem.
Parameters
subsystemId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"disks": [
42
]
}post /gateways/nvmeof/subsystems/{subsystemId}/attach-hosts
Attach hosts to an NVMe-oF subsystem.
Parameters
subsystemId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"hosts": [
42
]
}post /gateways/nvmeof/subsystems/{subsystemId}/detach-disks
Detach disks from an NVMe-oF subsystem.
Parameters
subsystemId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"disks": [
42
]
}post /gateways/nvmeof/subsystems/{subsystemId}/detach-hosts
Detach hosts from an NVMe-oF subsystem.
Parameters
subsystemId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"hosts": [
42
]
}put /services/iscsi/{serviceId}/groups/{group}/hosts/{host}
Add a host to a host group.
Parameters
serviceId integer path Required
group string path Required
host string path Required
Examples
No request body required
delete /services/iscsi/{serviceId}/groups/{group}/hosts/{host}
Remove a host from a host group.
Parameters
serviceId integer path Required
group string path Required
host string path Required
Examples
No request body required
delete /gateways/nvmeof/{gatewayId}/services/{serviceId}/errors
Forget any config errors associated with this service.
Parameters
gatewayId integer path Required
serviceId integer path Required
Examples
No request body required
post /gateways/nvmeof/{gatewayId}/services/{serviceId}/listeners
Add a new listener to an NVMe-oF service.
Parameters
gatewayId integer path Required
serviceId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"port": 42,
"type": "TCP",
"nicId": 42,
"secure": true,
"vlanId": 42
}delete /gateways/nvmeof/{gatewayId}/services/{serviceId}/transports/{type}
Delete a transport configuration.
Parameters
gatewayId integer path Required
serviceId integer path Required
type enum path Required
TCPRDMA
Responses
default response
default response
object
Examples
No request body required
patch /gateways/nvmeof/{gatewayId}/services/{serviceId}/listeners/{listenerId}
Update an NVMe-oF listener's configuration.
Parameters
gatewayId integer path Required
serviceId integer path Required
listenerId integer path Required
body object
Responses
default response
default response
object
Examples
Request Body
{
"port": 42,
"secure": true
}delete /gateways/nvmeof/{gatewayId}/services/{serviceId}/listeners/{listenerId}
Delete a listener from an NVMe-oF service.
Parameters
gatewayId integer path Required
serviceId integer path Required
listenerId integer path Required
Responses
default response
default response
object
Examples
No request body required