Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 4.4

Skip to end of metadata
Go to start of metadata

Storage Device Resource

Exposed Resources Hierarchy
Storage Device Resource

Contents:

Abiquo supports external storage, and is able to manage volumes in different storage technologies. This resource provides storage device management features so cloud administrators can add their storage devices into the Abiquo platform and enable self-service storage features for end users.

Main URI of the Resource

This class operates mainly over the Resource URI: /admin/datacenters/{datacenter}/storage/devices

Exposed Methods

List the existing storage devices

List all storage devices that have been added to the platform.

Synopsis: GET http://example.com/api/admin/datacenters/{datacenter}/storage/devices
Roles Required: ROLE_PHYS_DC_RETRIEVE_DETAILS
Request Headers: Accept: application/vnd.abiquo.storagedevices+json; version=4.4; application/vnd.abiquo.storagedevices+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: StorageDevices Media Type
Request Example:

 Click here to show or hide the request example

GET_adm_dcs_X_stg_devs_AC_stgdevs_j.0002.txt

cURL:

curl -X GET http://localhost:9000/api/admin/datacenters/4872/storage/devices \ 
	 -H 'Accept:application/vnd.abiquo.storagedevices+json; version=3.10' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [], 
  "collection": []
}

Create a storage device

Add a new storage device to the platform.

Synopsis: POST http://example.com/api/admin/datacenters/{datacenter}/storage/devices
Roles Required: ROLE_PHYS_DC_ALLOW_MODIFY_STORAGE
Request Headers: Accept: application/vnd.abiquo.storagedevice+json; version=4.4; application/vnd.abiquo.storagedevice+xml; version=4.4;  Content-type:  application/vnd.abiquo.storagedevice+json; version=4.4; application/vnd.abiquo.storagedevice+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: StorageDevice Media Type
Response Message Body Entity: StorageDevice Media Type
Request Example:

 Click here to show or hide the request example

POST_adm_dcs_X_stg_devs_CT_stgdev_j_AC_stgdev_j.0001.txt

cURL:

curl -X POST http://localhost:9000/api/admin/datacenters/4248/storage/devices \ 
	 -H 'Accept:application/vnd.abiquo.storagedevice+json; version=4.2' \ 
	 -H 'Content-Type:application/vnd.abiquo.storagedevice+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 201

Request payload:

{
  "storageTechnology": "78", 
  "managementPort": 8080, 
  "name": "79", 
  "links": [], 
  "serviceIp": "192.168.1.1", 
  "managementIp": "102.168.1.2", 
  "servicePort": 80
}

Response payload:

{
  "storageTechnology": "78", 
  "name": "79", 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/4248/storage/devices/949", 
      "type": "application/vnd.abiquo.storagedevice+json", 
      "rel": "edit", 
      "title": "79"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4248", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "76"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4248/storage/devices/949/pools", 
      "type": "application/vnd.abiquo.storagepools+json", 
      "rel": "pools", 
      "title": "storage pools"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4248/storage/tiers", 
      "type": "application/vnd.abiquo.tiers+json", 
      "rel": "tiers", 
      "title": "tiers"
    }
  ], 
  "serviceIp": "192.168.1.1", 
  "managementIp": "102.168.1.2", 
  "servicePort": 80, 
  "managementPort": 8080, 
  "id": 949
}

 

Get the supported storage devices

Get the storage devices that are supported by the Abiquo platform.

Synopsis: GET http://example.com/api/admin/datacenters/{datacenter}/storage/devices/action/supported
Roles Required: ROLE_PHYS_DC_RETRIEVE_DETAILS
Request Headers: Accept: application/vnd.abiquo.storagedevicesmetadata+json; version=4.4; application/vnd.abiquo.storagedevicesmetadata+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: StorageDevicesMetadata Media Type
Request Example:

 Click here to show or hide the request example

GET_adm_dcs_X_stg_devs_act_supported_AC_stgdevsmd_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/datacenters/4254/storage/devices/action/supported \ 
	 -H 'Accept:application/vnd.abiquo.storagedevicesmetadata+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [], 
  "collection": [
    {
      "defaultServicePort": 3260, 
      "type": "GENERIC_ISCSI", 
      "requiresAuthentication": false, 
      "links": [], 
      "defaultManagementPort": 80
    }, 
    {
      "defaultServicePort": 3260, 
      "type": "LVM", 
      "requiresAuthentication": false, 
      "links": [], 
      "defaultManagementPort": 80
    }, 
    {
      "defaultServicePort": 3260, 
      "type": "NETAPP", 
      "requiresAuthentication": false, 
      "links": [], 
      "defaultManagementPort": 80
    }, 
    {
      "defaultServicePort": 3260, 
      "type": "NEXENTA", 
      "requiresAuthentication": false, 
      "links": [], 
      "defaultManagementPort": 80
    }
  ]
}

