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 2.6


Skip to end of metadata
Go to start of metadata

Manage external storage attached to the virtual machines

Exposed Resources Hierarchy
Manage external storage attached to the virtual machines

Contents:

Enables access to features to manage external storage for virtual machines.

Main URI of the Resource

This class operates mainly over the Resource URI: /cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/storage

Exposed Methods

Get the details of an attached volume

Get the details of a volume attached to the virtual machine.

Synopsis: GET http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/storage/volumes/{volume}
Roles Required: ROLE_VDC_MANAGE_VAPP,ROLE_VAPP_CUSTOMISE_SETTINGS,ROLE_VAPP_ASSIGN_VOLUME, ROLE_VAPP_PERFORM_ACTIONS, ROLE_VAPP_DEPLOY_UNDEPLOY,ROLE_VAPP_ASSIGN_NETWORK
Request Headers: Accept: application/vnd.abiquo.volume+xml; version=2.4; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example
Get the details of an attached volume example
curl http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/storage/volumes/763 \
    -v -u user:pass \
    -X GET \
    -H "Accept: application/vnd.abiquo.volume+xml;version=2.4"

> GET /api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/storage/volumes/763 HTTP/1.1
> Authorization: Basic YWRtaW46eGFiaXF1bw==
> User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18
> Host: example.com
> Accept: application/vnd.abiquo.volume+xml;version=2.4
> 
< HTTP/1.1 200 OK
< Date: Tue, 21 Aug 2012 07:32:14 GMT
< Set-Cookie: auth=YWRtaW46MTM0NTUzNjEzNDYyNDo1ODBkZDdhODY3MTkxNzhkYjhmYTNiMzJjYmUwZGNlOTpBQklRVU8; Expires=Tue, 21-Aug-2012 08:02:14 GMT; Path=/api
< Set-Cookie: JSESSIONID=938DFE6D493763DF1A1C12292C35B324; Path=/api
< Content-Type: application/vnd.abiquo.volume+xml;version=2.4
< Content-Length: 1162
< 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<volume>
    <link rel="edit" type="application/vnd.abiquo.volume+xml" href="http://example.com/api/cloud/virtualdatacenters/1/volumes/763"/>
    <link rel="initiator mappings" type="application/vnd.abiquo.initiatormappings+xml" href="http://example.com/api/cloud/virtualdatacenters/1/volumes/763/action/initiatormappings"/>
    <link title="Seaside Storage" rel="tier" type="application/vnd.abiquo.tier+xml" href="http://example.com/api/cloud/virtualdatacenters/1/tiers/1"/>
    <link title="Kalakaua" rel="virtualappliance" type="application/vnd.abiquo.virtualappliance+xml" href="http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1"/>
    <link title="Kaahumanu" rel="virtualdatacenter" type="application/vnd.abiquo.virtualdatacenter+xml" href="http://example.com/api/cloud/virtualdatacenters/1"/>
    <link title="ABQ_1312f043-69ef-4d5d-b1c4-3853bbdbcd17" rel="virtualmachine" type="application/vnd.abiquo.virtualmachine+xml" href="http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1"/>
    <id>763</id>
    <name>Cocovol</name>
    <state>ATTACHED</state>
    <sizeInMB>32</sizeInMB>
</volume>


List the volumes attached to the virtual machine

List the volumes attached to the virtual machine. Volumes are external block devices that can be attached to the virtual machines using the iSCSI protocol.

Data stored in these external volumes will be persistent (even when the virtual machine is undeployed) until the volume is deleted from the target storage device.

Paging Method

This method works with paging. Check out Basic Behaviors for information about how it works

Synopsis: GET http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/storage/volumes
Roles Required: ROLE_PHYS_DC_ALLOW_MODIFY_SERVERS,ROLE_VDC_MANAGE_VAPP,ROLE_VAPP_CUSTOMISE_SETTINGS,ROLE_VAPP_ASSIGN_VOLUME, ROLE_VAPP_PERFORM_ACTIONS, ROLE_VAPP_DEPLOY_UNDEPLOY,ROLE_VAPP_ASSIGN_NETWORK, ROLE_MANAGE_HARD_DISKS,ROLE_VAPP_CREATE_INSTANCE, ROLE_VAPP_CREATE_STATEFUL
Request Headers: Accept: application/vnd.abiquo.iscsivolumes+xml; version=2.4; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

startwith

false

0

First element to retrieve.

by

false

id

Search order criteria.

has

false

 

A way to filter the search. Ex. by volume name.

limit

false

25

Number of elements to retrieve.

asc

false

true

