Skip to main content

Resources

delete__resources_delete

Code samples

DELETE /resources/delete HTTP/1.1

Accept: application/json

DELETE /resources/delete

Delete missing resources.

Parameters

Name In Type Required Description
entityIds query array[integer] false Delete missing resources.
all query boolean false Delete all missing resources.
async query boolean false none
uncommitAndAggregateId query string false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

get__resources_list

Code samples

GET /resources/list HTTP/1.1

Accept: application/json

GET /resources/list

List all hardware resources.

Parameters

Name In Type Required Description
resourceType query string false Show results by resource type.
node query string false Limit results for a specific node.
errors query boolean false Show only components with errors.
details query boolean false Show advanced information.
sensors query boolean false Show sensor information.
ids query array[integer] false Show only results for resources filtered by these ids.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true,
      "Vols": 0,
      "Iqn": "string",
      "IsSEDPasswordSupplied": true,
      "Wwn": [
        "string"
      ],
      "Volumes": [
        "string"
      ],
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "Services": [
        "string"
      ],
      "Sessions": [
        "string"
      ],
      "SupportTunnelStatus": "string",
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Device": "string",
          "UsedCapacityInBytes": 0,
          "ManualPool": "string",
          "DeviceName": "string",
          "PhysicalSector": "string",
          "LogicalSector": "string",
          "Vendor": "string",
          "Model": "string",
          "RotationRate": "string",
          "EnclosureIndex": "string",
          "OSName": "string",
          "Version": "string",
          "SelfEncryptingDrive": "NotSupported",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "LedState": "string",
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "CPU": [
        {
          "Name": "string",
          "Id": 0,
          "Vendor": "string",
          "Brand": "string",
          "Model": "string",
          "Family": "string",
          "Stepping": "string",
          "CoreCount": "string",
          "LogicalCoresCount": "string",
          "ProcessorID": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Memory": [
        {
          "Name": "string",
          "Id": 0,
          "Manufacturer": "string",
          "Capacity": "string",
          "MemoryType": "string",
          "Serial": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "NetworkInterfaceCards": [
        {
          "Name": "string",
          "Id": 0,
          "Interface": "string",
          "Device": "string",
          "Vendor": "string",
          "Slaves": [
            "string"
          ],
          "Ips": [
            {
              "Ip": "string",
              "IscsiEnabled": true,
              "TcpNvmeofPorts": [
                "string"
              ],
              "RdmaNvmeofPorts": [
                "string"
              ],
              "TcpNvmeofEnabled": true,
              "RdmaNvmeofEnabled": true
            }
          ],
          "SpeedGbs": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "FibreChannelHostBusAdapters": [
        {
          "Name": "string",
          "Id": 0,
          "Model": "string",
          "FirmwareVersion": "string",
          "DriverVersion": "string",
          "LinkState": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Chassis": [
        {
          "Name": "string",
          "Id": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ProductVendor": "string",
          "ProductName": "string",
          "ProductVersion": "string",
          "ProductSerial": "string",
          "ProductUUID": "string",
          "BoardVendor": "string",
          "BoardName": "string",
          "BoardVersion": "string",
          "BoardSerial": "string",
          "BiosVendor": "string",
          "BiosVersion": "string",
          "ChassisType": "string",
          "ChassisSerial": "string",
          "ChassisVendor": "string",
          "ServerVendor": "string",
          "IsVirtualMachine": true,
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Pings": [
        {
          "PingType": "string",
          "Address": "string",
          "Error": "string",
          "Nics": [
            "string"
          ],
          "IsSuccessful": true
        }
      ],
      "IpAddresses": [
        "string"
      ],
      "TargetChap": {
        "ChapName": "string",
        "ChapSecret": "string"
      },
      "Isns": {
        "IsnsAddress": "string",
        "AccessControl": true
      }
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success NodeElementApiResult
400 Bad Request Bad Request string

put__resources_drives_approve

Code samples

PUT /resources/drives/approve HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/drives/approve

Approve new drives.

Body parameter

{
  "DriveIds": [
    0
  ],
  "All": true,
  "Patterns": [
    "string"
  ],
  "Count": 0,
  "ManualPool": "string",
  "Force": true
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body ResourcesDrivesApprove false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

get__resources_drives_list

Code samples

GET /resources/drives/list HTTP/1.1

Accept: application/json

GET /resources/drives/list

List all available drives.

Parameters

Name In Type Required Description
node query string false Show results from a specific node. If not specified, the results will be gathered from the first available node.
errors query boolean false Show only components with errors.
details query boolean false Show advanced information.
ids query array[integer] false Show only results for resources filtered by these ids.
led query boolean false Show the LED status.
patterns query array[string] false Patterns to filter drives by either drive name, capacity, serial or type. Regex is supported.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Device": "string",
      "UsedCapacityInBytes": 0,
      "ManualPool": "string",
      "DeviceName": "string",
      "PhysicalSector": "string",
      "LogicalSector": "string",
      "Vendor": "string",
      "Model": "string",
      "RotationRate": "string",
      "EnclosureIndex": "string",
      "OSName": "string",
      "Version": "string",
      "SelfEncryptingDrive": "NotSupported",
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "LedState": "string",
      "Type": "HDD",
      "CapacityInBytes": 0,
      "ApprovedState": "Approved",
      "ResourceSerial": "string",
      "ResourceStatus": "OK",
      "ErrMsg": "string"
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success DriveElementApiResult
400 Bad Request Bad Request string

get__resources_drives_performance_analyzer

Code samples

GET /resources/drives/performance_analyzer HTTP/1.1

Accept: application/json

GET /resources/drives/performance_analyzer

Run performance tests on drives.

Parameters

Name In Type Required Description
driveIds query array[integer] false Run the performance analyzer on these ids.
all query boolean false Run the performance analyzer on all drives.
ssd query boolean false Run the performance analyzer on ssd drives.
hdd query boolean false Run the performance analyzer on hdd drives.
nvme query boolean false Run the performance analyzer on nvme drives.
manualPools query string false Run the performance analyzer on manual pools drives.
iterationTimeInSeconds query integer(int64) false Duration for each iteration in seconds.

Example responses

200 Response

{
  "Data": [
    {
      "NodeName": "string",
      "PerformanceTestName": "string",
      "Entity": "string",
      "Status": "SystemPerformance",
      "PerformanceResult": {
        "IOPS": 0,
        "Throughput": "string",
        "LatencyInMilliseconds": 0.1,
        "DurationInSec": 0.1
      }
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success PerformanceAnalyzerDriveElementApiResult
400 Bad Request Bad Request string

get__resources_drives_smart

Code samples

GET /resources/drives/smart HTTP/1.1

Accept: application/json

GET /resources/drives/smart

Get SMART output of drives.

Parameters

Name In Type Required Description
node query string false The node on which the SMART command will be inititaed.
driveid query integer(int64) false The drive id on which the SMART command will be initiated.

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

put__resources_network_iscsi

Code samples

PUT /resources/network/iscsi HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/network/iscsi

Enable/disable iscsi traffic on specific ips.

Body parameter

{
  "Enable": true,
  "Force": true
}

Parameters

Name In Type Required Description
ips query array[string] false none
async query boolean false none
uncommitAndAggregateId query string false none
body body ResourcesNetworkIscsi false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

get__resources_network_list

Code samples

GET /resources/network/list HTTP/1.1

Accept: application/json

GET /resources/network/list

List all available network interface cards.

Parameters

Name In Type Required Description
errors query boolean false Show only components with errors.
details query boolean false Show advanced information.
ids query array[integer] false Show only results for resources filtered by these ids.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true,
      "Vols": 0,
      "Iqn": "string",
      "IsSEDPasswordSupplied": true,
      "Wwn": [
        "string"
      ],
      "Volumes": [
        "string"
      ],
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "Services": [
        "string"
      ],
      "Sessions": [
        "string"
      ],
      "SupportTunnelStatus": "string",
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Device": "string",
          "UsedCapacityInBytes": 0,
          "ManualPool": "string",
          "DeviceName": "string",
          "PhysicalSector": "string",
          "LogicalSector": "string",
          "Vendor": "string",
          "Model": "string",
          "RotationRate": "string",
          "EnclosureIndex": "string",
          "OSName": "string",
          "Version": "string",
          "SelfEncryptingDrive": "NotSupported",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "LedState": "string",
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "CPU": [
        {
          "Name": "string",
          "Id": 0,
          "Vendor": "string",
          "Brand": "string",
          "Model": "string",
          "Family": "string",
          "Stepping": "string",
          "CoreCount": "string",
          "LogicalCoresCount": "string",
          "ProcessorID": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Memory": [
        {
          "Name": "string",
          "Id": 0,
          "Manufacturer": "string",
          "Capacity": "string",
          "MemoryType": "string",
          "Serial": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "NetworkInterfaceCards": [
        {
          "Name": "string",
          "Id": 0,
          "Interface": "string",
          "Device": "string",
          "Vendor": "string",
          "Slaves": [
            "string"
          ],
          "Ips": [
            {
              "Ip": "string",
              "IscsiEnabled": true,
              "TcpNvmeofPorts": [
                "string"
              ],
              "RdmaNvmeofPorts": [
                "string"
              ],
              "TcpNvmeofEnabled": true,
              "RdmaNvmeofEnabled": true
            }
          ],
          "SpeedGbs": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "FibreChannelHostBusAdapters": [
        {
          "Name": "string",
          "Id": 0,
          "Model": "string",
          "FirmwareVersion": "string",
          "DriverVersion": "string",
          "LinkState": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Chassis": [
        {
          "Name": "string",
          "Id": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ProductVendor": "string",
          "ProductName": "string",
          "ProductVersion": "string",
          "ProductSerial": "string",
          "ProductUUID": "string",
          "BoardVendor": "string",
          "BoardName": "string",
          "BoardVersion": "string",
          "BoardSerial": "string",
          "BiosVendor": "string",
          "BiosVersion": "string",
          "ChassisType": "string",
          "ChassisSerial": "string",
          "ChassisVendor": "string",
          "ServerVendor": "string",
          "IsVirtualMachine": true,
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Pings": [
        {
          "PingType": "string",
          "Address": "string",
          "Error": "string",
          "Nics": [
            "string"
          ],
          "IsSuccessful": true
        }
      ],
      "IpAddresses": [
        "string"
      ],
      "TargetChap": {
        "ChapName": "string",
        "ChapSecret": "string"
      },
      "Isns": {
        "IsnsAddress": "string",
        "AccessControl": true
      }
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success NodeElementApiResult
400 Bad Request Bad Request string

put__resources_network_nvmeof

Code samples

PUT /resources/network/nvmeof HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/network/nvmeof

Enable/disable nvmeof traffic on specific ips.

Body parameter

{
  "Port": 0,
  "Enable": true,
  "Rdma": true,
  "Tcp": true
}

Parameters

Name In Type Required Description
ip query string false none
async query boolean false none
uncommitAndAggregateId query string false none
body body ResourcesNetworkNvmeof false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

get__resources_network_ping

Code samples

GET /resources/network/ping HTTP/1.1

Accept: application/json

GET /resources/network/ping

Ping test.

Parameters

Name In Type Required Description
ip query string false The ip to try to ping.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "Id": 0,
      "Time": "2019-08-24T14:15:22Z",
      "State": "Running",
      "HAState": "Unknown",
      "CurrentManagementConnection": true,
      "Vols": 0,
      "Iqn": "string",
      "IsSEDPasswordSupplied": true,
      "Wwn": [
        "string"
      ],
      "Volumes": [
        "string"
      ],
      "Sensors": [
        {
          "Name": "string",
          "Type": "Temperture",
          "Reading": "string",
          "EventMessage": "string",
          "Status": "OK",
          "State": "string",
          "LastReadingTimestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "Services": [
        "string"
      ],
      "Sessions": [
        "string"
      ],
      "SupportTunnelStatus": "string",
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Device": "string",
          "UsedCapacityInBytes": 0,
          "ManualPool": "string",
          "DeviceName": "string",
          "PhysicalSector": "string",
          "LogicalSector": "string",
          "Vendor": "string",
          "Model": "string",
          "RotationRate": "string",
          "EnclosureIndex": "string",
          "OSName": "string",
          "Version": "string",
          "SelfEncryptingDrive": "NotSupported",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "LedState": "string",
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "CPU": [
        {
          "Name": "string",
          "Id": 0,
          "Vendor": "string",
          "Brand": "string",
          "Model": "string",
          "Family": "string",
          "Stepping": "string",
          "CoreCount": "string",
          "LogicalCoresCount": "string",
          "ProcessorID": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Memory": [
        {
          "Name": "string",
          "Id": 0,
          "Manufacturer": "string",
          "Capacity": "string",
          "MemoryType": "string",
          "Serial": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "NetworkInterfaceCards": [
        {
          "Name": "string",
          "Id": 0,
          "Interface": "string",
          "Device": "string",
          "Vendor": "string",
          "Slaves": [
            "string"
          ],
          "Ips": [
            {
              "Ip": "string",
              "IscsiEnabled": true,
              "TcpNvmeofPorts": [
                "string"
              ],
              "RdmaNvmeofPorts": [
                "string"
              ],
              "TcpNvmeofEnabled": true,
              "RdmaNvmeofEnabled": true
            }
          ],
          "SpeedGbs": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "FibreChannelHostBusAdapters": [
        {
          "Name": "string",
          "Id": 0,
          "Model": "string",
          "FirmwareVersion": "string",
          "DriverVersion": "string",
          "LinkState": "string",
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Chassis": [
        {
          "Name": "string",
          "Id": 0,
          "Sensors": [
            {
              "Name": "string",
              "Type": "Temperture",
              "Reading": "string",
              "EventMessage": "string",
              "Status": "OK",
              "State": "string",
              "LastReadingTimestamp": "2019-08-24T14:15:22Z"
            }
          ],
          "ProductVendor": "string",
          "ProductName": "string",
          "ProductVersion": "string",
          "ProductSerial": "string",
          "ProductUUID": "string",
          "BoardVendor": "string",
          "BoardName": "string",
          "BoardVersion": "string",
          "BoardSerial": "string",
          "BiosVendor": "string",
          "BiosVersion": "string",
          "ChassisType": "string",
          "ChassisSerial": "string",
          "ChassisVendor": "string",
          "ServerVendor": "string",
          "IsVirtualMachine": true,
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Pings": [
        {
          "PingType": "string",
          "Address": "string",
          "Error": "string",
          "Nics": [
            "string"
          ],
          "IsSuccessful": true
        }
      ],
      "IpAddresses": [
        "string"
      ],
      "TargetChap": {
        "ChapName": "string",
        "ChapSecret": "string"
      },
      "Isns": {
        "IsnsAddress": "string",
        "AccessControl": true
      }
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success NodeElementApiResult
400 Bad Request Bad Request string

post__resources_drives_pools_create

Code samples

POST /resources/drives/pools/create HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

POST /resources/drives/pools/create

Create a manual pool.

Body parameter

{
  "Name": "string",
  "MaxSectorsKb": 0
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body ResourcesDrivesPoolsCreate false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

put__resources_drives_pools_edit

Code samples

PUT /resources/drives/pools/edit HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/drives/pools/edit

Edit a manual pool.

Body parameter

{
  "Name": "string",
  "NewName": "string",
  "MaxSectorsKb": 0
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body ResourcesDrivesPoolsEdit false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

get__resources_drives_pools_list

Code samples

GET /resources/drives/pools/list HTTP/1.1

Accept: application/json

GET /resources/drives/pools/list

List all available pools.

Parameters

Name In Type Required Description
drives query boolean false See drives within the pools.
volumes query boolean false See volumes within the pools.
capacity query boolean false See basic capacity consumptions.

Example responses

200 Response

{
  "Data": [
    {
      "Name": "string",
      "TotalCapacityInBytes": 0.1,
      "UsedCapacityInBytes": 0.1,
      "Type": "UserDefined",
      "ManualPoolType": "Normal",
      "DriveCount": 0,
      "VolumesCount": 0,
      "Drives": [
        {
          "Name": "string",
          "Id": 0,
          "Type": "HDD",
          "CapacityInBytes": 0,
          "ApprovedState": "Approved",
          "ResourceSerial": "string",
          "ResourceStatus": "OK",
          "ErrMsg": "string"
        }
      ],
      "Volumes": [
        {
          "Id": 0,
          "Application": "string",
          "Volume": "string"
        }
      ],
      "IsHdd": true,
      "IsSsd": true,
      "MaxSectorsKb": 0
    }
  ]
}

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success DrivePoolElementApiResult
400 Bad Request Bad Request string

put__resources_drives_sed_initialize

Code samples

PUT /resources/drives/sed/initialize HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/drives/sed/initialize

Initialize self-encrypting drives with a password. This should be done on new drives.

Body parameter

{
  "DriveIds": [
    0
  ],
  "All": true,
  "Password": "string",
  "ConfirmPassword": "string"
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body ResourcesDrivesSedInitialize false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string

put__resources_drives_sed_supply_password

Code samples

PUT /resources/drives/sed/supply_password HTTP/1.1

Content-Type: application/json-patch+json
Accept: application/json

PUT /resources/drives/sed/supply_password

Set password used to unlock the self-encrypting drives.

Body parameter

{
  "Password": "string"
}

Parameters

Name In Type Required Description
async query boolean false none
uncommitAndAggregateId query string false none
body body ResourcesDrivesSedSupplyPassword false none

Example responses

200 Response

"string"

400 Response

"string"

Responses

Status Meaning Description Schema
200 OK Success string
400 Bad Request Bad Request string