Get the information about a storage device

Get the information about a storage device.

Synopsis: GET http://example.com/api/admin/datacenters/{datacenter}/storage/devices/{device}
Roles Required: ROLE_PHYS_DC_RETRIEVE_DETAILS
Request Headers: Accept: application/vnd.abiquo.storagedevice+json; version=4.4; application/vnd.abiquo.storagedevice+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: StorageDevice Media Type
Request Example:

 Click here to show or hide the request example

GET_adm_dcs_X_stg_devs_X_AC_stgdev_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/datacenters/4237/storage/devices/945 \ 
	 -H 'Accept:application/vnd.abiquo.storagedevice+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "storageTechnology": "58", 
  "name": "59", 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/4237/storage/devices/945", 
      "type": "application/vnd.abiquo.storagedevice+json", 
      "rel": "edit", 
      "title": "59"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4237", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "56"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4237/storage/devices/945/pools", 
      "type": "application/vnd.abiquo.storagepools+json", 
      "rel": "pools", 
      "title": "storage pools"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4237/storage/tiers", 
      "type": "application/vnd.abiquo.tiers+json", 
      "rel": "tiers", 
      "title": "tiers"
    }
  ], 
  "serviceIp": "192.168.1.1", 
  "managementIp": "102.168.1.2", 
  "servicePort": 80, 
  "managementPort": 8080, 
  "id": 945
}

Modify a storage device

Update the information about a storage device.

Synopsis: PUT http://example.com/api/admin/datacenters/{datacenter}/storage/devices/{device}
Roles Required: ROLE_PHYS_DC_ALLOW_MODIFY_STORAGE
Request Headers: Accept: application/vnd.abiquo.storagedevice+json; version=4.4; application/vnd.abiquo.storagedevice+xml; version=4.4;  Content-type:  application/vnd.abiquo.storagedevice+json; version=4.4; application/vnd.abiquo.storagedevice+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: StorageDevice Media Type
Response Message Body Entity: StorageDevice Media Type
Request Example:

 Click here to show or hide the request example

PUT_adm_dcs_X_stg_devs_X_CT_stgdev_j_AC_stgdev_j.0001.txt

cURL:

curl -X PUT http://localhost:9000/api/admin/datacenters/4240/storage/devices/948 \ 
	 -H 'Accept:application/vnd.abiquo.storagedevice+json; version=4.2' \ 
	 -H 'Content-Type:application/vnd.abiquo.storagedevice+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

{
  "storageTechnology": "88", 
  "name": "NewName", 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/4240/storage/devices/948", 
      "type": "application/vnd.abiquo.storagedevice+json", 
      "rel": "edit", 
      "title": "89"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4240", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "86"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4240/storage/devices/948/pools", 
      "type": "application/vnd.abiquo.storagepools+json", 
      "rel": "pools", 
      "title": "storage pools"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4240/storage/tiers", 
      "type": "application/vnd.abiquo.tiers+json", 
      "rel": "tiers", 
      "title": "tiers"
    }
  ], 
  "serviceIp": "192.168.1.1", 
  "managementIp": "102.168.1.2", 
  "servicePort": 34, 
  "managementPort": 8080, 
  "id": 948
}

Response payload:

{
  "storageTechnology": "88", 
  "name": "NewName", 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/4240/storage/devices/948", 
      "type": "application/vnd.abiquo.storagedevice+json", 
      "rel": "edit", 
      "title": "NewName"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4240", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "86"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4240/storage/devices/948/pools", 
      "type": "application/vnd.abiquo.storagepools+json", 
      "rel": "pools", 
      "title": "storage pools"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4240/storage/tiers", 
      "type": "application/vnd.abiquo.tiers+json", 
      "rel": "tiers", 
      "title": "tiers"
    }
  ], 
  "serviceIp": "192.168.1.1", 
  "managementIp": "102.168.1.2", 
  "servicePort": 34, 
  "managementPort": 8080, 
  "id": 948
}

 

Remove a storage device

Remove a storage device from the platform.

Synopsis: DELETE http://example.com/api/admin/datacenters/{datacenter}/storage/devices/{device}
Roles Required: ROLE_PHYS_DC_ALLOW_MODIFY_STORAGE
Request Headers: Accept: ; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity:
Request Example:

 Click here to show or hide the request example

DELETE_adm_dcs_X_stg_devs_X.0001.txt

cURL:

curl -X DELETE http://localhost:9000/api/admin/datacenters/4234/storage/devices/942 \ 
	 -H 'Accept:text/json,application/json' \ 
	 -u user:password --verbose 

Success status code: 204

Request payload:

--none--

Response payload:

--none--