The way to order the search (ascendant -> true, descendant -> false). Ascendant by
default.

 

 

 

 

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

 Click here to show or hide the request example
List the volumes attached to the virtual machine example
curl http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/storage/volumes \
    -v -u user:pass \
    -X GET \
    -H "Accept: application/vnd.abiquo.iscsivolumes+xml;version=2.4"

> GET /api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/storage/volumes HTTP/1.1
> Authorization: Basic YWRtaW46eGFiaXF1bw==
> User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18
> Host: example.com
> Accept: application/vnd.abiquo.iscsivolumes+xml;version=2.4
> 
< HTTP/1.1 200 OK
< Date: Tue, 21 Aug 2012 07:33:26 GMT
< Set-Cookie: auth=YWRtaW46MTM0NTUzNjIwNjc5NjpkNTVjZGY5ZWZhZDY5MGJlZDhmMjgzNmZkOGYzYTg5YTpBQklRVU8; Expires=Tue, 21-Aug-2012 08:03:26 GMT; Path=/api
< Set-Cookie: JSESSIONID=E0FD406AA4706D4F19602BEF394FA7CF; Path=/api
< Content-Type: application/vnd.abiquo.iscsivolumes+xml;version=2.4
< Content-Length: 1181
< 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<volumes>
    <volume>
        <link rel="edit" type="application/vnd.abiquo.volume+xml" href="http://example.com/api/cloud/virtualdatacenters/1/volumes/763"/>
        <link rel="initiator mappings" type="application/vnd.abiquo.initiatormappings+xml" href="http://example.com/api/cloud/virtualdatacenters/1/volumes/763/action/initiatormappings"/>
        <link title="Seaside Storage" rel="tier" type="application/vnd.abiquo.tier+xml" href="http://example.com/api/cloud/virtualdatacenters/1/tiers/1"/>
        <link title="Kalakaua" rel="virtualappliance" type="application/vnd.abiquo.virtualappliance+xml" href="http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1"/>
        <link title="Kaahumanu" rel="virtualdatacenter" type="application/vnd.abiquo.virtualdatacenter+xml" href="http://example.com/api/cloud/virtualdatacenters/1"/>
        <link title="ABQ_1312f043-69ef-4d5d-b1c4-3853bbdbcd17" rel="virtualmachine" type="application/vnd.abiquo.virtualmachine+xml" href="http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1"/>
        <id>763</id>
        <name>Cocovol</name>
        <state>ATTACHED</state>
        <sizeInMB>32</sizeInMB>
    </volume>
</volumes>

Get the details of an attached hard disk

Get the details of a hard disk attached to the virtual machine.

Synopsis: GET http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/storage/disks/{disk}
Roles Required: ROLE_VDC_MANAGE_VAPP,ROLE_VAPP_CUSTOMISE_SETTINGS, ROLE_VAPP_PERFORM_ACTIONS, ROLE_VAPP_DEPLOY_UNDEPLOY,ROLE_VAPP_ASSIGN_NETWORK
Request Headers: Accept: application/vnd.abiquo.harddisk+xml; version=2.4; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example
Get the details of an attached hard disk example
curl http://example.com/api/cloud/virtualdatacenters/2/virtualappliances/2/virtualmachines/2/storage/disks/1019 \
    -v -u user:pass \
    -X GET \
    -H "Accept: application/vnd.abiquo.harddisk+xml;version=2.4"

> GET /api/cloud/virtualdatacenters/2/virtualappliances/2/virtualmachines/2/storage/disks/1019 HTTP/1.1
> Authorization: Basic YWRtaW46eGFiaXF1bw==
> User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18
> Host: example.com
> Accept: application/vnd.abiquo.harddisk+xml;version=2.4
> 
< HTTP/1.1 200 OK
< Date: Tue, 21 Aug 2012 07:13:38 GMT
< Set-Cookie: auth=YWRtaW46MTM0NTUzNTAxODk3Njo4YzQ3YzkxMDBlYTRiNGU4ZGZhMjkxMmM4MzY1ZGRkNjpBQklRVU8; Expires=Tue, 21-Aug-2012 07:43:38 GMT; Path=/api
< Set-Cookie: JSESSIONID=75F85738839C8943719E4D147A920E26; Path=/api
< Content-Type: application/vnd.abiquo.harddisk+xml;version=2.4
< Content-Length: 291
< 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<disk>
    <link rel="edit" type="application/vnd.abiquo.harddisk+xml" href="http://example.com/api/cloud/virtualdatacenters/2/virtualappliances/2/virtualmachines/2/storage/disks/1019"/>
    <sequence>0</sequence>
    <sizeInMb>2048</sizeInMb>
</disk>


