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 string query
Responses
200 successful operation
MultiServerServiceResponse array
MultiServerServiceResponse object 
[
  {
    "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 /gateways/nfs

List all nfs clusters.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseNfsGatewayConfigResponse object
A paginated result.
{
  "data": [
    {
      "serviceId": 0,
      "description": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
get /gateways/smb

List all SMB clusters with their config.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseSmbGatewayConfigResponse object
A paginated result.
{
  "data": [
    {
      "type": "SIMPLE",
      "domain": "string",
      "serviceId": 0,
      "dnsServers": [
        "string"
      ],
      "virtualIps": [
        "string"
      ],
      "description": "string",
      "joinWithSssd": true,
      "serviceDnsName": "string",
      "domainController": "string",
      "netbiosDomainName": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
post /services/smb

Create a new simple SMB cluster.

Parameters
body object 
{
  "shares": [
    null
  ],
  "servers": [
    {
      "nic": 0,
      "vlan": 0,
      "server": 0,
      "domainAdminUser": "string",
      "domainAdminPassword": "string"
    }
  ],
  "virtualIps": [
    "string"
  ],
  "description": "string",
  "adminPassword": "string",
  "readonlyPassword": "string"
}
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
post /services/stop

Stop services or OSDs.

Parameters
body array
ServiceControlRequest object 
[
  {
    "id": 0,
    "osd": true,
    "server": 0
  }
]
Responses
default successful operation
get /gateways/iscsi

List all iSCSI gateways.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseIscsiGatewayConfigResponse object
A paginated result.
{
  "data": [
    {
      "serviceId": 0,
      "description": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
post /services/iscsi

Create a new iSCSI gateway service.

Parameters
body object 
{
  "servers": [
    {
      "ip": "string",
      "serverId": 0
    }
  ],
  "description": "string"
}
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
post /services/start

Start services or OSDs.

Parameters
body array
ServiceControlRequest object 
[
  {
    "id": 0,
    "osd": true,
    "server": 0
  }
]
Responses
default successful operation
get /gateways/nvmeof

List all NVMe-oF clusters.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseNvmeOFGatewayResponse object
A paginated result.
{
  "data": [
    {
      "name": "string",
      "hints": [
        {
          "message": "string",
          "severity": "INFO"
        }
      ],
      "gatewayId": 0,
      "description": "string",
      "forceSecure": true,
      "transportDefaults": [
        {
          "type": "TCP",
          "maxIoSize": 0,
          "ioUnitSize": 0,
          "inCapsuleDataSize": 0,
          "maxIoQpairsPerCtrlr": 0
        }
      ]
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
post /gateways/nvmeof

Add a new NVMe-oF cluster.

Parameters
body object 
{
  "name": "string",
  "services": [
    {
      "anaState": "optimized",
      "serverId": 0,
      "listeners": [
        {
          "port": 0,
          "type": "TCP",
          "nicId": 0,
          "secure": true,
          "vlanId": 0
        }
      ],
      "transports": [
        {
          "type": "TCP",
          "maxIoSize": 0,
          "ioUnitSize": 0,
          "inCapsuleDataSize": 0,
          "maxIoQpairsPerCtrlr": 0
        }
      ],
      "description": "string",
      "nrHugepages": 0
    }
  ],
  "description": "string",
  "forceSecure": true,
  "transportDefaults": [
    {
      "type": "TCP",
      "maxIoSize": 0,
      "ioUnitSize": 0,
      "inCapsuleDataSize": 0,
      "maxIoQpairsPerCtrlr": 0
    }
  ]
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
post /services/restart

Restart services or OSDs.

Parameters
body array
ServiceControlRequest object 
[
  {
    "id": 0,
    "osd": true,
    "server": 0
  }
]
Responses
default successful operation
post /services/{id}/stop

Stop a service.

Parameters
id integer path Required
server integer query
Required for multi-server services
Responses
default successful operation
get /gateways/smb/shares

List all SMB shares.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseSmbGatewayShareResponse object
A paginated result.
{
  "data": [
    {
      "id": 0,
      "ro": true,
      "rw": true,
      "path": "string",
      "type": "string",
      "guest": true,
      "share": "string",
      "roUsers": [
        "string"
      ],
      "rwUsers": [
        "string"
      ],
      "serviceId": 0,
      "roUsersFormatted": "string",
      "rwUsersFormatted": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
post /services/{id}/start

Start a service.

Parameters
id integer path Required
server integer query
Required for multi-server services
Responses
default successful operation
get /gateways/iscsi/disks

List all iSCSI disks.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseIscsiGatewayDisksResponse object
A paginated result.
{
  "data": [
    {
      "wwn": "string",
      "pool": "string",
      "hosts": [
        "string"
      ],
      "image": "string",
      "lunId": 0,
      "groups": [
        "string"
      ],
      "serviceId": 0
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
get /gateways/iscsi/hosts

List all iSCSI hosts.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseIscsiGatewayHostsResponse object
A paginated result.
{
  "data": [
    {
      "iqn": "string",
      "luns": [
        {
          "wwn": "string",
          "pool": "string",
          "hosts": [
            "string"
          ],
          "image": "string",
          "lunId": 0,
          "groups": [
            "string"
          ],
          "serviceId": 0
        }
      ],
      "group": "string",
      "password": "string",
      "username": "string",
      "serviceId": 0
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
get /gateways/nfs/exports

List all nfs exports.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseNfsGatewayExportResponse object
A paginated result.
{
  "data": [
    {
      "id": 0,
      "path": "string",
      "access": [
        {
          "rw": true,
          "subnet": "string"
        }
      ],
      "nfsPath": "string",
      "protocols": {
        "nfs3": true,
        "nfs4": true
      },
      "serviceId": 0,
      "filesystem": "string",
      "accessJoined": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
get /gateways/nfs/servers

List all nfs servers.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseNfsGatewayServerResponse object
A paginated result.
{
  "data": [
    {
      "ip": "string",
      "healthy": true,
      "hostname": "string",
      "serverId": 0,
      "serviceId": 0
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
get /gateways/smb/servers

List all SMB servers.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseSmbGatewayServerResponse object
A paginated result.
{
  "data": [
    {
      "ip": "string",
      "mac": "string",
      "nic": "string",
      "vlan": 0,
      "server": 0,
      "healthy": true,
      "virtualIps": [
        "string"
      ]
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
patch /services/{serviceId}

Update a service.

Parameters
serviceId integer path Required
body object 
{
  "port": 0,
  "rgwZone": "string",
  "sslPort": 0,
  "rgwDnsName": "string",
  "description": "string"
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
delete /services/{serviceId}

Delete a service.

Parameters
serviceId integer path Required
server integer query
Required for multi-server services
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
get /gateways/iscsi/groups

List all iSCSI groups.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseIscsiGatewayGroupsResponse object
A paginated result.
{
  "data": [
    {
      "luns": [
        {
          "wwn": "string",
          "pool": "string",
          "hosts": [
            "string"
          ],
          "image": "string",
          "lunId": 0,
          "groups": [
            "string"
          ],
          "serviceId": 0
        }
      ],
      "group": "string",
      "members": [
        "string"
      ],
      "serviceId": 0
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
get /gateways/nvmeof/disks

List all NVMe-oF disks.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseNvmeOFDiskResponse object
A paginated result.
{
  "data": [
    {
      "id": 0,
      "pool": "string",
      "size": 0,
      "type": "CEPH",
      "hints": [
        {
          "message": "string",
          "severity": "INFO"
        }
      ],
      "hosts": [
        0
      ],
      "image": "string",
      "daosId": 0,
      "oclass": "string",
      "cluster": "string",
      "daosDisk": 0,
      "daosPool": "string",
      "bdevNames": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "blockSize": 0,
      "gatewayId": 0,
      "daosDiskName": "string",
      "daosContainer": "string",
      "daosPoolLabel": "string",
      "namespaceUUID": "string",
      "sizeFormatted": "string",
      "subsystemNqns": [
        "string"
      ],
      "namespaceEUI64": "string",
      "namespaceNGUID": "string",
      "blockSizeFormatted": "string",
      "daosContainerLabel": "string",
      "subsystemsFormatted": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
post /gateways/nvmeof/disks

Add a new NVMe-oF disk.

Parameters
body object 
{
  "pool": "string",
  "type": "CEPH",
  "image": "string",
  "daosId": 0,
  "oclass": "string",
  "cluster": "string",
  "daosDisk": 0,
  "daosPool": "string",
  "blockSize": 0,
  "gatewayId": 0,
  "namespace": "string",
  "totalSize": 0,
  "subsystems": [
    0
  ],
  "daosDiskName": "string",
  "daosContainer": "string"
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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 /gateways/nvmeof/hosts

List all NVMe-oF hosts.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseNvmeOFHostResponse object
A paginated result.
{
  "data": [
    {
      "id": 0,
      "nqn": "string",
      "disks": [
        0
      ],
      "gatewayId": 0,
      "sharedKey": "string",
      "subsystems": [
        0
      ],
      "hasSharedKey": true,
      "disksFormatted": "string",
      "subsystemsFormatted": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
post /gateways/nvmeof/hosts

Add a new NVMe-oF host.

Parameters
body object 
{
  "nqn": "string",
  "gatewayId": 0,
  "sharedKey": "string",
  "subsystems": [
    0
  ]
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
post /services/nfs-gateways

Create a new NFS cluster.

Parameters
body object 
{
  "exports": [
    {
      "path": "string",
      "access": [
        {
          "rw": true,
          "subnet": "string"
        }
      ],
      "nfsPath": "string",
      "protocols": {
        "nfs3": true,
        "nfs4": true
      },
      "filesystem": "string"
    }
  ],
  "servers": [
    0
  ],
  "description": "string"
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
post /services/{id}/restart

Restart a service.

Parameters
id integer path Required
server integer query
Required for multi-server services
Responses
default successful operation
get /gateways/iscsi/servers

List all iSCSI servers.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseIscsiGatewayServerResponse object
A paginated result.
{
  "data": [
    {
      "ip": "string",
      "healthy": true,
      "hostname": "string",
      "serverId": 0,
      "serviceId": 0
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
get /gateways/nvmeof/services

List all NVMe-oF services.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseNvmeOFServiceResponse object
A paginated result.
{
  "data": [
    {
      "name": "string",
      "hints": [
        {
          "message": "string",
          "severity": "INFO"
        }
      ],
      "anaState": "optimized",
      "serverId": 0,
      "gatewayId": 0,
      "listeners": [
        {
          "port": 0,
          "type": "TCP",
          "vlan": 0,
          "nicId": 0,
          "secure": true,
          "vlanId": 0,
          "nicName": "string",
          "gatewayId": 0,
          "serviceId": 0,
          "listenerId": 0
        }
      ],
      "serviceId": 0,
      "transports": [
        {
          "type": "TCP",
          "gatewayId": 0,
          "maxIoSize": 0,
          "serviceId": 0,
          "ioUnitSize": 0,
          "inCapsuleDataSize": 0,
          "maxIoQpairsPerCtrlr": 0
        }
      ],
      "description": "string",
      "nrHugepages": 0,
      "serverHostname": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
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
ServiceControlRequest object 
[
  {
    "id": 0,
    "osd": true,
    "server": 0
  }
]
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
get /services/smb/{serviceId}

Get SMB cluster config and state.

Parameters
serviceId integer path Required
Responses
200 successful operation
SmbGatewayServiceResponse object 
{
  "type": "SIMPLE",
  "domain": "string",
  "shares": [
    {
      "id": 0,
      "ro": true,
      "rw": true,
      "path": "string",
      "type": "string",
      "guest": true,
      "share": "string",
      "roUsers": [
        "string"
      ],
      "rwUsers": [
        "string"
      ],
      "serviceId": 0,
      "roUsersFormatted": "string",
      "rwUsersFormatted": "string"
    }
  ],
  "servers": [
    {
      "ip": "string",
      "mac": "string",
      "nic": "string",
      "vlan": 0,
      "server": 0,
      "healthy": true,
      "virtualIps": [
        "string"
      ]
    }
  ],
  "dnsServers": [
    "string"
  ],
  "virtualIps": [
    "string"
  ],
  "joinWithSssd": true,
  "serviceDnsName": "string",
  "domainController": "string",
  "netbiosDomainName": "string"
}
patch /services/smb/{serviceId}

Update an SMB cluster.

Parameters
serviceId integer path Required
body object 
{
  "dnsServers": [
    "string"
  ],
  "virtualIps": [
    "string"
  ],
  "description": "string",
  "adminPassword": "string",
  "domainController": "string",
  "readonlyPassword": "string"
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
delete /services/smb/{serviceId}

Delete an SMB cluster.

Parameters
serviceId integer path Required
Responses
default successful operation
get /gateways/nvmeof/listeners

List all NVMe-oF listeners.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseNvmeOFListenerConfigResponse object
A paginated result.
{
  "data": [
    {
      "port": 0,
      "type": "TCP",
      "vlan": 0,
      "nicId": 0,
      "secure": true,
      "vlanId": 0,
      "nicName": "string",
      "gatewayId": 0,
      "serviceId": 0,
      "listenerId": 0
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
post /services/{type}/{id}/stop

Stop a service or OSD.

Parameters
type enum path Required
osds, mons, radosgws, mds, mgrs, nfs_gateways, iscsis, smbs, rbd_mirrors, daos_server, daos_agent, nvmf_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
Responses
default successful operation
get /gateways/nvmeof/subsystems

List all NVMe-oF subsystems.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseNvmeOFSubsystemResponse object
A paginated result.
{
  "data": [
    {
      "id": 0,
      "nqn": "string",
      "disks": [
        0
      ],
      "hosts": [
        0
      ],
      "gatewayId": 0,
      "modelNumber": "string",
      "serialNumber": "string",
      "maxNamespaces": 0,
      "disksFormatted": "string",
      "hostsFormatted": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
post /gateways/nvmeof/subsystems

Add a new NVMe-oF subsystem.

Parameters
body object 
{
  "nqn": "string",
  "gatewayId": 0
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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 /services/iscsi/{serviceId}

Get configuration of an iSCSI gateway

Parameters
serviceId integer path Required
Responses
200 successful operation
IscsiGatewayConfig object 
{
  "iqn": "string",
  "disks": [
    {
      "id": 0,
      "wwn": "string",
      "pool": "string",
      "image": "string"
    }
  ],
  "groups": [
    {
      "luns": [
        {
          "id": 0,
          "wwn": "string",
          "pool": "string",
          "image": "string"
        }
      ],
      "name": "string",
      "members": [
        "string"
      ]
    }
  ],
  "clients": [
    {
      "luns": [
        {
          "id": 0,
          "wwn": "string",
          "pool": "string",
          "image": "string"
        }
      ],
      "name": "string",
      "group": "string",
      "password": "string",
      "username": "string"
    }
  ],
  "targets": [
    "string"
  ],
  "gateways": [
    {
      "ip": "string",
      "name": "string"
    }
  ],
  "gatewayVersion": 0,
  "selectedTarget": "string"
}
post /services/iscsi/{serviceId}

Add a server to an existing iSCSI gateway service.

Parameters
serviceId integer path Required
body object 
{
  "ip": "string",
  "serverId": 0
}
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
patch /services/iscsi/{serviceId}

Update an iSCSI gateway.

Parameters
serviceId integer path Required
body object 
{
  "description": "string"
}
Responses
default successful operation
delete /services/iscsi/{serviceId}

Delete an iSCSI service.

Parameters
serviceId integer path Required
Responses
default successful operation
post /services/{type}/{id}/start

Start a service or OSD.

Parameters
type enum path Required
osds, mons, radosgws, mds, mgrs, nfs_gateways, iscsis, smbs, rbd_mirrors, daos_server, daos_agent, nvmf_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
Responses
default successful operation
post /gateways/nvmeof/{gatewayId}

Add a new NVMe-oF service.

Parameters
gatewayId integer path Required
body object 
{
  "anaState": "optimized",
  "serverId": 0,
  "listeners": [
    {
      "port": 0,
      "type": "TCP",
      "nicId": 0,
      "secure": true,
      "vlanId": 0
    }
  ],
  "transports": [
    {
      "type": "TCP",
      "maxIoSize": 0,
      "ioUnitSize": 0,
      "inCapsuleDataSize": 0,
      "maxIoQpairsPerCtrlr": 0
    }
  ],
  "description": "string",
  "nrHugepages": 0
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
patch /gateways/nvmeof/{gatewayId}

Update name or description of an NVMe-oF cluster.

Parameters
gatewayId integer path Required
body object 
{
  "name": "string",
  "description": "string",
  "forceSecure": true,
  "transportDefaults": [
    {
      "type": "TCP",
      "maxIoSize": 0,
      "ioUnitSize": 0,
      "inCapsuleDataSize": 0,
      "maxIoQpairsPerCtrlr": 0
    }
  ]
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
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
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
post /services/{type}/{id}/restart

Restart a service or OSD.

Parameters
type enum path Required
osds, mons, radosgws, mds, mgrs, nfs_gateways, iscsis, smbs, rbd_mirrors, daos_server, daos_agent, nvmf_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
Responses
default successful operation
get /gateways/nvmeof/ceph-clusters

List all NVMe-oF ceph cluster configurations.

Parameters
pagination string query
Responses
200 successful operation
PaginationResponseNvmeOFCephClusterResponse object
A paginated result.
{
  "data": [
    {
      "name": "string",
      "clientId": "string"
    }
  ],
  "after": 0,
  "limit": 0,
  "total": 0
}
post /gateways/nvmeof/ceph-clusters

Add a new NVMe-oF ceph cluster configuration.

Parameters
body object 
{
  "name": "string",
  "clientId": "string"
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
patch /gateways/nvmeof/disks/{diskId}

Update an NVMe-oF disk.

Parameters
diskId integer path Required
body object 
{
  "size": 0
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
delete /gateways/nvmeof/disks/{diskId}

Remove a NVMe-oF disk.

Parameters
diskId integer path Required
body object 
{
  "deleteData": true
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
put /gateways/nvmeof/hosts/{hostId}

Update an NVMe-oF host.

Parameters
hostId integer path Required
body object 
{
  "sharedKey": "string"
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
delete /gateways/nvmeof/hosts/{hostId}

Remove an NVMe-oF host.

Parameters
hostId integer path Required
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
post /services/smb/{serviceId}/shares

Add a share to an SMB cluster.

Parameters
serviceId integer path Required
body object 
{
  "path": "string",
  "share": "string"
}
Responses
200 successful operation
GeneratedId object 
{
  "id": 0
}
get /services/iscsi/{serviceId}/disks

Get configured iSCSI RBDs

Parameters
serviceId integer path Required
details boolean query
Include image details
Responses
200 successful operation
IscsiImagesResponse object 
{
  "disks": [
    "string"
  ],
  "details": {
    "additionalProp1": {
      "wwn": "string",
      "pool": "string",
      "image": "string",
      "controls": {
        "additionalProp1": null,
        "additionalProp2": null,
        "additionalProp3": null
      },
      "backstore": "string",
      "backstoreParsed": "USER"
    },
    "additionalProp2": {
      "wwn": "string",
      "pool": "string",
      "image": "string",
      "controls": {
        "additionalProp1": null,
        "additionalProp2": null,
        "additionalProp3": null
      },
      "backstore": "string",
      "backstoreParsed": "USER"
    },
    "additionalProp3": {
      "wwn": "string",
      "pool": "string",
      "image": "string",
      "controls": {
        "additionalProp1": null,
        "additionalProp2": null,
        "additionalProp3": null
      },
      "backstore": "string",
      "backstoreParsed": "USER"
    }
  }
}
post /services/smb/{serviceId}/servers

Add a server to an SMB cluster.

Parameters
serviceId integer path Required
body object 
{
  "nic": 0,
  "vlan": 0,
  "server": 0,
  "domainAdminUser": "string",
  "domainAdminPassword": "string"
}
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
put /services/iscsi/{serviceId}/target

Set iSCSI target to be used in other endpoints

Parameters
serviceId integer path Required
body string 
"string"
Responses
default successful operation
get /services/nfs-gateways/{serviceId}

Get an NFS cluster configuration.

Parameters
serviceId integer path Required
Responses
200 successful operation
NfsGatewayService object 
{
  "exports": [
    {
      "id": 0,
      "path": "string",
      "access": [
        {
          "rw": true,
          "subnet": "string"
        }
      ],
      "nfsPath": "string",
      "protocols": {
        "nfs3": true,
        "nfs4": true
      },
      "serviceId": 0,
      "filesystem": "string"
    }
  ],
  "servers": [
    0
  ]
}
patch /services/nfs-gateways/{serviceId}

Update an NFS cluster.

Parameters
serviceId integer path Required
body object 
{
  "servers": [
    0
  ],
  "description": "string"
}
Responses
default successful operation
delete /gateways/nvmeof/ceph-clusters/{name}

Remove a NVMe-oF ceph cluster configuration.

Parameters
name string path Required
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
patch /services/iscsi/{serviceId}/disks/{wwn}

Update parameters for an exported RBD image.

Parameters
serviceId integer path Required
wwn string path Required
body object 
{
  "size": 0
}
Responses
default successful operation
delete /services/iscsi/{serviceId}/disks/{wwn}

Delete an iSCSI-managed disk

Parameters
serviceId integer path Required
wwn string path Required
body object 
{
  "pool": "string",
  "image": "string",
  "deleteData": true
}
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
post /gateways/nvmeof/{gatewayId}/reconfigure

Reconfigure the NVMe-oF cluster.

Parameters
gatewayId integer path Required
fromScratch boolean query
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
patch /gateways/nvmeof/subsystems/{subsystemId}

Update an NVMe-oF subsystem.

Parameters
subsystemId integer path Required
body object 
{
  "modelNumber": "string",
  "serialNumber": "string",
  "maxNamespaces": 0
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
delete /gateways/nvmeof/subsystems/{subsystemId}

Remove an NVMe-oF subsystem.

Parameters
subsystemId integer path Required
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
put /services/iscsi/{serviceId}/clients/{name}

Configure a new iSCSI client

Parameters
serviceId integer path Required
name string path Required
body object 
{
  "group": "string",
  "password": "string",
  "username": "string"
}
Responses
default successful operation
patch /services/iscsi/{serviceId}/clients/{name}

Change a client's username/password

Parameters
serviceId integer path Required
name string path Required
body object 
{
  "password": "string",
  "username": "string"
}
Responses
default successful operation
delete /services/iscsi/{serviceId}/clients/{name}

Delete an iSCSI client

Parameters
serviceId integer path Required
name string path Required
Responses
default successful operation
put /services/iscsi/{serviceId}/groups/{group}

Create a new host group.

Parameters
serviceId integer path Required
group string path Required
Responses
default successful operation
delete /services/iscsi/{serviceId}/groups/{group}

Delete a host group.

Parameters
serviceId integer path Required
group string path Required
Responses
default successful operation
get /services/nfs-gateways/{serviceId}/exports

Get exports of an NFS cluster.

Parameters
serviceId integer path Required
Responses
200 successful operation
NfsGatewayExport array
NfsGatewayExport object 
[
  {
    "id": 0,
    "path": "string",
    "access": [
      {
        "rw": true,
        "subnet": "string"
      }
    ],
    "nfsPath": "string",
    "protocols": {
      "nfs3": true,
      "nfs4": true
    },
    "serviceId": 0,
    "filesystem": "string"
  }
]
post /services/nfs-gateways/{serviceId}/exports

Add an export to the NFS cluster.

Parameters
serviceId integer path Required
body object 
{
  "path": "string",
  "access": [
    {
      "rw": true,
      "subnet": "string"
    }
  ],
  "nfsPath": "string",
  "protocols": {
    "nfs3": true,
    "nfs4": true
  },
  "filesystem": "string"
}
Responses
200 successful operation
NfsGatewayExport object 
{
  "id": 0,
  "path": "string",
  "access": [
    {
      "rw": true,
      "subnet": "string"
    }
  ],
  "nfsPath": "string",
  "protocols": {
    "nfs3": true,
    "nfs4": true
  },
  "serviceId": 0,
  "filesystem": "string"
}
get /services/nfs-gateways/{serviceId}/servers

Get servers that are part of this cluster.

Parameters
serviceId integer path Required
Responses
200 successful operation
array
integer 
[
  0
]
post /services/smb/{serviceId}/service-dns-name

Change the service DNS name of an SMB cluster.

Parameters
serviceId integer path Required
body object 
{
  "joinServer": 0,
  "serviceDnsName": "string",
  "domainAdminUser": "string",
  "domainAdminPassword": "string"
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
put /services/smb/{serviceId}/shares/{shareId}

Replace a share on an SMB cluster.

Parameters
serviceId integer path Required
shareId integer path Required
body object 
{
  "path": "string",
  "share": "string"
}
Responses
default successful operation
delete /services/smb/{serviceId}/shares/{shareId}

Remove a share from an SMB cluster.

Parameters
serviceId integer path Required
shareId integer path Required
Responses
default successful operation
post /services/iscsi/{serviceId}/terminal/connect

Connect to the ceph-iscsi config shell

Parameters
serviceId integer path Required
Responses
200 successful operation
TerminalConnection object 
{
  "path": "string",
  "iscsi": true,
  "tlsPort": 0,
  "authToken": "string",
  "validUntil": 0,
  "plaintextPort": 0
}
delete /services/smb/{serviceId}/servers/{serverId}

Remove a server from an SMB cluster.

Parameters
serviceId integer path Required
serverId integer path Required
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
post /services/smb/active-directory-authentication

Create a new SMB cluster using Active Directory for authentication.

Parameters
body object 
{
  "domain": "string",
  "shares": [
    null
  ],
  "servers": [
    {
      "nic": 0,
      "vlan": 0,
      "server": 0,
      "domainAdminUser": "string",
      "domainAdminPassword": "string"
    }
  ],
  "dnsServers": [
    "string"
  ],
  "virtualIps": [
    "string"
  ],
  "description": "string",
  "joinWithSssd": true,
  "serviceDnsName": "string",
  "domainController": "string",
  "netbiosDomainName": "string"
}
Responses
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
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
200 successful operation
ManagedTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "id": 0,
  "done": true,
  "name": "string",
  "state": "WAITING",
  "object": "string",
  "output": "string",
  "result": {},
  "progress": {
    "total": 0,
    "complete": 0
  },
  "startedAt": 0,
  "startedBy": "string",
  "statusCode": 0
}
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
IscsiAddDiskToClientRequest object 
[
  {
    "name": "string",
    "pool": "string",
    "size": 0,
    "backstore": "USER"
  }
]
Responses
default successful operation
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 
{
  "name": "string",
  "pool": "string"
}
Responses
default successful operation
put /services/iscsi/{serviceId}/groups/{group}/disks

Add disks to a host group.

Parameters
serviceId integer path Required
group string path Required
body array
IscsiAddDiskToClientRequest object 
[
  {
    "name": "string",
    "pool": "string",
    "size": 0,
    "backstore": "USER"
  }
]
Responses
default successful operation
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 
{
  "name": "string",
  "pool": "string"
}
Responses
default successful operation
put /services/iscsi/{serviceId}/groups/{group}/hosts

Add hosts to a host group.

Parameters
serviceId integer path Required
group string path Required
body array
string 
[
  "string"
]
Responses
default successful operation
delete /services/iscsi/{serviceId}/groups/{group}/hosts

Remove hosts from a host group.

Parameters
serviceId integer path Required
group string path Required
body array
string 
[
  "string"
]
Responses
default successful operation
patch /gateways/nvmeof/{gatewayId}/services/{serviceId}

Update a NVMe-oF service.

Parameters
gatewayId integer path Required
serviceId integer path Required
body object 
{
  "anaState": "optimized",
  "listeners": [
    {
      "port": 0,
      "type": "TCP",
      "nicId": 0,
      "secure": true,
      "vlanId": 0
    }
  ],
  "transports": [
    {
      "type": "TCP",
      "maxIoSize": 0,
      "ioUnitSize": 0,
      "inCapsuleDataSize": 0,
      "maxIoQpairsPerCtrlr": 0
    }
  ],
  "description": "string",
  "nrHugepages": 0
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
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 
{
  "path": "string",
  "access": [
    {
      "rw": true,
      "subnet": "string"
    }
  ],
  "nfsPath": "string",
  "protocols": {
    "nfs3": true,
    "nfs4": true
  },
  "filesystem": "string"
}
Responses
default successful operation
delete /services/nfs-gateways/{serviceId}/exports/{exportId}

Remove an export entry from the NFS cluster.

Parameters
serviceId integer path Required
exportId integer path Required
Responses
default successful operation
post /gateways/nvmeof/subsystems/{subsystemId}/attach-disks

Attach disks to an NVMe-oF subsystem.

Parameters
subsystemId integer path Required
body object 
{
  "disks": [
    0
  ]
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
post /gateways/nvmeof/subsystems/{subsystemId}/attach-hosts

Attach hosts to an NVMe-oF subsystem.

Parameters
subsystemId integer path Required
body object 
{
  "hosts": [
    0
  ]
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
post /gateways/nvmeof/subsystems/{subsystemId}/detach-disks

Detach disks from an NVMe-oF subsystem.

Parameters
subsystemId integer path Required
body object 
{
  "disks": [
    0
  ]
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
post /gateways/nvmeof/subsystems/{subsystemId}/detach-hosts

Detach hosts from an NVMe-oF subsystem.

Parameters
subsystemId integer path Required
body object 
{
  "hosts": [
    0
  ]
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
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
Responses
default successful operation
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
Responses
default successful operation
delete /gateways/nvmeof/{gatewayId}/services/{serviceId}/errors

Forget any config errors associated with this service.

Parameters
gatewayId integer path Required
serviceId integer path Required
Responses
default successful operation
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 
{
  "port": 0,
  "type": "TCP",
  "nicId": 0,
  "secure": true,
  "vlanId": 0
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
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
TCP, RDMA
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
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 
{
  "port": 0,
  "secure": true
}
Responses
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}
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
200 successful operation
ManagedThreadTask object
A long-running task that goes on in the background after this task is completed. See tasks endpoints for details
{
  "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
}