Enterprises Resource
The Enterprise Resource offers the functionality of managing the enterprise infrastructure allowing users to set limits, pricing models, restrict usage of physical machines or datacenters. This resource can be used to create enterprises and retrieve the collection of enterprises defined in Abiquo.
Main URI of the Resource
This class operates mainly over the Resource URI: /admin/enterprises
Exposed Methods
Retrieve the list of enterprises
Retrieve the list of enterprises
Synopsis: GET http://example.com/api/admin/enterprises
Roles Required: ROLE_USERS_VIEW,ROLE_USERS_MANAGE_ENTERPRISE,ROLE_USERS_MANAGE_OTHER_ENTERPRISES,ROLE_ENTERPRISE_ENUMERATE,ROLE_PHYS_DC_ALLOW_MODIFY_ALLOCATION,ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK,ROLE_PRICING_VIEW
Request Headers: Accept:
application/vnd.abiquo.enterprises+json; version=3.4; application/vnd.abiquo.enterprises+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
startwith | false | 0 | first element to retrieve |
has | false | | text string to filter the results - return results with this text string in the name |
limit | false | 25 | total number of elements in the result set |
idPricingTemplate | false | -1 | identifier for {@link PricingTemplateResource} |
idScope | false | 1 | identifier for {@link ScopeResource} |
included | false | | include enterprises with no pricing template |
| | | |
Request Message Body Entity:
Response Message Body Entity: Enterprises Media Type
Request Example:
Click here to show or hide the request example
$ curl -X GET http://10.60.20.60/api/admin/enterprises\
-H 'Accept: application/vnd.abiquo.enterprises+xml; version=2.4' \
-u user:password --verbose
GET http://10.60.20.60/api/admin/enterprises HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.enterprises+xml;version=2.4
HTTP/1.1 200 OK
Date: Wed, 16 Jan 2013 14:09:58 GMT
Set-Cookie: JSESSIONID=F6FFACAED71B249A54858EBBDBC90FB1; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0NzE5OTA1NDplMzA3M2ViZmNhZDhmMmVlOGZkZWU4MWNjZWIyN2Q5NzpBQklRVU8; Expires=Wed, 16-Jan-2013 14:39:59 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.enterprises+xml;version=2.4
Content-Length: 5262
<?xml version="1.0" encoding="UTF-8"?>
<enterprises>
<link href="http://10.60.20.60:80/api/admin/enterprises" rel="first"/>
<link href="http://10.60.20.60:80/api/admin/enterprises?startwith=0" rel="last"/>
<totalSize>2</totalSize>
<enterprise>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/appslib/templateDefinitionLists"
rel="appslib/templateDefinitionLists" type="application/vnd.abiquo.templatedefinitionlists+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/appslib/templateDefinitions"
rel="appslib/templateDefinitions" type="application/vnd.abiquo.templatedefinitions+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/action/virtualdatacenters"
rel="cloud/virtualdatacenters" type="application/vnd.abiquo.virtualdatacenters+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/datacenterrepositories"
rel="datacenterrepositories" type="application/vnd.abiquo.datacenterrepositories+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/1"
rel="edit" type="application/vnd.abiquo.enterprise+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/action/externalnetworks"
rel="externalnetworks" type="application/vnd.abiquo.vlans+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/action/ips"
rel="ips" title="ips"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/1/limits"
rel="limits" type="application/vnd.abiquo.limits+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/properties"
rel="properties" type="application/vnd.abiquo.enterpriseproperties+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/reservedmachines"
rel="reservedmachines" type="application/vnd.abiquo.machines+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/1/users"
rel="users" type="application/vnd.abiquo.users+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/action/virtualappliances"
rel="virtualappliances" type="application/vnd.abiquo.virtualappliances+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/action/virtualmachines"
rel="virtualmachines" type="application/vnd.abiquo.virtualmachines+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/action/volumes"
rel="volumes" type="application/vnd.abiquo.iscsivolumes+xml"/>
<cpuHard>0</cpuHard>
<cpuSoft>0</cpuSoft>
<hdHard>0</hdHard>
<hdSoft>0</hdSoft>
<publicIpsHard>0</publicIpsHard>
<publicIpsSoft>0</publicIpsSoft>
<ramHard>0</ramHard>
<ramSoft>0</ramSoft>
<storageHard>0</storageHard>
<storageSoft>0</storageSoft>
<vlansHard>0</vlansHard>
<vlansSoft>0</vlansSoft>
<id>1</id>
<isReservationRestricted>false</isReservationRestricted>
<name>Abiquo</name>
<repositoryHard>0</repositoryHard>
<repositorySoft>0</repositorySoft>
</enterprise>
<enterprise>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/appslib/templateDefinitionLists"
rel="appslib/templateDefinitionLists" type="application/vnd.abiquo.templatedefinitionlists+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/appslib/templateDefinitions"
rel="appslib/templateDefinitions" type="application/vnd.abiquo.templatedefinitions+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualdatacenters"
rel="cloud/virtualdatacenters" type="application/vnd.abiquo.virtualdatacenters+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/datacenterrepositories"
rel="datacenterrepositories" type="application/vnd.abiquo.datacenterrepositories+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2"
rel="edit" type="application/vnd.abiquo.enterprise+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/externalnetworks"
rel="externalnetworks" type="application/vnd.abiquo.vlans+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/ips"
rel="ips" title="ips"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/limits"
rel="limits" type="application/vnd.abiquo.limits+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/properties"
rel="properties" type="application/vnd.abiquo.enterpriseproperties+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/reservedmachines"
rel="reservedmachines" type="application/vnd.abiquo.machines+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/users"
rel="users" type="application/vnd.abiquo.users+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualappliances"
rel="virtualappliances" type="application/vnd.abiquo.virtualappliances+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualmachines"
rel="virtualmachines" type="application/vnd.abiquo.virtualmachines+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/volumes"
rel="volumes" type="application/vnd.abiquo.iscsivolumes+xml"/>
<cpuHard>0</cpuHard>
<cpuSoft>0</cpuSoft>
<hdHard>0</hdHard>
<hdSoft>0</hdSoft>
<publicIpsHard>0</publicIpsHard>
<publicIpsSoft>0</publicIpsSoft>
<ramHard>0</ramHard>
<ramSoft>0</ramSoft>
<storageHard>0</storageHard>
<storageSoft>0</storageSoft>
<vlansHard>0</vlansHard>
<vlansSoft>0</vlansSoft>
<id>2</id>
<isReservationRestricted>false</isReservationRestricted>
<name>JC-b8e62569-389</name>
<repositoryHard>0</repositoryHard>
<repositorySoft>0</repositorySoft>
</enterprise>
</enterprises>
Create an enterprise
Create an enterprise and returns it after creation. Remember that to allow this enterprise to use a datacenter or public cloud region, you must create a datacenter limit for the enterprise.
Synopsis: POST http://example.com/api/admin/enterprises
Roles Required: ROLE_USERS_MANAGE_OTHER_ENTERPRISES
Request Headers: Accept:
application/vnd.abiquo.enterprise+json; version=3.4; application/vnd.abiquo.enterprise+xml; version=3.4; Content-type:
application/vnd.abiquo.enterprise+json; version=3.4; application/vnd.abiquo.enterprise+xml; version=3.4;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity: Enterprise Media Type
Response Message Body Entity: Enterprise Media Type
Request Example:
Click here to show or hide the request example
$ curl -X POST http://10.60.20.60/api/admin/enterprises\
-H 'Accept: application/vnd.abiquo.enterprise+xml; version=2.4' \
-H 'Content-Type: application/vnd.abiquo.enterprise+xml; version=2.4' \
-d @entity.xml \
-u user:password --verbose
POST http://10.60.20.60/api/admin/enterprises HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.enterprise+xml;version=2.4
Content-Type: application/vnd.abiquo.enterprise+xml;version=2.4
Content-Length: 603
HTTP/1.1 201 Created
Date: Wed, 16 Jan 2013 14:07:10 GMT
Location: http://10.60.20.60:80/api/admin/enterprises/3
Set-Cookie: JSESSIONID=26EE18C4F8FFE22AD81A76A1F065A193; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0NzAzMDY5NjozZjc5YTIyOTRkNzM1MjgwOWE2ODEyYTkyMzExMzBlNzpBQklRVU8; Expires=Wed, 16-Jan-2013 14:37:10 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.enterprise+xml;version=2.4
Content-Length: 2566
<?xml version="1.0" encoding="UTF-8"?>
<enterprise>
<link href="http://10.60.20.60:80/api/admin/enterprises/3" rel="edit" type="application/vnd.abiquo.enterprise+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/3/users"
rel="users" type="application/vnd.abiquo.users+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/3/properties"
rel="properties" type="application/vnd.abiquo.enterpriseproperties+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/3/appslib/templateDefinitionLists"
rel="appslib/templateDefinitionLists" type="application/vnd.abiquo.templatedefinitionlists+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/3/appslib/templateDefinitions"
rel="appslib/templateDefinitions" type="application/vnd.abiquo.templatedefinitions+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/3/datacenterrepositories"
rel="datacenterrepositories" type="application/vnd.abiquo.datacenterrepositories+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/3/action/virtualmachines"
rel="virtualmachines" type="application/vnd.abiquo.virtualmachines+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/3/action/virtualappliances"
rel="virtualappliances" type="application/vnd.abiquo.virtualappliances+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/3/action/ips"
rel="ips" title="ips"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/3/action/virtualdatacenters"
rel="cloud/virtualdatacenters" type="application/vnd.abiquo.virtualdatacenters+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/3/reservedmachines"
rel="reservedmachines" type="application/vnd.abiquo.machines+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/3/limits"
rel="limits" type="application/vnd.abiquo.limits+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/3/action/volumes"
rel="volumes" type="application/vnd.abiquo.iscsivolumes+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/3/action/externalnetworks"
rel="externalnetworks" type="application/vnd.abiquo.vlans+xml"/>
<cpuHard>0</cpuHard>
<cpuSoft>0</cpuSoft>
<hdHard>0</hdHard>
<hdSoft>0</hdSoft>
<publicIpsHard>0</publicIpsHard>
<publicIpsSoft>0</publicIpsSoft>
<ramHard>0</ramHard>
<ramSoft>0</ramSoft>
<storageHard>0</storageHard>
<storageSoft>0</storageSoft>
<vlansHard>0</vlansHard>
<vlansSoft>0</vlansSoft>
<id>3</id>
<isReservationRestricted>false</isReservationRestricted>
<name>JC--enterprise-test</name>
<repositoryHard>0</repositoryHard>
<repositorySoft>0</repositorySoft>
</enterprise>
Retrieve the list of enterprise identifiers and names
Retrieve the list of enterprises with only the identifier and name of each enterprise
Synopsis: GET http://example.com/api/admin/enterprises
Roles Required: ROLE_USERS_VIEW,ROLE_USERS_MANAGE_ENTERPRISE,ROLE_USERS_MANAGE_OTHER_ENTERPRISES,ROLE_ENTERPRISE_ENUMERATE,ROLE_PHYS_DC_ALLOW_MODIFY_ALLOCATION,ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK,ROLE_PRICING_VIEW
Request Headers: Accept:
application/vnd.abiquo.enterprises-id-name+json; version=3.4; application/vnd.abiquo.enterprises-id-name+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
startwith | false | 0 | first element to retrieve |
has | false | | text string to filter the results - return results with this text string in the name |
limit | false | 25 | total number of elements in the result set |
idPricingTemplate | false | -1 | identifier for {@link PricingTemplateResource} |
idScope | false | 1 | identifier for {@link ScopeResource} |
included | false | | include enterprises with no pricing template |
| | | |
Request Message Body Entity:
Response Message Body Entity: EnterprisesIdName Media Type
Request Example:
Click here to show or hide the request example
Context:
Here we use the "has" parameter to retrieve only the enterprises with the text "bar" in their names.
Main URI of the Resource
This class operates mainly over the Resource URI: /admin/enterprises/{enterprise}
Exposed Methods
Retrieves an enterprise object with basic information
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}
Roles Required: ROLE_AUTHENTICATED,ROLE_USERS_VIEW,ROLE_USERS_MANAGE_OTHER_ENTERPRISES,ROLE_PRICING_VIEW
Request Headers: Accept:
application/vnd.abiquo.enterprise+json; version=3.4; application/vnd.abiquo.enterprise+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity:
Response Message Body Entity: Enterprise Media Type
Request Example:
Click here to show or hide the request example
$ curl -X GET http://10.60.20.60:80/api/admin/enterprises/2\
-H 'Accept: application/vnd.abiquo.enterprise+xml; version=2.4' \
-u user:password --verbose
GET http://10.60.20.60:80/api/admin/enterprises/2 HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.enterprise+xml;version=2.4
HTTP/1.1 200 OK
Date: Wed, 16 Jan 2013 14:10:09 GMT
Set-Cookie: JSESSIONID=9F369F604606EDBFF45A45158B352455; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0NzIwOTMzOTpmNmZkOTA4YmY0MzRlZjYzYjRiNjFhZTZiZmQ1ZGIxODpBQklRVU8; Expires=Wed, 16-Jan-2013 14:40:09 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.enterprise+xml;version=2.4
Content-Length: 2562
<?xml version="1.0" encoding="UTF-8"?>
<enterprise>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/appslib/templateDefinitionLists"
rel="appslib/templateDefinitionLists" type="application/vnd.abiquo.templatedefinitionlists+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/appslib/templateDefinitions"
rel="appslib/templateDefinitions" type="application/vnd.abiquo.templatedefinitions+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualdatacenters"
rel="cloud/virtualdatacenters" type="application/vnd.abiquo.virtualdatacenters+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/datacenterrepositories"
rel="datacenterrepositories" type="application/vnd.abiquo.datacenterrepositories+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2" rel="edit" type="application/vnd.abiquo.enterprise+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/externalnetworks"
rel="externalnetworks" type="application/vnd.abiquo.vlans+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/action/ips"
rel="ips" title="ips"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/limits"
rel="limits" type="application/vnd.abiquo.limits+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/properties"
rel="properties" type="application/vnd.abiquo.enterpriseproperties+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/reservedmachines"
rel="reservedmachines" type="application/vnd.abiquo.machines+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/users"
rel="users" type="application/vnd.abiquo.users+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualappliances"
rel="virtualappliances" type="application/vnd.abiquo.virtualappliances+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualmachines"
rel="virtualmachines" type="application/vnd.abiquo.virtualmachines+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/volumes"
rel="volumes" type="application/vnd.abiquo.iscsivolumes+xml"/>
<cpuHard>0</cpuHard>
<cpuSoft>0</cpuSoft>
<hdHard>0</hdHard>
<hdSoft>0</hdSoft>
<publicIpsHard>0</publicIpsHard>
<publicIpsSoft>0</publicIpsSoft>
<ramHard>0</ramHard>
<ramSoft>0</ramSoft>
<storageHard>0</storageHard>
<storageSoft>0</storageSoft>
<vlansHard>0</vlansHard>
<vlansSoft>0</vlansSoft>
<id>2</id>
<isReservationRestricted>false</isReservationRestricted>
<name>JC-b8e62569-389</name>
<repositoryHard>0</repositoryHard>
<repositorySoft>0</repositorySoft>
</enterprise>
Retrieve a list of virtual machines with own node
Retrieve a list of virtual machines with own node created by an enterprise in any virtual datacenter.
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/virtualmachines
Roles Required: ROLE_VAPP_CUSTOMISE_SETTINGS
Request Headers: Accept:
application/vnd.abiquo.virtualmachineswithnode+json; version=2.6; application/vnd.abiquo.virtualmachineswithnode+xml; version=2.6; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity:
Response Message Body Entity: VirtualMachinesWithNode Media Type
Request Example:
Click here to show or hide the request example
$ curl -X GET http://10.60.20.60:80/api/admin/enterprises/1/action/virtualmachines\
-H 'Accept: application/vnd.abiquo.virtualmachineswithnodeextended+xml; version=2.4' \
-u user:password --verbose
GET http://10.60.20.60:80/api/admin/enterprises/1/action/virtualmachines HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.virtualmachineswithnodeextended+xml;version=2.4
HTTP/1.1 200 OK
Date: Wed, 16 Jan 2013 14:07:11 GMT
Set-Cookie: JSESSIONID=3E673380A8D5E6A94332825988C85AB7; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0NzAzMTYzMTphY2ZmZTE2YWZiZDNhZjQxZjJkOGZhNjM1MDZmMTVhNjpBQklRVU8; Expires=Wed, 16-Jan-2013 14:37:11 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.virtualmachineswithnodeextended+xml;version=2.4
Content-Length: 3622
<?xml version="1.0" encoding="UTF-8"?>
<virtualmachineswithnodeextended>
<virtualmachinewithnodeextended>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/configurations"
rel="configurations" type="application/vnd.abiquo.virtualmachinenetworkconfigurations+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/7/conversions/VMDK_FLAT"
rel="conversion" type="application/vnd.abiquo.conversion+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/deploy"
rel="deploy" type="application/vnd.abiquo.acceptedrequest+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1"
rel="edit" type="application/vnd.abiquo.virtualmachinewithnodeextended+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/1"
rel="enterprise" type="application/vnd.abiquo.enterprise+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/storage/disks"
rel="harddisks" type="application/vnd.abiquo.harddisks+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/instance"
rel="instance" type="application/vnd.abiquo.acceptedrequest+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/nics"
rel="nics" type="application/vnd.abiquo.nics+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/reset"
rel="reset" type="application/vnd.abiquo.acceptedrequest+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/state"
rel="state" type="application/vnd.abiquo.virtualmachinestate+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/tasks"
rel="tasks" type="application/vnd.abiquo.tasks+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/undeploy"
rel="undeploy" type="application/vnd.abiquo.acceptedrequest+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/1/users/1"
rel="user" type="application/vnd.abiquo.user+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1"
rel="virtualappliance" type="application/vnd.abiquo.virtualappliance+xml; version=2.4"/>
<link href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1"
rel="virtualdatacenter" title="VMX_04" type="application/vnd.abiquo.virtualdatacenter+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/7"
rel="virtualmachinetemplate" type="application/vnd.abiquo.virtualmachinetemplate+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/storage/volumes"
rel="volumes" type="application/vnd.abiquo.iscsivolumes+xml"/>
<cpu>2</cpu>
<hdInBytes>27262976</hdInBytes>
<highDisponibility>0</highDisponibility>
<id>1</id>
<idState>1</idState>
<idType>1</idType>
<name>ABQ_5ca657fa-ed61-4aa4-95b9-cd76d46ed63c</name>
<ram>128</ram>
<state>NOT_ALLOCATED</state>
<uuid>5ca657fa-ed61-4aa4-95b9-cd76d46ed63c</uuid>
<vdrpPort>0</vdrpPort>
<nodeId>1</nodeId>
<nodeName>JC-VM Aloha</nodeName>
<x>0</x>
<y>0</y>
<enterpriseName>Abiquo</enterpriseName>
<userName>Cloud</userName>
<userSurname>Administrator</userSurname>
</virtualmachinewithnodeextended>
</virtualmachineswithnodeextended>
Retrieve a list of virtual machines
Retrieve a list of virtual machines created by an enterprise in any virtual datacenter.
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/virtualmachines
Roles Required: ROLE_VAPP_CUSTOMISE_SETTINGS
Request Headers: Accept:
application/vnd.abiquo.virtualmachines+json; version=3.4; application/vnd.abiquo.virtualmachines+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity:
Response Message Body Entity: VirtualMachines Media Type
Request Example:
Click here to show or hide the request example
curl -X GET "http://example.com/api/admin/enterprises/1/action/virtualmachines" -H "Accept:application/vnd.abiquo.virtualmachines+xml; version=2.0;" -u user:password | xmlindent -nbe -f
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 3939 100 3939 0 0 15171 0 --:--:-- --:--:-- --:--:-- 15150
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<virtualMachines>
<virtualMachine>
<link rel="configurations" type="application/vnd.abiquo.virtualmachinenetworkconfigurations+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/configurations"/>
<link rel="deploy" type="application/vnd.abiquo.acceptedrequest+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/deploy"/>
<link rel="disks" type="application/vnd.abiquo.harddisks+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/storage/disks"/>
<link rel="edit" type="application/vnd.abiquo.virtualmachine+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1"/>
<link rel="edit" type="application/vnd.abiquo.virtualmachine+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1"/>
<link rel="enterprise" type="application/vnd.abiquo.enterprise+xml" href="http://example.com:80/api/admin/enterprises/1"/>
<link rel="instance" type="application/vnd.abiquo.acceptedrequest+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/instance"/>
<link rel="network_configuration" type="application/vnd.abiquo.virtualmachinenetworkconfiguration+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/configurations/1"/>
<link rel="nics" type="application/vnd.abiquo.nics+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/nics"/>
<link rel="privateip" type="application/vnd.abiquo.ip+xml; version=2.0" href="http://example.com:80/api/cloud/virtualdatacenters/1/privatenetworks/1/ips/2"/>
<link rel="reset" type="application/vnd.abiquo.acceptedrequest+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/reset"/>
<link rel="state" type="application/vnd.abiquo.virtualmachinestate+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/state"/>
<link rel="tasks" type="application/vnd.abiquo.tasks+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/tasks"/>
<link rel="tasks" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/tasks"/>
<link rel="undeploy" type="application/vnd.abiquo.acceptedrequest+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/undeploy"/>
<link rel="user" type="application/vnd.abiquo.user+xml" href="http://example.com:80/api/admin/enterprises/1/users/1"/>
<link rel="virtualappliance" type="application/vnd.abiquo.virtualappliance+xml; version=2.2" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1"/>
<link title="HYPERV_301" rel="virtualdatacenter" type="application/vnd.abiquo.virtualdatacenter+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1"/>
<link rel="virtualmachinetemplate" type="application/vnd.abiquo.virtualmachinetemplate+xml" href="http://example.com:80/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/12"/>
<link rel="volumes" type="application/vnd.abiquo.iscsivolumes+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/storage/volumes"/>
<cpu>1</cpu>
<description>Ubuntu_11_10_SSH_vhd</description>
<hdInBytes>5368709120</hdInBytes>
<highDisponibility>0</highDisponibility>
<id>1</id>
<idState>1</idState>
<idType>1</idType>
<name>ABQ_74f32c39-9058-4432-b6b0-b08510388643</name>
<password></password>
<ram>512</ram>
<state>NOT_ALLOCATED</state>
<uuid>74f32c39-9058-4432-b6b0-b08510388643</uuid>
<vdrpPort>0</vdrpPort>
</virtualMachine>
</virtualMachines>
Retrieve the list of virtual machines with own node and extra user info
Retrieve the list of virtual machines with own node and extra user info defined in an enterprise.
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/virtualmachines
Roles Required: ROLE_VAPP_CUSTOMISE_SETTINGS
Request Headers: Accept:
application/vnd.abiquo.virtualmachineswithnodeextended+json; version=3.4; application/vnd.abiquo.virtualmachineswithnodeextended+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity:
Response Message Body Entity: VirtualMachinesWithNodeExtended Media Type
Request Example:
Click here to show or hide the request example
$ curl -X GET http://10.60.20.60:80/api/admin/enterprises/1/action/virtualmachines\
-H 'Accept: application/vnd.abiquo.virtualmachineswithnodeextended+xml; version=2.4' \
-u user:password --verbose
GET http://10.60.20.60:80/api/admin/enterprises/1/action/virtualmachines HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.virtualmachineswithnodeextended+xml;version=2.4
HTTP/1.1 200 OK
Date: Wed, 16 Jan 2013 14:07:11 GMT
Set-Cookie: JSESSIONID=3E673380A8D5E6A94332825988C85AB7; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0NzAzMTYzMTphY2ZmZTE2YWZiZDNhZjQxZjJkOGZhNjM1MDZmMTVhNjpBQklRVU8; Expires=Wed, 16-Jan-2013 14:37:11 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.virtualmachineswithnodeextended+xml;version=2.4
Content-Length: 3622
<?xml version="1.0" encoding="UTF-8"?>
<virtualmachineswithnodeextended>
<virtualmachinewithnodeextended>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/configurations"
rel="configurations" type="application/vnd.abiquo.virtualmachinenetworkconfigurations+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/7/conversions/VMDK_FLAT"
rel="conversion" type="application/vnd.abiquo.conversion+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/deploy"
rel="deploy" type="application/vnd.abiquo.acceptedrequest+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1"
rel="edit" type="application/vnd.abiquo.virtualmachinewithnodeextended+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/1"
rel="enterprise" type="application/vnd.abiquo.enterprise+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/storage/disks"
rel="harddisks" type="application/vnd.abiquo.harddisks+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/instance"
rel="instance" type="application/vnd.abiquo.acceptedrequest+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/network/nics"
rel="nics" type="application/vnd.abiquo.nics+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/reset"
rel="reset" type="application/vnd.abiquo.acceptedrequest+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/state"
rel="state" type="application/vnd.abiquo.virtualmachinestate+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/tasks"
rel="tasks" type="application/vnd.abiquo.tasks+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/action/undeploy"
rel="undeploy" type="application/vnd.abiquo.acceptedrequest+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/1/users/1"
rel="user" type="application/vnd.abiquo.user+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1"
rel="virtualappliance" type="application/vnd.abiquo.virtualappliance+xml; version=2.4"/>
<link href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1"
rel="virtualdatacenter" title="VMX_04" type="application/vnd.abiquo.virtualdatacenter+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/7"
rel="virtualmachinetemplate" type="application/vnd.abiquo.virtualmachinetemplate+xml"/>
<link
href="http://10.60.20.60:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines/1/storage/volumes"
rel="volumes" type="application/vnd.abiquo.iscsivolumes+xml"/>
<cpu>2</cpu>
<hdInBytes>27262976</hdInBytes>
<highDisponibility>0</highDisponibility>
<id>1</id>
<idState>1</idState>
<idType>1</idType>
<name>ABQ_5ca657fa-ed61-4aa4-95b9-cd76d46ed63c</name>
<ram>128</ram>
<state>NOT_ALLOCATED</state>
<uuid>5ca657fa-ed61-4aa4-95b9-cd76d46ed63c</uuid>
<vdrpPort>0</vdrpPort>
<nodeId>1</nodeId>
<nodeName>JC-VM Aloha</nodeName>
<x>0</x>
<y>0</y>
<enterpriseName>Abiquo</enterpriseName>
<userName>Cloud</userName>
<userSurname>Administrator</userSurname>
</virtualmachinewithnodeextended>
</virtualmachineswithnodeextended>
Retrieve a VLANNetworkDto entity.
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/publicnetworks/{publicnetwork}
Roles Required:
Request Headers: Accept:
application/vnd.abiquo.vlan+json; version=3.4; application/vnd.abiquo.vlan+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity:
Response Message Body Entity: VLANNetwork Media Type
Request Example:
Click here to show or hide the request example
$ curl -X GET "http://example.com/api/admin/enterprises/1/action/publicnetworks/1" -H "Accept:application/vnd.abiquo.vlans+xml; version=2.0;" -u user:password | xmlindent -nbe -f
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 646 100 646 0 0 7956 0 --:--:-- --:--:-- --:--:-- 14355
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<network>
<link rel="datacenter" type="application/vnd.abiquo.datacenter+xml" href="http://example.com:80/api/admin/datacenters/1"/>
<link rel="edit" type="application/vnd.abiquo.vlan+xml" href="http://example.com:80/api/admin/datacenters/1/network/1"/>
<link rel="ips" type="application/vnd.abiquo.publicips+xml; version=2.4" href="http://example.com:80/api/admin/datacenters/1/network/1/ips"/>
<link rel="networkservicetype" type="application/vnd.abiquo.vlan+xml" href="http://example.com:80/api/admin/datacenters/1/networkservicetypes/1"/>
<link rel="networkservicetypes" type="application/vnd.abiquo.vlan+xml" href="http://example.com:80/api/admin/datacenters/1/networkservicetypes"/>
<id>1</id>
<name>pub</name>
<address>8.8.8.0</address>
<mask>26</mask>
<gateway>8.8.8.1</gateway>
<primaryDNS></primaryDNS>
<secondaryDNS></secondaryDNS>
<sufixDNS></sufixDNS>
<tag>8</tag>
<type>PUBLIC</type>
<dhcpOptions/>
</network>
Retrieve a VLANNetworksDto entity.
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/publicnetworks
Roles Required:
Request Headers: Accept:
application/vnd.abiquo.vlans+json; version=3.4; application/vnd.abiquo.vlans+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
datacenterId | true | | identifier of the datacenter of which we want to retrieve public networks |
| | | |
Request Message Body Entity:
Response Message Body Entity: VLANNetworks Media Type
Request Example:
Click here to show or hide the request example
$ curl -X GET "http://example.com/api/admin/enterprises/1/action/publicnetworks?datacenterId=1" -H "Accept:application/vnd.abiquo.vlans+xml; version=2.0;" -u user:password | xmlindent -nbe -f
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 646 100 646 0 0 7956 0 --:--:-- --:--:-- --:--:-- 14355
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<networks>
<link rel="checkavailability" type="application/vnd.abiquo.vlantagavailability+xml" href="http://example.com:80/api/admin/datacenters/1/network/action/checkavailability"/>
<link rel="publicips" type="application/vnd.abiquo.publicips+xml; version=2.4" href="http://example.com:80/api/admin/datacenters/1/network/action/publicips"/>
<link rel="externalips" type="application/vnd.abiquo.externalips+xml; version=2.4" href="http://example.com:80/api/admin/datacenters/1/network/action/externalips"/>
<link rel="unmanagedips" type="application/vnd.abiquo.unmanagedips+xml; version=2.4" href="http://example.com:80/api/admin/datacenters/1/network/action/unmanagedips"/>
<totalSize>1</totalSize>
<network>
<link rel="datacenter" type="application/vnd.abiquo.datacenter+xml" href="http://example.com:80/api/admin/datacenters/1"/>
<link rel="edit" type="application/vnd.abiquo.vlan+xml" href="http://example.com:80/api/admin/datacenters/1/network/1"/>
<link rel="ips" type="application/vnd.abiquo.publicips+xml; version=2.4" href="http://example.com:80/api/admin/datacenters/1/network/1/ips"/>
<link rel="networkservicetype" type="application/vnd.abiquo.vlan+xml" href="http://example.com:80/api/admin/datacenters/1/networkservicetypes/1"/>
<link rel="networkservicetypes" type="application/vnd.abiquo.vlan+xml" href="http://example.com:80/api/admin/datacenters/1/networkservicetypes"/>
<id>1</id>
<name>pub</name>
<address>8.8.8.0</address>
<mask>26</mask>
<gateway>8.8.8.1</gateway>
<primaryDNS></primaryDNS>
<secondaryDNS></secondaryDNS>
<sufixDNS></sufixDNS>
<tag>8</tag>
<type>PUBLIC</type>
<dhcpOptions/>
</network>
</networks>
Retrieve a list of virtual datacenters
Retrieve an ordered and filtered list of virtual datacenters defined for an enterprise
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/virtualdatacenters
Roles Required: ROLE_VDC_ENUMERATE, ROLE_PHYS_DC_RETRIEVE_DETAILS
Request Headers: Accept:
application/vnd.abiquo.virtualdatacenters+json; version=3.4; application/vnd.abiquo.virtualdatacenters+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
startwith | false | 0 | first element to retrieve |
limit | false | 25 | total number of elements in the result set |
by | false | name | parameter for ordering |
has | false | | name to filter the results |
asc | false | true | true/false ascending/descending order |
| | | |
Request Message Body Entity:
Response Message Body Entity: VirtualDatacenters Media Type
Request Example:
Click here to show or hide the request example
curl -X GET "http://example.com/api/admin/enterprises/1/action/virtualdatacenters" -H "Accept:application/vnd.abiquo.virtualdatacenters+xml; version=2.0;" -u user:password | xmlindent -nbe -f
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 3550 100 3550 0 0 49686 0 --:--:-- --:--:-- --:--:-- 50714
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<virtualDatacenters>
<link rel="first" href="http://example.com:80/api/admin/enterprises/1/action/virtualdatacenters"/>
<link rel="last" href="http://example.com:80/api/admin/enterprises/1/action/virtualdatacenters?startwith=0"/>
<totalSize>1</totalSize>
<virtualDatacenter>
<link rel="datacenter" type="application/vnd.abiquo.datacenter+xml" href="http://example.com:80/api/admin/datacenters/1"/>
<link rel="defaultnetwork" type="application/vnd.abiquo.vlan+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/privatenetworks/1"/>
<link title="GET" rel="defaultvlan" type="application/vnd.abiquo.vlan+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/action/defaultvlan"/>
<link title="PUT" rel="defaultvlan" type="application/vnd.abiquo.links+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/action/defaultvlan"/>
<link rel="disks" type="application/vnd.abiquo.harddisks+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/disks"/>
<link rel="edit" type="application/vnd.abiquo.virtualdatacenter+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1"/>
<link rel="enterprise" type="application/vnd.abiquo.enterprise+xml" href="http://example.com:80/api/admin/enterprises/1"/>
<link rel="ips" type="application/vnd.abiquo.ip+xml; version=2.0" href="http://example.com:80/api/cloud/virtualdatacenters/1/action/ips"/>
<link rel="privatenetworks" type="application/vnd.abiquo.vlans+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/privatenetworks"/>
<link rel="purchased" type="application/vnd.abiquo.ips+xml; version=2.0" href="http://example.com:80/api/cloud/virtualdatacenters/1/publicips/purchased"/>
<link rel="statefulcandidates" type="application/vnd.abiquo.iscsivolumes+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/volumes/action/statefulcandidates"/>
<link rel="tiers" type="application/vnd.abiquo.tiers+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/tiers"/>
<link rel="topurchase" type="application/vnd.abiquo.ips+xml; version=2.0" href="http://example.com:80/api/cloud/virtualdatacenters/1/publicips/topurchase"/>
<link rel="virtualappliances" type="application/vnd.abiquo.virtualappliances+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances"/>
<link rel="volumes" type="application/vnd.abiquo.iscsivolumes+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/volumes"/>
<cpuHard>0</cpuHard>
<cpuSoft>0</cpuSoft>
<hdHard>0</hdHard>
<hdSoft>0</hdSoft>
<publicIpsHard>0</publicIpsHard>
<publicIpsSoft>0</publicIpsSoft>
<ramHard>0</ramHard>
<ramSoft>0</ramSoft>
<storageHard>0</storageHard>
<storageSoft>0</storageSoft>
<vlansHard>0</vlansHard>
<vlansSoft>0</vlansSoft>
<hypervisorType>HYPERV_301</hypervisorType>
<id>1</id>
<name>vdc</name>
<network>
<link rel="virtualdatacenter" type="application/vnd.abiquo.virtualdatacenter+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1"/>
<link rel="edit" type="application/vnd.abiquo.vlan+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/privatenetworks/1"/>
<link rel="ips" type="application/vnd.abiquo.ip+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/privatenetworks/1/ips"/>
<address>192.168.0.0</address>
<dhcpOptions/>
<gateway>192.168.0.1</gateway>
<id>1</id>
<mask>24</mask>
<name>default_private_network</name>
<primaryDNS></primaryDNS>
<secondaryDNS></secondaryDNS>
<sufixDNS></sufixDNS>
<type>INTERNAL</type>
</network>
</virtualDatacenter>
</virtualDatacenters>
Retrieve the list of virtual appliances
Retrieve the list of virtual appliances defined in an enterprise
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/virtualappliances
Roles Required: ROLE_VDC_ENUMERATE
Request Headers: Accept:
application/vnd.abiquo.virtualappliances+json; version=3.4; application/vnd.abiquo.virtualappliances+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
startwith | false | 0 | first element to retrieve |
limit | false | 25 | total number of elements in the result set |
by | false | name | parameter for ordering. Valid values {} |
has | false | | name to filter the results |
asc | false | true | true/false ascending/descending order |
expand | false | | adds information on last tasks by Vapp nodes |
| | | |
Request Message Body Entity:
Response Message Body Entity: VirtualAppliances Media Type
Request Example:
Click here to show or hide the request example
curl -X GET "http://example.com/api/admin/enterprises/1/action/virtualappliances" -H "Accept:application/vnd.abiquo.virtualappliances+xml; version=2.0;" -u user:password | xmlindent -nbe -f
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 1564 100 1564 0 0 39426 0 --:--:-- --:--:-- --:--:-- 40102
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<virtualAppliances>
<totalSize>1</totalSize>
<virtualAppliance>
<link rel="deploy" type="application/vnd.abiquo.acceptedrequest+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/action/deploy"/>
<link rel="edit" type="application/vnd.abiquo.virtualappliance+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1"/>
<link rel="enterprise" type="application/vnd.abiquo.enterprise+xml" href="http://example.com:80/api/admin/enterprises/1"/>
<link rel="price" type="text/plain" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/action/price"/>
<link rel="state" type="application/vnd.abiquo.virtualappliancestate+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/state"/>
<link rel="undeploy" type="application/vnd.abiquo.acceptedrequest+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/action/undeploy"/>
<link rel="virtualdatacenter" type="application/vnd.abiquo.virtualdatacenter+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1"/>
<link rel="virtualmachines" type="application/vnd.abiquo.virtualmachines+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/1/virtualmachines"/>
<error>0</error>
<highDisponibility>0</highDisponibility>
<id>1</id>
<name>vapp</name>
<nodeconnections><connections/></nodeconnections>
<publicApp>0</publicApp>
<state>NOT_DEPLOYED</state>
</virtualAppliance>
</virtualAppliances>
Delete an enterprise
Deletes an existing enterprise
Synopsis: DELETE http://example.com/api/admin/enterprises/{enterprise}
Roles Required: ROLE_USERS_MANAGE_ENTERPRISE
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
$ curl -X DELETE http://10.60.20.60:80/api/admin/enterprises/3\
-u user:password --verbose
DELETE http://10.60.20.60:80/api/admin/enterprises/3 HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
HTTP/1.1 204 No Content
Date: Wed, 16 Jan 2013 14:07:13 GMT
Set-Cookie: JSESSIONID=4804C76B0A5E65E69F788896487A5470; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0NzAzMzgxOTpmNDUzZDBkYjBmNzllODJhMjUxMGZkZjVmNzc0NDdhZTpBQklRVU8; Expires=Wed, 16-Jan-2013 14:37:13 GMT; Path=/api
Server: Apache-Coyote/1.1
Retrieves an enterprise object with additional information on a custom theme assigned to it
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}
Roles Required: ROLE_AUTHENTICATED,ROLE_USERS_VIEW,ROLE_USERS_MANAGE_OTHER_ENTERPRISES,ROLE_PRICING_VIEW
Request Headers: Accept:
application/vnd.abiquo.enterprisetheme+json; version=3.4; application/vnd.abiquo.enterprisetheme+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity:
Response Message Body Entity: Enterprise Media Type
Request Example:
Click here to show or hide the request example
$ curl -X GET http://10.60.20.60:80/api/admin/enterprises/2\
-H 'Accept: application/vnd.abiquo.enterprisetheme+xml; version=2.6' \
-u user:password --verbose
> User-Agent: curl/7.29.0
> Host: 192.168.2.219
> Accept:application/vnd.abiquo.enterprisetheme+xml; version=2.6
>
< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Set-Cookie: auth=YWRtaW46MTM3NTEzMjI5MjIzNzpiNjYzN2MwZGJhYThiNDQ5OWE3MzgyMDVjNDNhMzM2YzpBQklRVU8; Expires=Mon, 29-Jul-2013 21:11:32 GMT; Path=/api
< Set-Cookie: JSESSIONID=8CE69C727A00B407356E364FEF9E6E90; Path=/api
< Content-Type: application/vnd.abiquo.enterprisetheme+xml;version=2.6
< Content-Length: 2748
< Date: Mon, 29 Jul 2013 20:41:32 GMT
<
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<enterprisetheme>
<link rel="edit" type="application/vnd.abiquo.enterprise+xml" href="http://192.168.2.219:80/api/admin/enterprises/1"/>
<link rel="users" type="application/vnd.abiquo.users+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/users"/>
<link rel="properties" type="application/vnd.abiquo.enterpriseproperties+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/properties"/>
<link rel="appslib/templateDefinitionLists" type="application/vnd.abiquo.templatedefinitionlists+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/appslib/templateDefinitionLists"/>
<link rel="appslib/templateDefinitions" type="application/vnd.abiquo.templatedefinitions+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/appslib/templateDefinitions"/>
<link rel="datacenterrepositories" type="application/vnd.abiquo.datacenterrepositories+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/datacenterrepositories"/>
<link rel="virtualmachines" type="application/vnd.abiquo.virtualmachines+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/action/virtualmachines"/>
<link rel="virtualappliances" type="application/vnd.abiquo.virtualappliances+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/action/virtualappliances"/>
<link title="ips" rel="ips" href="http://192.168.2.219:80/api/admin/enterprises/1/action/ips"/>
<link rel="cloud/virtualdatacenters" type="application/vnd.abiquo.virtualdatacenters+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/action/virtualdatacenters"/>
<link rel="reservedmachines" type="application/vnd.abiquo.machines+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/reservedmachines"/>
<link rel="limits" type="application/vnd.abiquo.limits+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/limits"/>
<link rel="volumes" type="application/vnd.abiquo.volumes+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/action/volumes"/>
<link rel="externalnetworks" type="application/vnd.abiquo.vlans+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/action/externalnetworks"/>
<link title="pendingtasks" rel="pendingtasks" type="application/vnd.abiquo.tasks+xml" href="http://192.168.2.219:80/api/admin/enterprises/1/action/pendingtasks"/>
<cpuHard>0</cpuHard>
<cpuSoft>0</cpuSoft>
<ramHard>0</ramHard>
<ramSoft>0</ramSoft>
<hdHard>0</hdHard>
<hdSoft>0</hdSoft>
<storageHard>0</storageHard>
<storageSoft>0</storageSoft>
<vlansHard>0</vlansHard>
<vlansSoft>0</vlansSoft>
<publicIpsHard>0</publicIpsHard>
<publicIpsSoft>0</publicIpsSoft>
<repositoryHard>0</repositoryHard>
<repositorySoft>0</repositorySoft>
<id>1</id>
<name>Abiquo</name>
<isReservationRestricted>false</isReservationRestricted>
</enterprisetheme>
Update an enterprise and its theme
Updates an existing enterprise object and its theme. Can update the enterprise and the additional information on a custom theme created for it
Synopsis: PUT http://example.com/api/admin/enterprises/{enterprise}
Roles Required: ROLE_USERS_MANAGE_ENTERPRISE,ROLE_PRICING_VIEW
Request Headers: Accept:
application/vnd.abiquo.enterprisetheme+json; version=3.4; application/vnd.abiquo.enterprisetheme+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity: EnterpriseTheme Media Type
Response Message Body Entity: Enterprise Media Type
Request Example:
Click here to show or hide the request example
$ curl -X PUT http://10.60.20.60:80/api/admin/enterprises/2\
-H 'Accept: application/vnd.abiquo.enterprise+xml; version=2.4' \
-H 'Content-Type: application/vnd.abiquo.enterprise+xml; version=2.4' \
-d @entity.xml \
-u user:password --verbose
PUT http://10.60.20.60:80/api/admin/enterprises/2 HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.enterprise+xml;version=2.4
Content-Type: application/vnd.abiquo.enterprise+xml;version=2.4
Content-Length: 2720
HTTP/1.1 200 OK
Date: Wed, 16 Jan 2013 14:06:18 GMT
Set-Cookie: JSESSIONID=58FCEE41ED4082AB3B31124A9F991B6C; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0Njk3ODkzNjowM2EzM2E2ZTk3NWE4NmUxNDU1MzgxYzFjNWE2ZmU0MjpBQklRVU8; Expires=Wed, 16-Jan-2013 14:36:18 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.enterprise+xml;version=2.4
Content-Length: 2562
<?xml version="1.0" encoding="UTF-8"?>
<enterprise>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/appslib/templateDefinitionLists"
rel="appslib/templateDefinitionLists" type="application/vnd.abiquo.templatedefinitionlists+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/appslib/templateDefinitions"
rel="appslib/templateDefinitions" type="application/vnd.abiquo.templatedefinitions+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualdatacenters"
rel="cloud/virtualdatacenters" type="application/vnd.abiquo.virtualdatacenters+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/datacenterrepositories"
rel="datacenterrepositories" type="application/vnd.abiquo.datacenterrepositories+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2" rel="edit" type="application/vnd.abiquo.enterprise+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/externalnetworks"
rel="externalnetworks" type="application/vnd.abiquo.vlans+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/action/ips"
rel="ips" title="ips"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/limits"
rel="limits" type="application/vnd.abiquo.limits+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/properties"
rel="properties" type="application/vnd.abiquo.enterpriseproperties+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/reservedmachines"
rel="reservedmachines" type="application/vnd.abiquo.machines+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/users"
rel="users" type="application/vnd.abiquo.users+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualappliances"
rel="virtualappliances" type="application/vnd.abiquo.virtualappliances+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualmachines"
rel="virtualmachines" type="application/vnd.abiquo.virtualmachines+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/volumes"
rel="volumes" type="application/vnd.abiquo.iscsivolumes+xml"/>
<cpuHard>0</cpuHard>
<cpuSoft>0</cpuSoft>
<hdHard>0</hdHard>
<hdSoft>0</hdSoft>
<publicIpsHard>0</publicIpsHard>
<publicIpsSoft>0</publicIpsSoft>
<ramHard>0</ramHard>
<ramSoft>0</ramSoft>
<storageHard>0</storageHard>
<storageSoft>0</storageSoft>
<vlansHard>0</vlansHard>
<vlansSoft>0</vlansSoft>
<id>2</id>
<isReservationRestricted>false</isReservationRestricted>
<name>JC-b8e62569-389</name>
<repositoryHard>0</repositoryHard>
<repositorySoft>0</repositorySoft>
</enterprise>
Retrieve the list of private IPs
Retrieve the list of private IPs created by an enterprise.
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/ips
Roles Required: ROLE_VDC_ENUMERATE,ROLE_PHYS_DC_RETRIEVE_DETAILS
Request Headers: Accept:
application/vnd.abiquo.privateips+json; version=3.4; application/vnd.abiquo.privateips+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
startwith | false | 0 | first element to retrieve |
by | false | ip | ordering the request. |
has | false | | filter the request. With this parameter the response just contains the elements
which name matches the filter value. |
limit | false | 25 | number of elements to return |
asc | false | true | order ascendant or descendant. By default the sort mode is ascending. |
| | | |
Request Message Body Entity:
Response Message Body Entity: PrivateIps Media Type
Request Example:
Click here to show or hide the request example
$ curl -X GET "http://example.com/api/admin/enterprises/1/action/ips" -H "Accept:application/vnd.abiquo.privateips+xml" -u user:password | xmlindent -nbe -f
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 494 100 494 0 0 1468 0 --:--:-- --:--:-- --:--:-- 1474
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<privateips>
<link rel="first" href="http://example.com:80/api/admin/enterprises/1/action/ips?limit=25&by=ip"/>
<link rel="next" href="http://example.com:80/api/admin/enterprises/1/action/ips?startwith=25&limit=25&by=ip"/>
<link rel="last" href="http://example.com:80/api/admin/enterprises/1/action/ips?startwith=229&limit=25&by=ip"/>
<totalSize>254</totalSize>
<privateip>
<link title="default_private_network" rel="privatenetwork" type="application/vnd.abiquo.vlan+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/privatenetworks/2"/>
<link title="privateip" rel="self" type="application/vnd.abiquo.privateip+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/privatenetworks/2/ips/63"/>
<link title="vdc" rel="virtualdatacenter" type="application/vnd.abiquo.virtualdatacenter+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1"/>
<id>63</id>
<ip>192.168.0.1</ip>
<mac>00:50:56:15:a4:86</mac>
<name>00505615a486_host</name>
<networkName>default_private_network</networkName>
</privateip>
<privateip>
<link title="default_private_network" rel="privatenetwork" type="application/vnd.abiquo.vlan+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/privatenetworks/2"/>
<link title="privateip" rel="self" type="application/vnd.abiquo.privateip+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1/privatenetworks/2/ips/64"/>
<link title="vdc" rel="virtualdatacenter" type="application/vnd.abiquo.virtualdatacenter+xml" href="http://example.com:80/api/cloud/virtualdatacenters/1"/>
<id>64</id>
<ip>192.168.0.2</ip>
<mac>00:50:56:16:0c:40</mac>
<name>005056160c40_host</name>
<networkName>default_private_network</networkName>
</privateip>
<privateips>
Update an enterprise
Update an existing enterprise.
Synopsis: PUT http://example.com/api/admin/enterprises/{enterprise}
Roles Required: ROLE_USERS_MANAGE_ENTERPRISE,ROLE_PRICING_VIEW
Request Headers: Accept:
application/vnd.abiquo.enterprise+json; version=3.4; application/vnd.abiquo.enterprise+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity: Enterprise Media Type
Response Message Body Entity: Enterprise Media Type
Request Example:
Click here to show or hide the request example
$ curl -X PUT http://10.60.20.60:80/api/admin/enterprises/2\
-H 'Accept: application/vnd.abiquo.enterprise+xml; version=2.4' \
-H 'Content-Type: application/vnd.abiquo.enterprise+xml; version=2.4' \
-d @entity.xml \
-u user:password --verbose
PUT http://10.60.20.60:80/api/admin/enterprises/2 HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.enterprise+xml;version=2.4
Content-Type: application/vnd.abiquo.enterprise+xml;version=2.4
Content-Length: 2720
HTTP/1.1 200 OK
Date: Wed, 16 Jan 2013 14:06:18 GMT
Set-Cookie: JSESSIONID=58FCEE41ED4082AB3B31124A9F991B6C; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0Njk3ODkzNjowM2EzM2E2ZTk3NWE4NmUxNDU1MzgxYzFjNWE2ZmU0MjpBQklRVU8; Expires=Wed, 16-Jan-2013 14:36:18 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.enterprise+xml;version=2.4
Content-Length: 2562
<?xml version="1.0" encoding="UTF-8"?>
<enterprise>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/appslib/templateDefinitionLists"
rel="appslib/templateDefinitionLists" type="application/vnd.abiquo.templatedefinitionlists+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/appslib/templateDefinitions"
rel="appslib/templateDefinitions" type="application/vnd.abiquo.templatedefinitions+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualdatacenters"
rel="cloud/virtualdatacenters" type="application/vnd.abiquo.virtualdatacenters+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/datacenterrepositories"
rel="datacenterrepositories" type="application/vnd.abiquo.datacenterrepositories+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2" rel="edit" type="application/vnd.abiquo.enterprise+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/externalnetworks"
rel="externalnetworks" type="application/vnd.abiquo.vlans+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/action/ips"
rel="ips" title="ips"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/limits"
rel="limits" type="application/vnd.abiquo.limits+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/properties"
rel="properties" type="application/vnd.abiquo.enterpriseproperties+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/reservedmachines"
rel="reservedmachines" type="application/vnd.abiquo.machines+xml"/>
<link href="http://10.60.20.60:80/api/admin/enterprises/2/users"
rel="users" type="application/vnd.abiquo.users+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualappliances"
rel="virtualappliances" type="application/vnd.abiquo.virtualappliances+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/virtualmachines"
rel="virtualmachines" type="application/vnd.abiquo.virtualmachines+xml"/>
<link
href="http://10.60.20.60:80/api/admin/enterprises/2/action/volumes"
rel="volumes" type="application/vnd.abiquo.iscsivolumes+xml"/>
<cpuHard>0</cpuHard>
<cpuSoft>0</cpuSoft>
<hdHard>0</hdHard>
<hdSoft>0</hdSoft>
<publicIpsHard>0</publicIpsHard>
<publicIpsSoft>0</publicIpsSoft>
<ramHard>0</ramHard>
<ramSoft>0</ramSoft>
<storageHard>0</storageHard>
<storageSoft>0</storageSoft>
<vlansHard>0</vlansHard>
<vlansSoft>0</vlansSoft>
<id>2</id>
<isReservationRestricted>false</isReservationRestricted>
<name>JC-b8e62569-389</name>
<repositoryHard>0</repositoryHard>
<repositorySoft>0</repositorySoft>
</enterprise>
Retrieve list of volumes managed
Retrieve the list of volumes managed by this enterprise.
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/volumes
Roles Required: ROLE_VDC_ENUMERATE
Request Headers: Accept:
application/vnd.abiquo.volumes+json; version=3.4; application/vnd.abiquo.volumes+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
startwith | false | 0 | first element to retrieve |
by | false | id | parameter for ordering |
has | false | | name to filter the results |
limit | false | 25 | total number of elements in the result set |
asc | false | true | true/false ascending/descending order |
persistent | false | true | Include or not the persistent volumes in the result |
| | | |
Request Message Body Entity:
Response Message Body Entity: VolumesManagement Media Type
Request Example:
Click here to show or hide the request example
UPDATE EXAMPLE - This example uses iscsivolumes media type
$ curl -X GET "http://example.com/api/admin/enterprises/1/action/volumes" -H "Accept:application/vnd.abiquo.iscsivolumes+xml; version=2.0;" -u user:password | xmlindent -nbe -f
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 7894 100 7894 0 0 45740 0 --:--:-- --:--:-- --:--:-- 105k
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<volumes>
<link href="http://example.com:80/api/admin/enterprises/1/action/volumes" rel="first"/>
<link href="http://example.com:80/api/admin/enterprises/1/action/volumes?startwith=0" rel="last"/>
<totalSize>8</totalSize>
<volume>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/volumes/12664" type="application/vnd.abiquo.volume+xml" rel="edit"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/volumes/12664/action/initiatormappings" type="application/vnd.abiquo.initiatormappings+xml" rel="initiator mappings"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/tiers/1" type="application/vnd.abiquo.tier+xml" rel="tier" title="Nexenta"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/602" type="application/vnd.abiquo.virtualappliance+xml" rel="virtualappliance" title="NetApp Sysadmins"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1" type="application/vnd.abiquo.virtualdatacenter+xml" rel="virtualdatacenter" title="KVM"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/602/virtualmachines/1105" type="application/vnd.abiquo.virtualmachine+xml" rel="virtualmachine" title="ABQ_6c62a782-1281-4e9b-a5dd-8587693fd69b"/>
<id>12664</id>
<name>netapp7</name>
<state>ATTACHED</state>
<sizeInMB>15360</sizeInMB>
<idImage>329</idImage>
</volume>
<volume>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/volumes/14994" type="application/vnd.abiquo.volume+xml" rel="edit"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/volumes/14994/action/initiatormappings" type="application/vnd.abiquo.initiatormappings+xml" rel="initiator mappings"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/tiers/1" type="application/vnd.abiquo.tier+xml" rel="tier" title="Nexenta"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1" type="application/vnd.abiquo.virtualdatacenter+xml" rel="virtualdatacenter" title="KVM"/>
<id>14994</id>
<name>core</name>
<state>DETACHED</state>
<sizeInMB>102</sizeInMB>
</volume>
</volumes>
Retrieve the list of volumes managed with info on virtual machines
Retrieve the list of volumes managed by this enterprise with information on the virtual machines that the volumes are attached to.
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/volumes
Roles Required: ROLE_VDC_ENUMERATE
Request Headers: Accept:
application/vnd.abiquo.iscsivolumeswithvirtualmachine+json; version=3.4; application/vnd.abiquo.iscsivolumeswithvirtualmachine+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
startwith | false | 0 | first element to retrieve |
by | false | id | parameter for ordering
(availablesize, id, tier, totalsize, usedsize, virtualappliance, virtualdatacenter, virtualmachine) |
has | false | | name to filter the results |
limit | false | 25 | total number of elements in the result set |
asc | false | true | true/false ascending/descending order |
persistent | false | true | Include or not the persistent volumes in the result |
| | | |
Request Message Body Entity:
Response Message Body Entity: VolumesManagementWithVirtualMachine Media Type
Request Example:
Click here to show or hide the request example
For examples of ordering, see the pages under APIExamples.
$ curl -X GET "http://example.com/api/admin/enterprises/1/action/volumes" -H "Accept:application/vnd.abiquo.iscsivolumeswithvirtualmachine+xml; version=2.0;" -u user:password | xmlindent -nbe -f
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<volumes>
<link href="http://example.com:80/api/admin/enterprises/1/action/volumes" rel="first"/>
<link href="http://example.com:80/api/admin/enterprises/1/action/volumes?startwith=0" rel="last"/>
<totalSize>8</totalSize>
<volume>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/volumes/12664" type="application/vnd.abiquo.volume+xml" rel="edit"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/volumes/12664/action/initiatormappings" type="application/vnd.abiquo.initiatormappings+xml" rel="initiator mappings"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/tiers/1" type="application/vnd.abiquo.tier+xml" rel="tier" title="Nexenta"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/602" type="application/vnd.abiquo.virtualappliance+xml" rel="virtualappliance" title="NetApp Sysadmins"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1" type="application/vnd.abiquo.virtualdatacenter+xml" rel="virtualdatacenter" title="KVM"/>
<link href="http://example.com:80/api/cloud/virtualdatacenters/1/virtualappliances/602/virtualmachines/1105" type="application/vnd.abiquo.virtualmachine+xml" rel="virtualmachine" title="ABQ_6c62a782-1281-4e9b-a5dd-8587693fd69b"/>
<id>12664</id>
<name>netapp7</name>
<state>ATTACHED</state>
<sizeInMB>15360</sizeInMB>
<idImage>329</idImage>
<storagePoolWithDevice>
<availableSizeInMb>312111</availableSizeInMb>
<enabled>false</enabled>
<idStorage>decaa73a-c8c2-4c0d-bf17-26616c9b4d4b</idStorage>
<name>mothership</name>
<totalSizeInMb>475136</totalSizeInMb>
<usedSizeInMb>163025</usedSizeInMb>
<device>
<id>1</id>
<iscsiIp>10.60.20.31</iscsiIp>
<iscsiPort>3260</iscsiPort>
<managementIp>10.60.20.31</managementIp>
<managementPort>8080</managementPort>
<name>Mothership Nexenta</name>
<storageTechnology>NEXENTA</storageTechnology>
</device>
</storagePoolWithDevice>
<virtualAppliance>
<error>0</error>
<highDisponibility>0</highDisponibility>
<id>602</id>
<name>NetApp Sysadmins</name>
<nodeconnections><connections/></nodeconnections>
<publicApp>0</publicApp>
<state>DEPLOYED</state>
</virtualAppliance>
<virtualDatacenterWithDatacenter>
<cpuHard>0</cpuHard>
<cpuSoft>0</cpuSoft>
<hdHard>0</hdHard>
<hdSoft>0</hdSoft>
<publicIpsHard>0</publicIpsHard>
<publicIpsSoft>0</publicIpsSoft>
<ramHard>0</ramHard>
<ramSoft>0</ramSoft>
<storageHard>0</storageHard>
<storageSoft>0</storageSoft>
<vlansHard>0</vlansHard>
<vlansSoft>0</vlansSoft>
<hypervisorType>KVM</hypervisorType>
<id>1</id>
<name>KVM</name>
<datacenter>
<id>1</id>
<location>Barcelona</location>
<name>Abiquo BCN</name>
</datacenter>
</virtualDatacenterWithDatacenter>
<virtualMachine>
<link href="http://example.com:80/api/admin/datacenters/1/racks/1/machines/24" type="application/vnd.abiquo.machine+xml" rel="machine" title="KVM"/>
<link href="http://example.com:80/api/admin/enterprises/1" type="application/vnd.abiquo.enterprise+xml" rel="enterprise"/>
<link href="http://example.com:80/api/admin/enterprises/1/users/7" type="application/vnd.abiquo.user+xml" rel="user"/>
<link href="http://example.com:80/api/admin/enterprises/1/datacenterrepositories/1/virtualmachinetemplates/329" type="application/vnd.abiquo.virtualmachinetemplate+xml" rel="virtualmachinetemplate"/>
<cpu>1</cpu>
<description>netapp7.qcow2</description>
<hdInBytes>0</hdInBytes>
<highDisponibility>0</highDisponibility>
<id>1105</id>
<idState>4</idState>
<idType>1</idType>
<name>ABQ_6c62a782-1281-4e9b-a5dd-8587693fd69b</name>
<ram>1024</ram>
<state>ON</state>
<vdrpIP>10.60.20.17</vdrpIP>
<vdrpPort>5904</vdrpPort>
</virtualMachine>
</volume>
</volumes>
Retrieve the list of all available Chef elements
Retrieve the list of all Chef elements available to an enterprise request.
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/chefelements
Roles Required:
Request Headers: Accept:
application/vnd.abiquo.extended-runlists+json; version=3.4; application/vnd.abiquo.extended-runlists+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity:
Response Message Body Entity: RunlistElements Media Type
Request Example:
Click here to show or hide the request example
UPDATE EXAMPLE
$ curl -X GET "http://example.com/api/admin/enterprises/1/action/chefelements" -H "Accept:application/vnd.abiquo.extended-runlists+xml; version=2.0;" -u user:password | xmlindent -nbe -f
Retrieve the list of external networks assigned to an enterprise
Retrieve the list of external networks assigned to an enterprise.
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/externalnetworks
Roles Required: ROLE_ENTERPRISE_ENUMERATE, ROLE_VDC_ENUMERATE
Request Headers: Accept:
application/vnd.abiquo.vlans+json; version=3.4; application/vnd.abiquo.vlans+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity:
Response Message Body Entity: VLANNetworks Media Type
Request Example:
Click here to show or hide the request example
curl -X GET "http://example.com/api/admin/enterprises/1/action/externalnetworks" -H "Accept:application/vnd.abiquo.vlans+xml; version=2.0;" -u user:password | xmlindent -nbe -f
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 646 100 646 0 0 7956 0 --:--:-- --:--:-- --:--:-- 14355
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<networks>
<network>
<link href="http://example.com:80/api/admin/enterprises/1" type="application/vnd.abiquo.enterprise+xml" rel="enterprise"/>
<link href="http://example.com:80/api/admin/enterprises/1/action/externalnetworks/47" type="application/vnd.abiquo.vlan+xml" rel="externalnetwork"/>
<address>10.60.10.0</address>
<dhcpOptions/>
<gateway>10.60.10.1</gateway>
<id>47</id>
<mask>24</mask>
<name>External Systems</name>
<primaryDNS>10.60.10.1</primaryDNS>
<secondaryDNS>8.8.8.8</secondaryDNS>
<sufixDNS></sufixDNS>
<tag>30</tag>
<type>EXTERNAL</type>
</network>
</networks>
Retrieve external VLAN
Retrieve an external VLAN.
Synopsis: GET http://example.com/api/admin/enterprises/{enterprise}/action/externalnetworks/{externalnetwork}
Roles Required: ROLE_ENTERPRISE_ENUMERATE, ROLE_VDC_ENUMERATE
Request Headers: Accept:
application/vnd.abiquo.vlan+json; version=3.4; application/vnd.abiquo.vlan+xml; version=3.4; Content-type: ;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
| | | |
Request Message Body Entity:
Response Message Body Entity: VLANNetwork Media Type
Request Example:
Click here to show or hide the request example
$ curl -X GET "http://example.com/api/admin/enterprises/1/action/externalnetworks/47" -H "Accept:application/vnd.abiquo.vlan+xml; version=2.0;" -u user:password | xmlindent -nbe -f
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 625 100 625 0 0 30040 0 --:--:-- --:--:-- --:--:-- 34722
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<network>
<link href="http://example.com:80/api/admin/enterprises/1" type="application/vnd.abiquo.enterprise+xml" rel="enterprise"/>
<link href="http://example.com:80/api/admin/enterprises/1/action/externalnetworks/47" type="application/vnd.abiquo.vlan+xml" rel="externalnetwork"/>
<address>10.60.10.0</address>
<dhcpOptions/>
<gateway>10.60.10.1</gateway>
<id>47</id>
<mask>24</mask>
<name>External Systems</name>
<primaryDNS>10.60.10.1</primaryDNS>
<secondaryDNS>8.8.8.8</secondaryDNS>
<sufixDNS></sufixDNS>
<tag>30</tag>
<type>EXTERNAL</type>
</network>
This resource retrieves all tasks that are in state QUEUEING. This means that workflow integration is enabled and that Abiquo is still waiting for the workflow tool to get back and either start or cancel the task.
This resource is meant as a fallback in case something went wrong with the workflow tool and the tasks must be started or canceled manually.
Synopsis: GET http://example.com/api/admin/enterprises/{idEnterprise}/action/pendingtasks
Roles Required: ROLE_USERS_MANAGE_USERS
Request Headers: Accept:
application/vnd.abiquo.tasks+json; version=3.4; application/vnd.abiquo.tasks+xml; version=3.4;
Request Parameters:
Parameter | Required | Default Value | Description |
|---|
startwith | false | 0 | first element to retrieve |
has | false | | name to filter the results |
limit | false | 25 | total number of elements in the result set |
Request Message Body Entity:
Response Message Body Entity: Tasks Media Type
Request Example:
Click here to expand...
$ curl --verbose -X GET -u user:password http://example.com/api/admin/enterprises/1/action/pendingtasks
* Server auth using Basic with user 'user'
> GET /api/admin/enterprises/1/action/pendingtasks HTTP/1.1
> Authorization: Basic YWRtaW46eGFiaXF1bw==
> User-Agent: curl/7.22.0 (x86_64-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.4 libidn/1.23 librtmp/2.3
> Host: localhost
> Accept: */*
>
< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Set-Cookie: auth=YWRtaW46MTM3MDk0OTc0OTIxMDpkNzRhZGFiYjg3OGFmZWIxYzljOGRmYjQ1MWJjY2VhZTpBQklRVU8; Expires=Tue, 11-Jun-2013 11:22:29 GMT; Path=/api
< Set-Cookie: JSESSIONID=E8AB7383FC1D4690A694B4412D7E5C47.node1; Path=/api/; HttpOnly
< Content-Type: application/vnd.abiquo.tasks+xml; version=2.6
< Content-Length: 4804
< Date: Tue, 11 Jun 2013 10:52:29 GMT
<
{ [data not shown]
100 4804 100 4804 0 0 172k 0 --:--:-- --:--:-- --:--:-- 180k
* Connection #0 to host localhost left intact
* Closing connection #0
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<tasks>
<link rel="self" href="http://example.com:80/api/admin/enterprises/1/action/pendingtasks"/>
<link rel="parent" href="http://example.com:80/api/admin/enterprises/1"/>
<totalSize>2</totalSize>
<task>
<link rel="self" href="http://example.com:80/api/cloud/virtualdatacenters/12/virtualappliances/13/virtualmachines/32/tasks/916abaa0-aaa2-41fd-bafe-75648b06a657"/>
<link rel="parent" href="http://example.com:80/api/cloud/virtualdatacenters/12/virtualappliances/13/virtualmachines/32"/>
<link rel="cancel" href="http://example.com:80/api/cloud/virtualdatacenters/12/virtualappliances/13/virtualmachines/32/tasks/916abaa0-aaa2-41fd-bafe-75648b06a657/action/cancel"/>
<link rel="continue" href="http://example.com:80/api/cloud/virtualdatacenters/12/virtualappliances/13/virtualmachines/32/tasks/916abaa0-aaa2-41fd-bafe-75648b06a657/action/continue"/>
<link rel="target" href="http://example.com:80/api/cloud/virtualdatacenters/12/virtualappliances/13/virtualmachines/32"/>
<link rel="user" href="http://example.com:80/api/admin/enterprises/1/users/1"/>
<taskId>916abaa0-aaa2-41fd-bafe-75648b06a657</taskId>
<userId>1</userId>
<type>DEPLOY</type>
<ownerId>32</ownerId>
<state>QUEUEING</state>
<creationTimestamp>1370947062</creationTimestamp>
<timestamp>1370947062</timestamp>
<jobs>
<job>
<id>916abaa0-aaa2-41fd-bafe-75648b06a657.90a827f9-4ab4-4c52-a369-33798195547c</id>
<parentTaskId>916abaa0-aaa2-41fd-bafe-75648b06a657</parentTaskId>
<type>SCHEDULE</type>
<description>Deploy task's schedule on virtual machine with id 32</description>
<state>PENDING</state>
<rollbackState>UNKNOWN</rollbackState>
<creationTimestamp>1370947062</creationTimestamp>
<timestamp>1370947062</timestamp>
</job>
<job>
<id>916abaa0-aaa2-41fd-bafe-75648b06a657.ae0bff40-7a29-4f74-8a0e-a5d9f91240a6</id>
<parentTaskId>916abaa0-aaa2-41fd-bafe-75648b06a657</parentTaskId>
<type>CONFIGURE</type>
<description>Deploy task's configure on virtual machine with id 32</description>
<state>PENDING</state>
<rollbackState>UNKNOWN</rollbackState>
<creationTimestamp>1370947062</creationTimestamp>
<timestamp>1370947062</timestamp>
</job>
<job>
<id>916abaa0-aaa2-41fd-bafe-75648b06a657.3b7a553c-7664-4eb1-8f53-193a98724bee</id>
<parentTaskId>916abaa0-aaa2-41fd-bafe-75648b06a657</parentTaskId>
<type>POWER_ON</type>
<description>Deploy task's power on on virtual machine with id 32</description>
<state>PENDING</state>
<rollbackState>UNKNOWN</rollbackState>
<creationTimestamp>1370947062</creationTimestamp>
<timestamp>1370947062</timestamp>
</job>
</jobs>
</task>
<task>
<link rel="self" href="http://example.com:80/api/cloud/virtualdatacenters/12/virtualappliances/13/virtualmachines/31/tasks/97417000-169e-4729-8ddd-0e56328106ba"/>
<link rel="parent" href="http://example.com:80/api/cloud/virtualdatacenters/12/virtualappliances/13/virtualmachines/31"/>
<link rel="cancel" href="http://example.com:80/api/cloud/virtualdatacenters/12/virtualappliances/13/virtualmachines/31/tasks/97417000-169e-4729-8ddd-0e56328106ba/action/cancel"/>
<link rel="continue" href="http://example.com:80/api/cloud/virtualdatacenters/12/virtualappliances/13/virtualmachines/31/tasks/97417000-169e-4729-8ddd-0e56328106ba/action/continue"/>
<link rel="target" href="http://example.com:80/api/cloud/virtualdatacenters/12/virtualappliances/13/virtualmachines/31"/>
<link rel="user" href="http://example.com:80/api/admin/enterprises/1/users/1"/>
<taskId>97417000-169e-4729-8ddd-0e56328106ba</taskId>
<userId>1</userId>
<type>DEPLOY</type>
<ownerId>31</ownerId>
<state>QUEUEING</state>
<creationTimestamp>1370947062</creationTimestamp>
<timestamp>1370947062</timestamp>
<jobs>
<job>
<id>97417000-169e-4729-8ddd-0e56328106ba.6c34bc1b-fc79-4cbc-9434-b791802d01da</id>
<parentTaskId>97417000-169e-4729-8ddd-0e56328106ba</parentTaskId>
<type>SCHEDULE</type>
<description>Deploy task's schedule on virtual machine with id 31</description>
<state>PENDING</state>
<rollbackState>UNKNOWN</rollbackState>
<creationTimestamp>1370947062</creationTimestamp>
<timestamp>1370947062</timestamp>
</job>
<job>
<id>97417000-169e-4729-8ddd-0e56328106ba.a18bd5d2-77aa-4f38-90cf-12252196efe6</id>
<parentTaskId>97417000-169e-4729-8ddd-0e56328106ba</parentTaskId>
<type>CONFIGURE</type>
<description>Deploy task's configure on virtual machine with id 31</description>
<state>PENDING</state>
<rollbackState>UNKNOWN</rollbackState>
<creationTimestamp>1370947062</creationTimestamp>
<timestamp>1370947062</timestamp>
</job>
<job>
<id>97417000-169e-4729-8ddd-0e56328106ba.254f42ae-268b-409a-a035-8ae4269571c7</id>
<parentTaskId>97417000-169e-4729-8ddd-0e56328106ba</parentTaskId>
<type>POWER_ON</type>
<description>Deploy task's power on on virtual machine with id 31</description>
<state>PENDING</state>
<rollbackState>UNKNOWN</rollbackState>
<creationTimestamp>1370947062</creationTimestamp>
<timestamp>1370947062</timestamp>
</job>
</jobs>
</task>
</tasks>