List the hard disks attached to the virtual machine

List the hard disks attached to the virtual machine. Hard disks are created in the hypervisor's datastore, and are attached tot he virtual machine as additional hard disks.

Data stored in these external hard disks will NOT be persistent. The hard disks will be destroyed when the virtual machine is undeployed. If additional and persistent storage is needed, use the external volumes instead.

Synopsis: GET http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/storage/disks
Roles Required: ROLE_PHYS_DC_ALLOW_MODIFY_SERVERS,ROLE_VDC_MANAGE_VAPP,ROLE_VAPP_CUSTOMISE_SETTINGS, ROLE_VAPP_PERFORM_ACTIONS, ROLE_VAPP_DEPLOY_UNDEPLOY,ROLE_VAPP_ASSIGN_NETWORK,ROLE_MANAGE_HARD_DISKS,ROLE_VAPP_CREATE_INSTANCE, ROLE_VAPP_CREATE_STATEFUL,ROLE_VAPP_ASSIGN_VOLUME
Request Headers: Accept: application/vnd.abiquo.harddisks+xml; version=2.4; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example
List the hard disks attached to the virtual machine example
curl http://example.com/api/cloud/virtualdatacenters/2/virtualappliances/2/virtualmachines/2/storage/disks \
    -v -u user:pass \
    -X GET \
    -H "Accept: application/vnd.abiquo.harddisks+xml;version=2.4"

> GET /api/cloud/virtualdatacenters/2/virtualappliances/2/virtualmachines/2/storage/disks HTTP/1.1
> Authorization: Basic YWRtaW46eGFiaXF1bw==
> User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18
> Host: example.com
> Accept: application/vnd.abiquo.harddisks+xml;version=2.4
> 
< HTTP/1.1 200 OK
< Date: Tue, 21 Aug 2012 07:01:20 GMT
< Set-Cookie: auth=YWRtaW46MTM0NTUzNDI4MDM4NTozMzJhNDU0NjgyOWViY2UwNDQxYTVkYTFkNjU2ZGI1ZjpBQklRVU8; Expires=Tue, 21-Aug-2012 07:31:20 GMT; Path=/api
< Set-Cookie: JSESSIONID=DDA46BF05AA3FA6E3B6A744A5C8E6A3A; Path=/api
< Content-Type: application/vnd.abiquo.harddisks+xml;version=2.4
< Content-Length: 307
< 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<disks>
    <disk>
        <link rel="edit" type="application/vnd.abiquo.harddisk+xml" href="http://example.com/api/cloud/virtualdatacenters/2/virtualappliances/2/virtualmachines/2/storage/disks/1018"/>
        <sequence>0</sequence>
        <sizeInMb>10240</sizeInMb>
    </disk>
</disks>



Virtual Machine Network Configuration

Exposed Resources Hierarchy
Virtual Machine Network Configuration

Provides access to the virtual machine network configuration information, including the attached NICs, gateway and network configurations such as DNS, etc.

Main URI of the Resource

This class operates mainly over the Resource URI: /cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/network

Exposed Methods

Retrieve the possible network configuration

Synopsis: GET http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/network/configurations
Roles Required: ROLE_VAPP_CUSTOMISE_SETTINGS,ROLE_VAPP_ASSIGN_NETWORK
Request Headers: Accept: application/vnd.abiquo.virtualmachinenetworkconfigurations+xml; version=2.4; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example
Retrive the posible network configuration example
curl http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/configurations \
    -v -u user:pass \
    -X GET \
    -H "Accept: application/vnd.abiquo.virtualmachinenetworkconfigurations+xml;version=2.4"
    
GET http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/configurations HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.virtualmachinenetworkconfigurations+xml;version=2.4

HTTP/1.1 200 OK
Date: Mon, 28 Jan 2013 10:56:10 GMT
Keep-Alive: timeout=15, max=8
Set-Cookie: JSESSIONID=08901BE90E1CB46E329495B9A5E55897.node1; Path=/api
Set-Cookie: auth=YWRtaW46MTM1OTM3MjM3MDY5MTpkZmI0MjkxNTI1YjFiM2MzNzNjNDFjZGZlY2RhZDNjZjpBQklRVU8; Expires=Mon, 28-Jan-2013 11:26:10 GMT; Path=/api
Connection: Keep-Alive
Content-Type: application/vnd.abiquo.virtualmachinenetworkconfigurations+xml;version=2.4
Content-Length: 420

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vmnetworkconfigurations>
    <vmnetworkconfiguration>
        <link rel="edit" type="application/vnd.abiquo.virtualmachinenetworkconfiguration+xml" href="http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/configurations/1"/>
        <gateway>80.80.80.1</gateway>
        <id>1</id>
        <used>false</used>
    </vmnetworkconfiguration>
</vmnetworkconfigurations>



Get the details of a network configuration

Get the details of a network configuration that can be assigned to the virtual machine. Network configurations provide the default gateway address, DNS suffix, static routes, etc, that can be applied to a virtual machine.

Synopsis: GET http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/network/configurations/{configuration}
Roles Required: ROLE_VAPP_CUSTOMISE_SETTINGS
Request Headers: Accept: application/vnd.abiquo.virtualmachinenetworkconfiguration+xml; version=2.4; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example
Get the details of a network configuration example
curl http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/configurations/1 \
    -v -u user:pass \
    -X GET \
    -H "Accept: application/vnd.abiquo.virtualmachinenetworkconfiguration+xml;version=2.4"
    
GET http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/configurations/1 HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.virtualmachinenetworkconfiguration+xml;version=2.4

HTTP/1.1 200 OK
Date: Mon, 28 Jan 2013 10:56:10 GMT
Keep-Alive: timeout=15, max=8
Set-Cookie: JSESSIONID=08901BE90E1CB46E329495B9A5E55897.node1; Path=/api
Set-Cookie: auth=YWRtaW46MTM1OTM3MjM3MDY5MTpkZmI0MjkxNTI1YjFiM2MzNzNjNDFjZGZlY2RhZDNjZjpBQklRVU8; Expires=Mon, 28-Jan-2013 11:26:10 GMT; Path=/api
Connection: Keep-Alive
Content-Type: application/vnd.abiquo.virtualmachinenetworkconfiguration+xml;version=2.4
Content-Length: 420

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vmnetworkconfiguration>
    <link rel="edit" type="application/vnd.abiquo.virtualmachinenetworkconfiguration+xml" href="http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/configurations/1"/>
    <gateway>80.80.80.1</gateway>
    <id>1</id>
    <used>false</used>
</vmnetworkconfiguration>

List the attached NICs

Show details of the NICs attached to the virtual machine.

Synopsis: GET http://example.com/api/cloud/virtualdatacenters/{virtualdatacenter}/virtualappliances/{virtualappliance}/virtualmachines/{virtualmachine}/network/nics
Roles Required: ROLE_VDC_MANAGE_VAPP,ROLE_VAPP_CUSTOMISE_SETTINGS,ROLE_VAPP_ASSIGN_NETWORK, ROLE_VAPP_PERFORM_ACTIONS, ROLE_VAPP_DEPLOY_UNDEPLOY,ROLE_VAPP_ASSIGN_VOLUME, ROLE_MANAGE_HARD_DISKS,ROLE_VAPP_CREATE_INSTANCE, ROLE_VAPP_CREATE_STATEFUL
Request Headers: Accept: application/vnd.abiquo.nics+xml; version=2.4; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example
List the attached NICs example
curl http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/nics \
    -v -u user:pass \
    -X GET \
    -H "Accept: application/vnd.abiquo.nics+xml;version=2.4"

> GET /api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/nics HTTP/1.1
> Authorization: Basic YWRtaW46eGFiaXF1bw==
> User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18
> Host: example.com
> Accept: application/vnd.abiquo.nics+xml;version=2.4
> 
< HTTP/1.1 200 OK
< Date: Tue, 21 Aug 2012 06:51:38 GMT
< Set-Cookie: auth=YWRtaW46MTM0NTUzMzY5ODAyNzo0YmEyNDBiYTlmYmM0Mzk3MjVlYTk0ZjQ1MDEzYWMwNjpBQklRVU8; Expires=Tue, 21-Aug-2012 07:21:38 GMT; Path=/api
< Set-Cookie: JSESSIONID=45D02BA0A083897C4B689AD6ABC1DCB9; Path=/api
< Content-Type: application/vnd.abiquo.nics+xml;version=2.4
< Content-Length: 645
< 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<nics>
    <nic>
        <link rel="nic0" type="application/vnd.abiquo.privateip+xml" href="http://example.com/api/cloud/virtualdatacenters/1/privatenetworks/4/ips/510"/>
        <link title="Kaahumanu Network" rel="privatenetwork" type="application/vnd.abiquo.vlan+xml" href="http://example.com/api/cloud/virtualdatacenters/1/privatenetworks/4"/>
        <link rel="self" type="application/vnd.abiquo.nic+xml" href="http://example.com/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/nics/510"/>
        <id>510</id>
        <ip>192.168.1.2</ip>
        <mac>fe:32:32:0b:e3:94</mac>
        <sequence>0</sequence>
    </nic>
</nics>