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.


Documentation

Skip to end of metadata
Go to start of metadata

Appliance Library Entities

AppsLibrary Media Type

This class is identified by media type:  application/vnd.abiquo.appslibrary+json; version=3.10; application/vnd.abiquo.appslibrary+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the entity

idAppsLibrary

Integer

1

yes

Identifier of the Apps Library

 

Category Media Type

This class is identified by media type:  application/vnd.abiquo.category+json; version=3.10; application/vnd.abiquo.category+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

defaultCategory

boolean

1

yes

true if the category is default

erasable

boolean

1

yes

true if the category is erasable

id

Integer

1

optional

Identifier of the entity

name

String

1

yes

Name of the category

 

Categories Media Type

This class is identified by media type:  application/vnd.abiquo.categories+json; version=3.10; application/vnd.abiquo.categories+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of Category Media Type

1..n

optional

The collection of List of Category Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

Conversion Media Type

This class is identified by media type:  application/vnd.abiquo.conversion+json; version=3.10; application/vnd.abiquo.conversion+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

sourceFormat

DiskFormatType

1

yes

DiskFormatType of the template disk file in ''sourcePath''

sourcePath

String

1

yes

Path relative to the Abiquo repository of the template disk file used as source of the
conversion

startTimestamp

Date

1

yes

When the conversion starts

state

ConversionState

1

yes

Result status of the conversion

targetFormat

DiskFormatType

1

yes

DiskFormatType of the template disk file in ''targetPath''

targetPath

String

1

yes

Path relative to the Abiquo repository of resulting template disk file

targetSizeInBytes

Long

1

yes

Size of the template disk file result in ''targetPath''

 

Conversions Media Type

This class is identified by media type:  application/vnd.abiquo.conversions+json; version=3.10; application/vnd.abiquo.conversions+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Conversion Media Type

1..n

no

The collection of List of Conversion Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

DatacenterRepository Media Type

This class is identified by media type:  application/vnd.abiquo.datacenterrepository+json; version=3.10; application/vnd.abiquo.datacenterrepository+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

error

String

1

optional

Any error in repository

lastTaskTask1noThe task to track the last repository refresh

name

String

1

yes

Name of the datacenter repository

repositoryCapacityMb

long

1

optional

Capacity of repository in MB

repositoryLocation

String

1

yes

The repository location

repositoryRemainingMb

long

1

optional

Remaining capacity of the repository in MB

 

DatacenterRepositories Media Type

This class is identified by media type:  application/vnd.abiquo.datacenterrepositories+json; version=3.10; application/vnd.abiquo.datacenterrepositories+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of DatacenterRepository Media Type

1..n

optional

The collection of List of DatacenterRepository Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

Disk Media Type

For disks that are part of a virtualmachinetemplate.

This class is identified by media type:  application/vnd.abiquo.disk+json; version=3.10; application/vnd.abiquo.disk+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

label

String

1

optional

Friendly name

sequence

Integer

1

yes

Boot order

path

String

1

yes

Path relative to the Abiquo datacenter repository of the virtual machine template disk file. Null for empty disks

diskFormatType

String

1

yes

Disk format type of the virtual machine template see DiskFormatType Media Type

diskFileSize

Long

1

yes

The disk file size in Bytes of the virtual machine template disk file

hdRequiredLong1optional

Capacity. The HD required in bytes for the disk

state

VMTemplateState

1

no

Current state of the virtual machine template (based on the tasks)

diskControllerType

DiskControllerType

1

optional

Kind of controller type (IDE or SCSI) and on KVM (IDE, SCSI or VIRTIO)

NOTE not all the hypervisor plugins will use this info

diskController

String

1

optional

Controller implementation to use in disks.

creationDate

Date

1

optional

The date when the disk was created

bootableBoolean1yesSpecify if the disk is suitable to boot (it's possible to define it as virtualmachine with sequence 0 - (disk0 link))

 

Disks Media Type

This class is identified by media type:  application/vnd.abiquo.disks+json; version=3.10; application/vnd.abiquo.disks+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of Disk Media Type

1..n

optional

The collection of List of Disk Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

DiskControllerType Media Type

This class is identified by media type: application/vnd.abiquo.diskcontrollertype+json; version=3.10; application/vnd.abiquo.diskcontrollertype+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Identifies the disk controller type. Kind of disk controller (IDE or SCSI) and on KVM (IDE or SCSI or VIRTIO)
NOTE not all the hypervisor plugins will use this info

 

DiskControllerTypes Media Type

This class is identified by media type:  application/vnd.abiquo.diskcontrollertypes+json; version=3.10; application/vnd.abiquo.diskcontrollertypes+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of DiskControllerType

1..n

optional

A collection that is a List of DiskControllerType elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

DiskFormatType Media Type

This class is identified by media type:  application/vnd.abiquo.diskformattype+json; version=3.10; application/vnd.abiquo.diskformattype+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

description

String

1

optional

Description of the type

uri

String

1

optional

URI of the Disk Format type

 

DiskFormatTypes Media Type

This class is identified by media type:  application/vnd.abiquo.diskformattypes+json; version=3.10; application/vnd.abiquo.diskformattypes+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of DiskFormatType Media Type

1..n

optional

The collection of List of DiskFormatType Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

DiskRequest Media Type

This class is identified by media type:  application/vnd.abiquo.diskrequest+json; version=3.10; application/vnd.abiquo.diskrequest+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

label

String

1

optional

Friendly name

sequence

Integer

1

yes

Boot order

path

String

1

yes

Path relative to the Abiquo datacenter repository of the virtual machine template disk file. Null for empty disks

diskFormatType

String

1

yes

Disk format type of the virtual machine template see DiskFormatType Media Type

diskFileSize

Long

1

yes

The disk file size in Bytes of the virtual machine template disk file

hdRequiredLong1optional

Capacity. The HD required in bytes for the disk

state

VMTemplateState

1

no

Current state of the virtual machine template (based on the tasks)

diskControllerType

DiskControllerType

1

optional

Kind of controller type (IDE or SCSI) and on KVM (IDE, SCSI or VIRTIO)

NOTE not all the hypervisor plugins will use this info

diskController

String

1

optional

Controller implementation to use in disks.

creationDate

Date

1

optional

The date when the disk was created

bootableboolean1yesSpecify if the disk is suitable to boot (it's possible to define it as virtualmachine with sequence 0 - (disk0 link))
newSequenceInteger1yessequence position where the disk should be copied to

 

EthernetDriverType Media Type

This class is identified by media type: application/vnd.abiquo.ethernetdrivertype+json; version=3.10; application/vnd.abiquo.ethernetdrivertype+xml; version=3.10;  

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Identifies the Ethernet driver type. For example, E1000, NOTE not all the hypervisor plugins will use this info. Possible values: PCNET32, VMXNET3, E1000, VIRTIO

 

EthernetDriverTypes Media Type

This class is identified by media type:  application/vnd.abiquo.ethernetdrivertypes+json; version=3.10; application/vnd.abiquo.ethernetdrivertypes+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of EthernetDriverType

1..n

optional

A collection that is a List of EthernetDriverType elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

OSType Media Type

This class is identified by media type:  application/vnd.abiquo.OStype+json; version=3.10; application/vnd.abiquo.OStype.xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Identifies the operating system type

description

String

1

optional

Friendly description of the operating system

is64b

Boolean

1

optional

Specify if the operating system is x86 or x64

 

OSTypes Media Type

This class is identified by media type:  application/vnd.abiquo.ostypes+json; version=3.10; application/vnd.abiquo.ostypes+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of OSType

1..n

optional

A collection that is a List of OSType elements

totalSize

Integer

1

optional

Number of elements in the 'collection'

 

TemplateDefinition Media Type

This class is identified by media type:    application/vnd.abiquo.templatedefinition+json; version=3.10;   application/vnd.abiquo.templatedefinition+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

description

String

1

yes

Description of the template definition

ethernetDriverType

EthernetDriverType

1

optional

Kind of network driver (PCNet32, VMXNET3 or E1000) and from Abiquo 3.2.1 on KVM (VIRTIO)

NOTE not all the hypervisor plugins will use this info. By default all use E1000

iconUrl

String

1

optional

The URI of the icon of the template definition

id

Integer

1

yes

Identifier of the template definition

loginPassword

String

1

optional

Default login password

loginUser

String

1

optional

Default login user

name

String

1

yes

Name of the template definition

osType

OSType

1

optional

Kind of Operating System

osVersion

String

1

optional

Additional info for the ''osType''

productName

String

1

optional

Additional info about the installed software

productUrl

String

1

optional

Link to additional info about the installed software

productVendor

String

1

optional

Additional info about the installed software

productVersion

String

1

optional

Additional version info about the installed software

url

String

1

yes

URL of the source .ovf Envelope document.

 

TemplateDefinitions Media Type

This class is identified by media type:  application/vnd.abiquo.templatedefinitions+json; version=3.10; application/vnd.abiquo.templatedefinitions+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of TemplateDefinition Media Type

1..n

no

The collection of List of TemplateDefinition Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

TemplateDefinitionDisk Media Type

This class is identified by media type:    application/vnd.abiquo.templatedefinitiondisk+json; version=3.10;   application/vnd.abiquo.templatedefinitiondisk+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

diskFormatType

String

1

yes

Disk format type of the disk file see DiskFormatType Media Type

diskFileSize

long

1

yes

The disk file size in MegaBytes of the disk file

hdRequired

long

1

yes

Capacity. The HD required in bytes

diskControllerType

DiskControllerType

1

optional

Kind of disk controller (IDE or SCSI) and on KVM (IDE or SCSI or VIRTIO)
NOTE not all the hypervisor plugins will use this info

diskController

string

1

optional

Disk controller implementation to use, for example, Lsilogic

labelString1optionalFriendly name for the disk controller

 

TemplateDefinitionDisks Media Type

This class is identified by media type:   application/vnd.abiquo.templatedefinitiondisks+json; version=3.10; application/vnd.abiquo.templatedefinitiondisks+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of TemplateDefinitionDisk

1..n

optional

A collection that is a List of TemplateDefinitionDisk elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

TemplateDefinitionList Media Type

This class is identified by media type:   application/vnd.abiquo.templatedefinitionlist+json; version=3.10; application/vnd.abiquo.templatedefinitionlist+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

yes

Identifier of the template definition list

name

String

1

yes

Name of the template definition list

templateDefinitions

TemplateDefinitions Media Type

1

optional

The template definitions of the list

url

String

1

optional

The URL of the template definition list public ''ovfindex.xml'' source.

When this attribute is present the its possible to request a template definition list refresh
(fetch the OVFs again)

 

TemplateDefinitionLists Media Type

This class is identified by media type:  application/vnd.abiquo.templatedefinitionlists+json; version=3.10; application/vnd.abiquo.templatedefinitionlists+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of TemplateDefinitionList Media Type

1..n

no

The collection of List of TemplateDefinitionList Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

TemplateState Media Type

This class is identified by media type:   application/vnd.abiquo.templatestate+json; version=3.10; application/vnd.abiquo.templatestatet+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

ovfId

String

1

no

Identifier of the template OVF

status

TemplateStatusEnumType

1

no

Status of the template:

  • NOT_DOWNLOAD - not found in the enterprise repository
  • DOWNLOADING - currently being created
  • DOWNLOAD - OVF package is installed in the current enterprise repository
  • ERROR - error during template creation
downloadingProgressString1noIf template is downloading, provide indication of progress
errorCauseString1noIf an error has occurred, provide an errorCause

 

VirtualMachineTemplate Media Type

This class is identified by media type:  application/vnd.abiquo.virtualmachinetemplate+json; version=3.10; application/vnd.abiquo.virtualmachinetemplate+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

chefEnabled

boolean

1

optional

Determine if its suitable for the Chef integration feature

costCode

Integer

1

optional

Cost code identifier

cpuMaxInteger1optionalMaximim CPU allowed to be allocated to a virtual machine created from this template
cpuMinInteger1optionalMinimum CPU allowed to be allocated to a virtual machine created from this template

cpuRequired

Integer

1

yes

The number of CPU required

coresPerSocket

Integer

1

optional

Optional ratio to distribute cores in sockets (sockets = cpu / coresPerSocket).
This attribute MUST be divisor of cpu.

creationDate

Date

1

no

Creation date

creationUser

String

1

no

Nickname of the creation user

description

String

1

optional

Description of the virtual machine template

enableCpuHotAdd

boolean

1

optional

Supported hypervisors only on supported guest OS, enable CPU hot-add
Abiquo 3.10: for changes directly in the hypervisor
Abiquo 3.10.1+: for changes in Abiquo 

enableRamHotAdd

boolean

1

optional

Supported hypervisors only on supported guest OS, enable RAM hot-add
Abiquo 3.10: for changes directly in the hypervisor
Abiquo 3.10.1+: for changes in Abiquo

enableDisksHotReconfigure

boolean

1

optional

3.10.1+ on supported hypervisors only on supported guest OS, enable hot reconfigure to add or remove SCSI disks in Abiquo. To reorder disks in the boot sequence, power off the virtual machine.

enableNicsHotReconfigure

boolean

1

optional

3.10.1+ on supported hypervisors only on supported guest OS, enable hot reconfigure of NICs for changes in Abiquo

enableRemoteAccessHotReconfigure

boolean

1

optional

3.10.1+ on supported hypervisors only on supported guest OS, enable hot reconfigure to enable or disable remote access in Abiquo, which resets remote access password

ethernetDriverType

EthernetDriverType

1

optional

Kind of network driver (PCNet32, VMXNET3 or E1000)

NOTE not all the hypervisor plugins will use this info. By default all use E1000

iconUrl

String

1

optional

The URI of the icon of the virtual machine template

id

Integer

1

yes

Identifier of the virtual machine template

loginPassword

String

1

optional

Default login password

loginUser

String

1

optional

Default login user

name

String

1

yes

Name of the virtual machine template

osType

OSType

1

optional

Kind of Operating System

osVersion

String

1

optional

Additional info for the ''osType''

ramMaxInteger1optionalMaximum RAM allowed to be allocated to a virtual machine created from the virtual machine template in megabytes
ramMinInteger1optionalMinimum RAM allowed to be allocated to a virtual machine created from the virtual machine template in megabytes

ramRequired

Integer

1

yes

The RAM in MegaBytes required for the virtual machine template

shared

boolean

1

yes

Determine if virtual machine template can be used in other enterprises

state

VMTemplateState

1

no

Current state of the virtual machine template (based on the tasks)

    • UNAVAILABLE, the template disk is missing the the repository filesystem, but some virtual machines or instances are using it.

    • IN_PROGRESS, a download or promote task is running

    • FAILED, a download or promote task was finish unsuccessfully

    • DONE the template is available and ready to use

variables

HashMap of String

1

optional

Key and value pairs of variable name and value

 

Links include:

  • disk

  • templatePath (upload endpoint)

  • virtualdatacenter (for persistent disks)

 

VirtualMachineTemplates Media Type

This class is identified by media type:  application/vnd.abiquo.virtualmachinetemplates+json; version=3.10; application/vnd.abiquo.virtualmachinetemplates+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualMachineTemplate Media Type

1..n

no

The collection of List of VirtualMachineTemplate Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VirtualMachineTemplatePersistent Media Type

This class is identified by media type: application/vnd.abiquo.virtualmachinetemplatepersistent+json; version=3.10; application/vnd.abiquo.virtualmachinetemplatepersistent+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

persistentTemplateName

String

1

yes

Name for the new persistent virtual machine template

persistentVolumeName

String

1

optional

Name of the new volume to hold the persistent virtual machine template

if is null will be used the value of persistentTemplateName and if the storage link is a
volume link will be omitted

 

VirtualMachineTemplateRequest Media Type

This class is identified by media type:  application/vnd.abiquo.virtualmachinetemplaterequest+json; version=3.10; application/vnd.abiquo.virtualmachinetemplaterequest+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

promotedName

String

1

optional

Name for the new promoted virtual machine template

Only required for PROMOTE Task : Virtual machine template instance link present

 

Base Entities

AcceptedRequest Media Type

This class is identified by media type:  application/vnd.abiquo.acceptedrequest+json; version=3.10; application/vnd.abiquo.acceptedrequest+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

entity

Object

1

optional

The returning entity. Normally a message.

statusLink

RESTLink

1

optional

The status link where you can track the status of the request.

 

Error Media Type

This class is identified by media type:  application/vnd.abiquo.error+json; version=3.10; application/vnd.abiquo.error+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

code

String

1

optional

 

message

String

1

optional

 

 

Errors Media Type

This class is identified by media type:  application/vnd.abiquo.errors+json; version=3.10; application/vnd.abiquo.errors+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Error Media Type

1..n

optional

The collection of List of Error Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

LimitExceededError Media Type

This class is identified by media type:  application/vnd.abiquo.limiterror+json; version=3.10; application/vnd.abiquo.limiterror+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

code

String

1

optional

 

message

String

1

optional

 
entityIdInteger1noID of the entity with the limit error
entityNameString1noName of the entity with the limit error
entityTypeString1noType of the entity with the limit error. Possible values: ENTERPRISE, VIRTUALDATACENTER, DATACENTERLIMITS
hardLimitboolean1notrue if the limit error is for a hard limit
cpuLimitStatus1noStatus of the CPU limit
ramLimitStatus1noStatus of the RAM limit
hdLimitStatus1noStatus of the local datastore and hard disk limit
storageLimitStatus1noStatus of the external storage limit
vlanLimitStatus1noStatus of the VLAN limit
ipLimitStatus1noStatus of the public IP limit
repositoryLimitStatus1noStatus of the repository limit

 

LimitStatus for resources with limits

AttributeTypeOccursInput RequiredDescription
actuallong1noThe current amount of the resource
requiredlong1noThe required amount of the resource
softlong1noThe soft limit of the resource
hardlong1noThe hard limit of the resource
statusString1noStatus that describes the limit error level. Possible values: OK, SOFT, HARD



Link Media Type

This class is identified by media type:  application/vnd.abiquo.link+json; version=3.10; application/vnd.abiquo.link+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

link

RESTLink

1

yes

Required Attributes are rel, href. Optional Attributes are title and type

 

Links Media Type

This class is identified by media type:  application/vnd.abiquo.links+json; version=3.10; application/vnd.abiquo.links+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Link Media Type

1..n

no

The collection of List of Link Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

Metadata Media Type

This class is identified by media type:  application/vnd.abiquo.virtualmachinemetadata+json; version=3.10; application/vnd.abiquo.virtualmachinemetadata+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

metadata

String

1

yes

The virtual machine metadata in JSON or XML format

 

Cloud Backup Entities

OnDemandBackup Media Type

This class is identified by media type:  application/vnd.abiquo.ondemandbackup+json; version=3.10; application/vnd.abiquo.ondemandbackup+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

replication

boolean

1

yes

Whether to use the replication option or not

 

Cloud Virtual Appliance Entities  

Layer Media Type

This class is identified by media type:  application/vnd.abiquo.layer+json; version=3.10; application/vnd.abiquo.layer+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the layer

 

Layers Media Type

This class is identified by media type:  application/vnd.abiquo.layers+json; version=3.10; application/vnd.abiquo.layers+xml; version=3.10;   

Attribute

Type

Occurs

Input Required

Description

collection

List of Layer Media Type

1..n

optional

The collection of List of Layer Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VirtualAppliance Media Type

This class is identified by media type:  application/vnd.abiquo.virtualappliance+json; version=3.10; application/vnd.abiquo.virtualappliance+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

error

Integer

1

no

Was there an error on the last operation on any of its nodes?.

highDisponibility

Integer

1

optional

Deprecated.

id

Integer

1

no

Opaque ID of the virtual appliance.

lastTasks

Tasks Media Type

1

no

Last task of every virtual machine.

name

String

1

yes

Name of the virtual appliance.

nodeconnections

String

1

optional

Deprecated

publicApp

Integer

1

optional

Deprecated

state

VirtualApplianceState

1

no

Current state. Inferred from its virtual machines

subState

VirtualApplianceState

1

optional

Deprecated.

 

VirtualAppliances Media Type

This class is identified by media type:  application/vnd.abiquo.virtualappliances+json; version=3.10; application/vnd.abiquo.virtualappliances+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualAppliance Media Type

1..n

no

The collection of List of VirtualAppliance Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VirtualApplianceAlert Media Type

This class is identified by mediatype: application/vnd.abiquo.alert+json; version=3.10; application/vnd.abiquo.alert+xml; version=3.10; 

The alert is identified by a UUID that occurs in the edit link to the object, for example, https://abiquo.example.com/api/cloud/virtualdatacenters/102/virtualappliances/307/alerts/1627ed37-b141-4242-a390-f784bdcf101c

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

The name of the alert

description

String

1

yes

The description of the alert

muted

boolean

1

yes

Indicates if the alert must be ignored or not

active

boolean

1

no

True if all the alarms in the alert are activated until the alarms are reevaluated and any of the alarms is not active and the alert is deactivated

stateUpdateTimestamp

Timestamp

1

no

Timestamp of the date and time when the state of the alert was last changed

alarms

list of Alarm

1..n

yes

The collection of alarm links

subscribers

list of Subscriber

1..n

yes

The list of Subscribers that are emails to which notifications must be sent

 

VirtualApplianceAlerts Media Type

This class is identified by media type:  application/vnd.abiquo.virtualappliancealerts+json; version=3.10; application/vnd.abiquo.virtualappliancealerts+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualApplianceAlert Media Type

1..n

no

The collection of List of VirtualApplianceAlert Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VirtualAppliancePrice Media Type

This class is identified by media type:  application/vnd.abiquo.virtualapplianceprice+json; version=3.10; application/vnd.abiquo.virtualapplianceprice+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

additionalVolumCost

BigDecimal

1

yes

Value for the volume.

antiaffinityCost

BigDecimal

1

yes

Value for antiaffinity.

computeCost

BigDecimal

1

yes

Value for the CPU, memory.

costCodeCost

BigDecimal

1

yes

Value for the image being deployed.

minimumCharge

Integer

1

yes

Minimum Charge.

minimumChargePeriod

BigDecimal

1

yes

Value for minimum charge period.

networkCost

BigDecimal

1

yes

Value for public IPs.

standingCharge

BigDecimal

1

yes

Value for deploy.

storageCost

BigDecimal

1

yes

Value for the datastore.

totalCost

BigDecimal

1

yes

Value total.

 

 

The minimumChargePeriod (values of 0-6) and chargePeriod (values of 2-6) can be set in the API with the Pricing Period codes given in the following table.

Pricing Period Code

Description

0

MINUTE

1

HOUR

2

DAY

3

WEEK

4

MONTH

5

QUARTER

6

YEAR

 

VirtualApplianceSpec Media Type

This class is identified by media type:  application/vnd.abiquo.virtualappliancespec+json; version=3.10; application/vnd.abiquo.virtualappliancespec+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the virtual appliance spec

description

String

1

yes

Description of the virtual appliance spec

iconUrl

String

1

optional

The URI of the icon of the virtual appliance spec

creationUser

String

1

no

Nickname of the creation user

creationDate

Date

1

no

Creation date

defaultSpec

Boolean

1

optional

Flag indicating if the spec is the default one or not

virtualMachineSpecs

VirtualMachineSpec

1

no

Spec of virtual appliance's virtual machines

virtualMachineTemplateSpecs

VirtualMachineTemplateSpec

1

no

Spec of templates used in virtual appliance's virtual machines

networkSpecs

NetworkSpec

1

no

Spec of networks used in virtual appliance's virtual machines

loadBalancersSpecs

LoadBalancersSpec

1

no

Spec of load balancers used in virtual appliance's virtual machines

firewallPolicySpecs

FirewallPolicySpec

1

no

Spec of firewalls used in virtual appliance's virtual machines

tierSpecs

TierSpec

1

no

Spec of tiers used in virtual appliance's virtual machines

datastoreTierSpecs

DatastoreTierSpec

1

no

Spec of datastore tiers used in virtual appliance's virtual machines

alertSpecsAlertSpec1noSpec of alerts used in the virtual appliance
sslCertificatesSSLCertificateSpec1noSpec of SSL certificates used in the virtual appliance's load balancers

 

 

VirtualApplianceSpecs Media Type

This class is identified by media type:  application/vnd.abiquo.virtualappliancespecs+json; version=3.10; application/vnd.abiquo.virtualappliancespecs+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualApplianceSpec Media Type

1..n

no

The collection of List of VirtualApplianceSpec Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VirtualApplianceSpecValidation Media Type

This class is identified by media type:  application/vnd.abiquo.virtualappliancespecverification+json; version=3.10; application/vnd.abiquo.virtualappliancespecverification+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

templates

Map

1

no

Suggested templates to use in virtual appliance creation from spec

tiers

Map

1

no

Tiers to use in virtual appliance creation from spec

datastoreTiers

Map

1

no

Datastore tiers to use in virtual appliance creation from spec

publicIpsToPurchase

long

1

no

Public IPs to purchase in virtual appliance creation from spec

chefEnabled

boolean

1

no

Flag indicating if spec is using chef enabled virtual machines

errors

List of String

1

no

Errors from validating the spec

warningsList of String1noWarnings from validating the spec

 

 

VirtualApplianceState Media Type

This class is identified by media type:  application/vnd.abiquo.virtualappliancestate+json; version=3.10; application/vnd.abiquo.virtualappliancestate+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

power

VirtualApplianceState

1

no

Current state of the virtual appliance. The state is inferred from its
virtual machines. Values can be: DEPLOYED, NOT_DEPLOYED, NEEDS_SYNCHRONIZE

 

Cloud Virtual Datacenter Entities

 

Firewall Policy Media Type

This class is identified by media type:  application/vnd.abiquo.firewallpolicy+json; version=3.10; application/vnd.abiquo.firewallpolicy+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

The identifier of the firewall policy

nameString1yesThe name of the firewall policy
descriptionString1yesThe description of the firewall policy
providerIdString1noThe provider's ID for the firewall policy

 

FirewallPolicies Media Type

This class is identified by media type:  application/vnd.abiquo.firewallpolicies+json; version=3.10; application/vnd.abiquo.firewallpolicies+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of FirewallPolicy Media Type

1..n

optional

The collection of List of FirewallPolicy Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute



FirewallRule Media Type

This class is identified by media type:  application/vnd.abiquo.firewallrule+json; version=3.10; application/vnd.abiquo.firewallrule+xml; version=3.10; 

 

A firewall rule can filter either incoming traffic or outgoing traffic.

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

The ID of the firewall rule

providerIdString1noThe provider's ID for the firewall rule
protocolString1yesProtocol of the firewall rule
fromPortInteger1yesStart of port range that the rule applies to
toPortInteger1yesEnd of port range that the rule applies to
targetslist of target (String)1..nyesTarget ports for outgoing traffic in egress rule
sourcelist of source (String)1..nyesSource ports for incoming traffic in ingress rule

 

FirewallRules Media Type

This class is identified by media type:  application/vnd.abiquo.firewallrules+json; version=3.10; application/vnd.abiquo.firewallrules+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of FirewallRule Media Type

1..n

optional

The collection of List of FirewallRule Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

HealthState Media Type

This class is identified by media type:  application/vnd.abiquo.healthstate+json; version=3.10; application/vnd.abiquo.healthstate+xml; version=3.10; 

Describes when virtual machine registered in a LoadBalancer is suitable to receive traffic as defined by its configured HealthChecks

Attribute

Type

Occurs

Input Required

Description

outOfService

boolean

1

yes

Whether the virtual machine is not suitable to receive traffic or suitable

 

Health Check Media Type

Define how to know if a certain virtual machine is suitable to accept traffic from the load balancer.

application/vnd.abiquo.healthcheck+json; version=3.10; application/vnd.abiquo.healthcheck+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

name

String

1

true

Friendly name

providerId

String

1

false

Identifies the health check in the provider

protocol

String

1

true

Connection type to perform the check. valid *protocol* values based on plugin constraint *LOADBALANCER_HEALTHCHECK_PROTOCOLS_CSV* :
curl -XGET http://<abiquoIP>/api/config/hypervisortypes

port

Integer

1

true

Where open the connection during the check. Value range: 0 - 65535

intervalInMs

Integer

1

true

Time between checks

timeoutInMs

Integer

1

true

Time to wait during the check. Must be less than interval

attempts

Integer

1

true

Number of consecutive health probe failures required before moving the instance to the isOutOfService state. Range: 1 - 10

path

String

1

false

Additional info in perform the check. Optional. (example 'webapp/index.html')

statusRegex

String

1

false

Regular expression to match a healthy node during check response status. (example ''^[234] [0-9] [0-9]$'')

bodyRegex

String

1

false

Regular expression to match a healthy node during check response body

 

 

HypervisorDiscovery Media Type

This class is identified by media type:  application/vnd.abiquo.hypervisordiscovery+json; version=3.10; application/vnd.abiquo.hypervisordiscovery+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

ipFrom

String

1

yes

Starting IP

ipTo

String

1

yes

Ending IP

password

String

1

yes

Hypervisor password

port

Integer

1

yes

Hypervisor port

type

HypervisorType

1

yes

Hypervisor type

user

String

1

yes

Hypervisor credentials

vSwitch

String

1

yes

VSwitch

 

ManagedHypervisor Media Type

This class is identified by media type:  application/vnd.abiquo.managedhypervisor+json; version=3.10; application/vnd.abiquo.managedhypervisor+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

ipFrom

String

1

yes

Starting IP

ipTo

String

1

yes

Ending IP

password

String

1

yes

Hypervisor password

port

Integer

1

yes

Hypervisor port

type

HypervisorType

1

yes

Hypervisor type

user

String

1

yes

Hypervisor credentials

vSwitch

String

1

yes

VSwitch

managerPortInteger1yesManager port
managerIPString1yesManager IP
managerUserString1yesManager User
managerPasswordString1yesManager Password

 

HypervisorType Media Type

This class is identified by media type:  application/vnd.abiquo.hypervisortype+json; version=3.10; application/vnd.abiquo.hypervisortype+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

baseFormat

DiskFormatType

1

yes

Base format of the hypervisor type

compatibilityTable

String

1

optional

Compatibility of the hypervisor type

diskControllerTypesString1optionalCompatible disk controllers

defaultPort

int

1

yes

Default port of the hypervisor type

name

String

1

yes

Name of the hypervisor type

realName

String

1

yes

Friendly name of the hypervisor type

constraintsString1yesHypervisor plugin constraints
operationsString1yesHypervisor operations

 

HypervisorTypes Media Type

This class is identified by media type:  application/vnd.abiquo.hypervisortypes+json; version=3.10; application/vnd.abiquo.hypervisortypes+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of HypervisorType Media Type

1..n

optional

The collection of List of HypervisorType Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

LoadBalancerAddress Media Type

Address to be used to reach the load balancer

application/vnd.abiquo.loadbalanceraddress+json; version=3.10; application/vnd.abiquo.loadbalanceraddress+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

providerId

String

1

false

Identifies the load balancer address in the provider

endpoint

String

1

false

IP address or host name used to reach the load balancer

internal

Boolean

1

true

type of endpoint: true for private traffic, otherwise publicly accessible

 

Load Balancer Media Type

Define the configuration of the workload distribution across virtual machines.
application/vnd.abiquo.loadbalancer+xml+json; version=3.10; application/vnd.abiquo.loadbalancer+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

name

String

1

true

Friendly name

algorithm

String (note_algorithm)

1

true

Distribution strategy. note_algorithm valid *algorithm* values based on plugin constrain *LOADBALANCER_ALGORITHMS_CSV* :
curl -XGET http://<abiquoIP>/api/config/hypervisortypes 

providerId

String

1

false

Identifies the load balancer in the provider

loadBalancerAddresses

Load Balancer Addresses Media Type

1

true during POST

Required addresses during creation.  Only used during POST request, not returned in the responses (returned as links )

routingRules

Routing Rules Media Type

1

true during POST

Initial routing . Only used during POST request, not returned in the responses (returned as links )

healthChecks

Health Check Media Type

1

false

Initial health checks. Only used during POST request, not returned in the responses (returned as links )

 

 

Routing Rule Media Type

Define forward functions in the load balancer

application/vnd.abiquo.routingrule+json; version=3.10; application/vnd.abiquo.routingrule+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

providerId

String

1

false

Identifies the routing rule in the provider

portIn

Integer

1

true

inbound port

protocolIn

String

1

true

inbound protocol. valid *protocolIn* values based on plugin constraint *LOADBALANCER_ROUTING_PROTOCOLS_CSV* :
curl -XGET http://<abiquoIP>/api/config/hypervisortypes

portOut

Integer

1

true

outbound port

protocolOut

String

1

true

outbound protocol. valid *protocolOut* values based on plugin constrain *LOADBALANCER_ROUTING_PROTOCOLS_CSV* :
curl -XGET http://<abiquoIP>/api/config/hypervisortypes

sslCertificateSslCertificate1optionalSSL certificate for the routing rule

 

SslCertificate Media Type

This class is identified by media type:  application/vnd.abiquo.sslcertificate+json; version=3.10; application/vnd.abiquo.sslcertificate+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

certificate

String

1

true

PEM encoded certificate

intermediateCertificate

String

1

optional

Additional certificates in the verification chain

name

String

1

true

Friendly name

privateKey

String

1

true

Key to verify the certificate

providerId

String

1

no

Provider id of the virtual datacenter to synchronize

 

SyncVirtualDatacenter Media Type

This class is identified by media type:  application/vnd.abiquo.syncvirtualdatacenter+json; version=3.10; application/vnd.abiquo.syncvirtualdatacenter+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

providerId

String

1

no

Provider id of the virtual datacenter to synchronize



VirtualDatacenter Media Type

To create a virtual datacenter you must supply the hypervisor type, and links to the location and enterprise that the VDC will belong to, as well as a private network definition for the virtual datacenter. You can also supply a link to another default network at the Enterprise level (external or unmanaged network).

If you do not set limits for the virtual datacenter, Abiquo will set the limits to 0, and its users will have access to unlimited resources.

This class is identified by media type:  application/vnd.abiquo.virtualdatacenter+json; version=3.10; application/vnd.abiquo.virtualdatacenter+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

cpuCountHardLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Hard limit

cpuCountSoftLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Soft limit

hdHardLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Hard limit

hdSoftLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Soft limit

hypervisorType

HypervisorType

1

yes

Hypervisor type of the virtual datacenter. Virtualization technology supported for this
virtual datacenter. The location must have a link to this hypervisortype

id

Integer

1

no

Opaque ID of the virtual datacenter.

name

String

1

yes

Virtual datacenter's name.

providerIdString1noCloud provider identification of the virtual datacenter entity

publicIpsHard

long

1

yes

Total amount of Public IPs that may be defined. Hard limit

publicIpsSoft

long

1

yes

Total amount of Public IPs that may be defined. Soft limit

ramHardLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Hard limit

ramSoftLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Soft limit

storageHard

long

1

yes

Total size of external storage that may be assigned. Hard limit

storageSoft

long

1

yes

Total size of external storage that may be assigned. Soft limit

syncStatesyncState1noState of synchronization process for synchronizing a public cloud region that does not support VDCs. Possible values are: NONE, IN_PROGRESS, CHECK_FAILED, FAILED, FINISHED

vlan

VLANNetwork Media Type

1

yes

Virtual datacenter network. A private VLAN is always required, but it may be an external definition for providers that support external VDC networks, such as Azure.

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

locationlink to a Location Entity1yesCreate the virtual datacenter in the datacenter or public cloud region defined by this link. The rel value must be location and the href value is mandatory. The tenant and the creating user must be able to access the location.
enterpriselink to an Enterprise Media Type1yesThe tenant that the VDC will belong to. The creating user must be able to manage the tenant. But if you are an administrator, it is not necessary to switch to the tenant to create a VDC.

 

VirtualDatacenters Media Type

This class is identified by media type:  application/vnd.abiquo.virtualdatacenters+json; version=3.10; application/vnd.abiquo.virtualdatacenters+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualDatacenter Media Type

1..n

no

The collection of List of VirtualDatacenter Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VirtualDatacenterWithDatacenter Media Type

This class is identified by media type:  application/vnd.abiquo.virtualdatacenter+json; version=3.10; application/vnd.abiquo.virtualdatacenter+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

cpuCountHardLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Hard limit

cpuCountSoftLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Soft limit

datacenter

Datacenter Media Type

1

no

Datacenter which belongs the virtual datacenter.

hdHardLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Hard limit

hdSoftLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Soft limit

hypervisorType

HypervisorType

1

yes

Hypervisor type of the virtual datacenter. Virtualization technology supported for this
virtual datacenter.

id

Integer

1

no

Opaque ID of the virtual datacenter.

name

String

1

yes

Virtual datacenter's name.

publicIpsHard

long

1

yes

Total amount of Public IPs that may be defined. Hard limit

publicIpsSoft

long

1

yes

Total amount of Public IPs that may be defined. Soft limit

ramHardLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Hard limit

ramSoftLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Soft limit

storageHard

long

1

yes

Total size of external storage that may be assigned. Hard limit

storageSoft

long

1

yes

Total size of external storage that may be assigned. Soft limit

vlan

VLANNetwork Media Type

1

yes

Virtual datacenter network.

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

Cloud Virtual Machine Entities

Bootstrap Media Type

This class is identified by media type:  application/vnd.abiquo.extended-bootstrap+json; version=3.10; application/vnd.abiquo.extended-bootstrap+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

chefConfig

ChefBootstrap

1

no

Chef configuration.

nodeName

String

1

no

Name of the chef node.

CustomMetric Media Type

This class is identified by media type: application/vnd.abiquo.custommetric+json; version=3.10; application/vnd.abiquo.custommetric+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

descriptionString1yesDescription of custom metric

name

String

1

yes

Name of custom metric

unit

String

1

yes

Unit of custom metric

Metric Datapoint Media Type

This class is identified by media type: application/vnd.abiquo.datapoint+json; version=3.10; application/vnd.abiquo.datapoint+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

timestampTimestamp1yesTimestamp of metric datapoint

value

Double

1

yes

Vale of metric datapoint

 

Metric Media Type

This class is identified by media type: application/vnd.abiquo.metric+json; version=3.10; application/vnd.abiquo.metric+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

name

String

1

no

Metric name

namespace

String

1

no

Metric namespace

datapointslist of datapoint media type1..nnoMetric datapoints

 

Metrics Media Type

This class is identified by media type: application/vnd.abiquo.metrics+json;version=3.10; application/vnd.abiquo.metrics+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of Metric Media Type

1..n

no

The collection of List of Metric Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

MetricMetadata Media Type

This class is identified by media type: application/vnd.abiquo.metricmetadata+json; version=3.10; application/vnd.abiquo.metricmetadata+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

name

String

1

no

Metric name

namespace

String

1

no

Metric namespace

description

String

0..1

no

Metric description

unit

String

0..1

no

Metric unit

 

MetricsMetadata Media Type

This class is identified by media type: application/vnd.abiquo.metricsmetadata+json;version=3.10; application/vnd.abiquo.metricsmetadata+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of MetricMetadata Media Type

1..n

no

The collection of List of MetricMetadata Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

MetricsAlarm Media Type

This class is identified by mediatype: application/vnd.abiquo.alarm+json; version=3.10; application/vnd.abiquo.alarm+xml; version=3.10; 

The alarm is identified by a UUID that occurs in the edit link to the object, for example, https://abiquo.example.com/api/cloud/virtualdatacenters/102/virtualappliances/307/virtualmachines/2384/metrics/cpu_time/alarms/efd6f5ef-85af-47b2-aa5c-fe126d0fdf55

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

The name of the alarm

description

String

1

yes

The description for the alarm

period

Integer

1

yes

The number of seconds over which the statistic is applied >= 60

evaluationPeriods

Integer

1

yes

The number of periods for which the statistic will be compared with the specified threshold

statistic

String

1

yes

Values: average, maximum, minimum, sum, count, dev

threshold

Double

1

yes

The value to compare with the specified statistic

active

Boolean

1

no

True if the alarm has been activated (triggered) because the metric statistic has passed the threshold value or the formula is true. This attribute will be true until the alarm condition test fails and the alarm is deactivated

formula

String

1

yes

Values: notequal, greaterthan, greaterthanorequalto, lessthan, lessthanorequalto, trendup, trenddown

stateUpdateTimestamp

Timestamp

1

no

Timestamp of the date and time when the state of the alarm was last changed

 

MonitoringLevel Media Type

This class is identified by media type:   application/vnd.abiquo.monitoringlevel+json; version=3.10; application/vnd.abiquo.monitoringlevel+xml; version=3.10; 

It is used to update the current monitoring level of a virtual machine

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

The identifier of the monitoring level to set

 

MonitoringLevels Media Type

This class is identified by media type:   application/vnd.abiquo.monitoringlevels+json; version=3.10; application/vnd.abiquo.monitoringlevels+xml; version=3.10; 

It is used to retrieve the supported monitoring levels by provider or hypervisor

Attribute

Type

Occurs

Input Required

Description

collection

List of MonitoringLevel Media Type

1..n

no

The collection of List of MonitoringLevel Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

RunlistElement Media Type

This class is identified by media type:  application/vnd.abiquo.runlistelement+json; version=3.10; application/vnd.abiquo.runlistelement+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

description

String

1

optional

The description of the runlist element.

name

String

1

yes

The name of the runlist element.

priority

int

1

yes

Order in which this runlist element should be applied.

selected

boolean

1

yes

Boolean flag indicating if the runlist element is selected for the virtual machine.

RunlistElements Media Type

This class is identified by media type:  application/vnd.abiquo.runlistelements+json; version=3.10; application/vnd.abiquo.runlistelements+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of RunlistElement Media Type

1..n

no

The collection of List of RunlistElement Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VirtualMachine Media Type

This class is identified by media type:  application/vnd.abiquo.virtualmachine+json; version=3.10; application/vnd.abiquo.virtualmachine+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Opaque ID of the virtual machine.

uuid

String

1

no

UUID of the virtual machine.

name

String

1

yes

Name of the virtual machine. By default the name is ABQ-uuid

labelString1optionalFriendly name of the virtual machine. Corresponds to the "Name" field in the Abiquo user interface

fqdn

String

1

optional

Fully qualified domain name of the virtual machine.

description

String

1

optional

Description of the virtual machine

cpu

Integer

1

yes

Number of CPUs of the virtual machine.

coresPerSocket

Integer

1

optional

Optional ratio to distribute cores in sockets (sockets = cpu / coresPerSocket).
This attribute MUST be divisor of cpu.

ram

Integer

1

yes

RAM size of the virtual machine.

vrdpEnabledboolean1optionalWhether the virtual machine should accept remote access connections or not

vdrpPort

int

1

no

Virtual remote desktop port.

vdrpIP

String

1

no

Virtual remote desktop IP.

idState

int

1

optional

Opaque ID of the state.

state

VirtualMachineState

1

optional

Current virtual machine state.

idType

int

1

optional

Opaque ID of the virtual machine type. Deprecated

typeVirtualMachineType1noType of virtual machine in terms of it is managed by the platform. Type can be: MANAGED, NOT_MANAGED, or CAPTURED.

highDisponibility

int

1

yes

Deprecated

password

String

1

optional

VNC password.

keymap

String

1

optional

Keyboard keymap to be setted on the virtual machine.

runlist

RunlistElements Media Type

1

optional

Chef runlist to bootstrap.

metadataVirtualMachineMetadata1optionalVirtual machine metadata used to store data for Backup, Chef, Monitoring, etc.
monitoredBoolean1yesFetch metrics for this virtual machine and enable monitoring features such as alarms and alerts, and action plans
monitoringLevelmonitoringLevel (String name)1yesThe configured monitoring level in the provider. Some providers such as AWS offer DETAILED and DEFAULT monitoring levels
protectedboolean1yesWhether the virtual machine is protected or not, which means that it is locked in Abiquo by the user
protectedCauseString1optionalIf the virtual machine is protected, the user who is locking the VM can enter the reason, and other users that are allowed to lock VMs can view the reason
variablesList of variables in key:value format1..noptionalVariables for use by the virtual machine
lastSynchronizeString1noTime since the VM definition was synchronized with the hypervisor plugin. While deploying, this attribute is NULL. After the VM has been allocated to the hypervisor and the definition in Abiquo has been synchronized, the attribute is set. Abiquo prevents users from reconfiguring VMs that have not been synchronized to prevent edit conflicts.

dvd

DvdManagement Media Type

1

optional

Deprecated

VirtualMachines Media Type

This class is identified by media type:  application/vnd.abiquo.virtualmachines+json; version=3.10; application/vnd.abiquo.virtualmachines+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualMachine Media Type

1..n

optional

The collection of List of VirtualMachine Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

VirtualMachineFlat Media Type

This class is identified by media type:   application/vnd.abiquo.virtualmachineflat+json; version=3.10; application/vnd.abiquo.virtualmachineflat+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Opaque ID of the virtual machine.

uuid

String

1

no

UUID of the virtual machine.

name

String

1

yes

Name of the virtual machine. By default the name is ABQ-uuid

labelString1optionalFriendly name of the virtual machine. Corresponds to the "Name" field in the Abiquo user interface

fqdn

String

1

optional

Fully qualified domain name of the virtual machine.

description

String

1

optional

Description of the virtual machine

cpu

Integer

1

yes

Number of CPUs of the virtual machine.

coresPerSocket

Integer

1

optional

Optional ratio to distribute cores in sockets (sockets = cpu / coresPerSocket).
This attribute MUST be divisor of cpu.

ram

Integer

1

yes

RAM size of the virtual machine.

vrdpEnabledboolean1optionalWhether the virtual machine should accept remote access connections or not

vdrpPort

int

1

no

Virtual remote desktop port.

vdrpIP

String

1

no

Virtual remote desktop IP.

idState

int

1

optional

Opaque ID of the state.

state

VirtualMachineState

1

optional

Current virtual machine state.

idType

int

1

optional

Opaque ID of the virtual machine type. Deprecated

typeVirtualMachineType1noType of virtual machine in terms of it is managed by the platform. Type can be: MANAGED, NOT_MANAGED, or CAPTURED.

highDisponibility

int

1

yes

Deprecated

password

String

1

optional

VNC password.

keymap

String

1

optional

Keyboard keymap to be setted on the virtual machine.

runlist

RunlistElements Media Type

1

optional

Chef runlist to bootstrap.

metadataVirtualMachineMetadata1optionalVirtual machine metadata used to store data for Backup, Chef, Monitoring, etc.
monitoredBoolean1yesFetch metrics for this virtual machine and enable monitoring features such as alarms and alerts, and action plans
monitoringLevelmonitoringLevel (String name)1yesThe configured monitoring level in the provider. Some providers such as AWS offer DETAILED and DEFAULT monitoring levels
protectedboolean1yesWhether the virtual machine is protected or not, which means that it is locked in Abiquo by the user
protectedCauseString1optionalIf the virtual machine is protected, the user who is locking the VM can enter the reason, and other users that are allowed to lock VMs can view the reason
variablesList of variables in key:value format1..noptionalVariables for use by the virtual machine
lastSynchronizeString1noTime since the VM definition was synchronized with the hypervisor plugin. While deploying, this attribute is NULL. After the VM has been allocated to the hypervisor and the definition in Abiquo has been synchronized, the attribute is set. Abiquo prevents users from reconfiguring VMs that have not been synchronized to prevent edit conflicts.

dvd

DvdManagement Media Type

1

optional

Deprecated

volumes#VolumesManagement Media Type1..noptionalVolumes attached to the virtual machine
disks#DisksManagement Media Type1noDisks attached to the virtual machine
nics#Nics Media Type1yesNICs attached to the virtual machine
VirtualMachineActionPlan Media Type

Field

Type

Occurs

Input Required

Description

name

String

1

optional

Name for the action plan

description

String

1

optional

Description for the action plan

createdBy

String

1

no

Name of the creation user

entries

List of VirtualMachineActionPlanEntry Media Type

1

yes

Ordered list of VirtualMachineActionPlanEntry

VirtualMachineActionPlans Media Type

Field

Type

Occurs

Input Required

Description

collection

List of VirtualMachineActionPlan

1..n

optional

List of VirtualMachineActionPlan Media Type

totalSize

Integer

1

optional

Number of elements of the 'collection' field

VirtualMachineActionPlanEntry Media Type

Field

Type

Occurs

Input Required

Description

sequence

Integer

1

no

 

type

String

1

yes

One of the VirtualMachineActionPlanEntry Types

name

String

1

optional

 

parameter

String

1

optional

 

parameterType

String

1

no

 

VirtualMachineActionPlanEntry Types

Type

Parameter required

Parameter Type

Parameter description

RESET

no

-

-

POWER_ON

no

-

-

POWER_OFF

no

-

-

SHUTDOWN

no

-

-

DEPLOY

no

-

-

UNDEPLOY

no

-

-

INCREASE_CPU

yes

Unsigned integer

The increment of CPU in units

INCREASE_RAM

yes

Unsigned integer

The increment of RAM in GB

DECREASE_CPU

yes

Unsigned integer

The decrement of CPU in units

DECREASE_RAM

yes

Unsigned integer

The decrement of RAM in GB

INSTANCE

yes

String

The base name of the instance

SEND_EMAIL

yes

JSON

{ "addressesTo" : [], "addressesCc" : [], "subject" : "", "body" : "" }

 

IntervalBasedSchedule Media Type

Field

Type

Occurs

Input Required

Description

intervalSeconds

Integer

1

yes

The repeat interval in seconds

startTime

Long

1

optional

The start time for the trigger in milliseconds since January 1, 1970, 00:00:00 GMT

endTime

Long

1

no

The end time for the trigger in milliseconds since January 1, 1970, 00:00:00 GMT

IntervalBasedSchedules Media Type

Field

Type

Occurs

Input Required

Description

collection

List of #IntervalBasedSchedule Media Type

1..n

optional

List of IntervalBasedSchedule Media Type

totalSize

Integer

1

optional

Number of elements of the 'collection' field

CronBasedSchedule Media Type

Field

Type

Occurs

Input Required

Description

seconds

String

1

yes

Allowed values: 0-59 , - * /

minutes

String

1

yes

Allowed values: 0-59 , - * /

hours

String

1

yes

Allowed values: 0-23 , - * /

dayOfMonth

String

1

yes

Allowed values: 1-31 , - * ? / L W

month

String

1

yes

Allowed values: 0-11 or JAN-DEC , - * /

dayOfWeek

String

1

yes

Allowed values: 1-7 or SUN-SAT , - * ? / L #

year

String

1

optional

Allowed values: 1970-2199 , - * /

CronBasedSchedules Media Type

Field

Type

Occurs

Input Required

Description

collection

List of #CronBasedSchedule Media Type

1..n

optional

List of CronBasedSchedule Media Type

totalSize

Integer

1

optional

Number of elements of the 'collection' field

 

VirtualMachineInstance Media Type

This class is identified by media type:  application/vnd.abiquo.virtualmachineinstance+json; version=3.10; application/vnd.abiquo.virtualmachineinstance+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

instanceName

String

1

yes

Instance name

VirtualMachineState Media Type

This class is identified by media type:  application/vnd.abiquo.virtualmachinestate+json; version=3.10; application/vnd.abiquo.virtualmachinestate+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

state

VirtualMachineState

1

yes

State of the virtual machine. Valid values are: OFF, ON or PAUSED

gracefulShutdown

Boolean

1

optional

Can be used with OFF state to specify how to power off a virtual machine. If true, try to perform a graceful shutdown. If not supplied or false, perform a hard power off.

VirtualMachineTask Media Type

This class is identified by media type:  application/vnd.abiquo.virtualmachinetask+json; version=3.10; application/vnd.abiquo.virtualmachinetask+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

forceUndeploy

Boolean

1

optional

Imported machines does not have the image stored in an Abiquo repo. If we undpeloy them, we
have lost the image and it is unrecoverable. Use it if you force to undeploy imported
VirtualMachines.

Configuration Entities

License Media Type

This class is identified by media type:  application/vnd.abiquo.license+json; version=3.10; application/vnd.abiquo.license+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

code

String

1

yes

The license code

expiration

String

1

no

The expiration date of the license

id

Integer

1

no

The identifier of the entity

numcores

Integer

1

no

The number of cores that the license enables

enabledPlugins

String

1

optional

The plugins that are enabled by the license

Licenses Media Type

This class is identified by media type:  application/vnd.abiquo.licenses+json; version=3.10; application/vnd.abiquo.licenses+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

availablecores

Integer

1

optional

 

collection

List of License Media Type

1..n

optional

The collection of List of License Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

SystemProperty Media Type

This class is identified by media type:  application/vnd.abiquo.systemproperty+json; version=3.10; application/vnd.abiquo.systemproperty+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

description

String

1

optional

A desription of the usage of the property

id

Integer

1

no

Identifier of the entity

name

String

1

yes

The name of the property

value

String

1

yes

The value of the property

SystemProperties Media Type

This class is identified by media type:  application/vnd.abiquo.systemproperties+json; version=3.10; application/vnd.abiquo.systemproperties+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of SystemProperty Media Type

1..n

optional

The collection of List of SystemProperty Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Event Entities

Event Media Type

This class is identified by media type:  application/vnd.abiquo.event+json; version=3.10; application/vnd.abiquo.event+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

actionPerformed

String

1

no

The action performed.

component

String

1

no

The component.

datacenter

String

1

no

The datacenter where the event was triggered.

enterprise

String

1

no

The enterprise.

id

Integer

1

no

The id of the event.

idDatacenter

Integer

1

no

The id datacenter where the event took place.

idEnterprise

Integer

1

no

The id enterprise of the user's enterprise.

idNetwork

Integer

1

no

The id network if the action performed was over a network.

idPhysicalMachine

Integer

1

no

The id physical machine if the action performed was over a physical machine.

idRack

Integer

1

no

The id rack if the action performed was over a rack.

idStoragePool

String

1

no

The id storage pool if the action performed was over a storage pool.

idStorageSystem

Integer

1

no

The id storage system if the action performed was over a storage system.

idSubnet

Integer

1

no

The id subnet if the action performed was over a subnet.

idUser

Integer

1

no

The id user that triggered the event.

idVirtualApp

Integer

1

no

The id virtual app if the action performed was over a virtual appliance.

idVirtualDatacenter

Integer

1

no

The id virtual datacenter if the action performed was over a virtual datacenter.

idVirtualMachine

Integer

1

no

The id virtual machine if the action performed was over a virtual machine.

idVolume

String

1

no

The id volume if the action performed was over a volume.

network

String

1

no

The network if the action performed was over a network.

performedBy

String

1

no

The performed by, who performed the action.

physicalMachine

String

1

no

The physical machine if the action performed was over a physical machine.

rack

String

1

no

The rack if the action performed was over a rack.

severity

SeverityType

1

no

The severity:

  • INFO

  • WARN

  • ERROR

stacktrace

String

1

no

The stacktrace. If the action is an error here is possible to look up the java stack trace.

storagePool

String

1

no

The storage pool if the action performed was over a storage pool.

storageSystem

String

1

no

The storage system if the action performed was over a storage system.

subnet

String

1

no

The subnet if the action performed was over a subnet.

timestamp

Date

1

no

The timestamp. Time when the event took place.

user

String

1

no

The user whose performed the action.

virtualApp

String

1

no

The virtual app if the action performed was over a virtual appliance.

virtualDatacenter

String

1

no

The virtual datacenter if the action performed was over a virtual datacenter.

virtualMachine

String

1

no

The virtual machine if the action performed was over a virtual machine.

volume

String

1

no

The volume if the action performed was over a volume.

EventTypes Media Type

This class is identified by media type:  application/vnd.abiquo.eventtypes+json; version=3.10; application/vnd.abiquo.eventtypes+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

actions

EventActions Media Type

1..n

no

List of Event Action Media Type elements

severities

EventSeverities Media Type

1..n

no

List of Event Severity Media Type elements

 
EventTypes Media Type

This class is identified by media type:  application/vnd.abiquo.eventtypes+json; version=3.10; application/vnd.abiquo.eventtypes+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of Event Media Type

1..n

no

The collection of List of Event Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

Infrastructure Datacenter and Public Cloud Region Entities

Backup Configuration Media Type

This class is identified by media type:  application/vnd.abiquo.backupconfiguration+json; version=3.10; application/vnd.abiquo.backupconfiguration+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

typeType1yesBackup type with possible values: COMPLETE, SNAPSHOT, FILESYSTEM, OPTIONS

period

Period

1

yes

Backup period with possible values: DEFINED_HOUR, HOURLY, DAILY, WEEKLY_PLANNED, MONTHLY, REPLICATION

time

String

1

yes

Time when the backup will be performed

days

String

1

yes

List of DayOfWeek

BackupDatacenterProperties

This class is identified by media type:  application/vnd.abiquo.backupdatacenterproperties+json; version=3.10; application/vnd.abiquo.backupdatacenterproperties+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

enableMultipleRestoreboolean1yesWhether to allow the user to request multiple restores after a restore completes or fails, or not

enableMultiplePolicies

boolean

1

yes

Whether to allow the user to select multiple policies for a VM or not 

enableUpdateWhileDeployed

boolean

1

yes

Whether to allow the user to update the backup options when the VM is deployed, or not

enableManualBackup

boolean

1

yes

Whether to enable backup now, or not

 

BackupPolicy Media Type

This class is identified by media type:  application/vnd.abiquo.backuppolicy+json; version=3.10; application/vnd.abiquo.backuppolicy+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

backupConfigurationslist of backupConfiguration1..nyesBackup configurations (type, period, time) of backup policy

code

String

1

yes

Code to identify the backup policy

description

String

1

yes

Description of the backup policy

name

String

1

yes

Name of the datacenter

Cluster Media Type

This class is identified by media type: application/vnd.abiquo.cluster+json; version=3.10; application/vnd.abiquo.cluster+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

providerIdString1noThe cluster identifier in the provider

providerType

String

1

no

The provider's hypervisor type

 

Clusters Media Type

This class is identified by media type:  application/vnd.abiquo.clusters+json; version=3.10; application/vnd.abiquo.clusters+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of Cluster Media Type

1..n

no

The collection of clusters


Datacenter Media Type

This class is identified by media type:  application/vnd.abiquo.datacenter+json; version=3.10; application/vnd.abiquo.datacenter+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the datacenter

location

String

1

yes

Location of the datacenter

name

String

1

yes

Name of the datacenter

remoteServicesList of RemoteService as RemoteServices1..nyesRemote Services assigned to the datacenter

Datacenter entity Links:

  • edit

  • racks

  • remote services

  • backups

  • update resources

  • hypervisors

  • enterprises

  • discover

  • machines state

  • machines ipmi

  • tiers

  • storage devices

  • network service types

  • public networks

  • limits

Datacenters Media Type

This class is identified by media type:  application/vnd.abiquo.datacenters+json; version=3.10; application/vnd.abiquo.datacenters+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Datacenter Media Type

1..n

optional

The collection of List of Datacenter Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

DatacenterLight Media Type

This class is identified by media type:  application/vnd.abiquo.datacenterlight+json; version=3.10; application/vnd.abiquo.datacenterlight+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

idDatacenter

int

1

optional

Identifier of the datacenter

name

String

1

optional

Name of the datacenter

 

DatacentersLight Media Type

This class is identified by media type: application/vnd.abiquo.datacenterslight+json; version=3.10; application/vnd.abiquo.datacenterslight+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of DatacenterLight Media Type

1..n

optional

The collection of List of DatacenterLight Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

HardwareProfile Media Type

This class is identified by media type:  application/vnd.abiquo.hardwareprofile+json; version=3.10; application/vnd.abiquo.hardwareprofile+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

providerId

String

1

no

The provider's ID for the hardware profile

cpu

Integer

1

no

CPU of the hardware profile

ramInMbInteger1noRAM in megabytes of the hardware profile

 

HardwareProfiles Media Type

This class is identified by media type: application/vnd.abiquo.hardwareprofiles+json; version=3.10; application/vnd.abiquo.hardwareprofiles+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of HardwareProfile Media Type

1..n

optional

The collection of List of HardwareProfile Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

Location Entity

A location is a datacenter or public cloud region data media type.

This class is identified by media type:  application/vnd.abiquo.datacenter+json; version=3.10; application/vnd.abiquo.datacenter+xml; version=3.10; application/vnd.abiquo.publiccloudregion+json; version=3.10; application/vnd.abiquo.publiccloudregion+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the datacenter or public cloud region

name

String

1

yes

Name of the datacenter or public cloud region

remoteServicesList of RemoteService as RemoteServices1..nyesRemote Services assigned to the datacenter or public cloud region

Example of location entity Links for datacenter:

  • Location: edit - datacenter or public cloud region link

  • racks

  • remote services

  • backups

  • upate resources

  • hypervisors

  • enterprises

  • discover

  • machines state

  • machines ipmi

  • tiers

  • storage devices

  • network service types

  • public networks

  • limits

  • remote service, e.g. VIRTUALFACTORY

  • repository

  • Location: self - link to the location, title is the location name

  • floating ips

  • availability zones

  • firewalls

  • hardwareprofiles

  • loadbalancers

  • addresses

  • ssl certificates

  • available templates

  • remote vdcs

  • remote vms

  • testhypervisor

PublicCloudRegion Media Type

This class is identified by media type:  application/vnd.abiquo.publiccloudregion+json; version=3.10; application/vnd.abiquo.publiccloudregion+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

name

String

 

1

yes

The name of a public cloud region

remoteServices

RemoteServices Media Type

1

optional 

List of remote services transfer objects

PublicCloudRegions Media Type

This class is identified by media type:  application/vnd.abiquo.publiccloudregions+json; version=3.10; application/vnd.abiquo.publiccloudregions+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of PublicCloudRegion Media Type

1..n

optional

The collection of List of PublicCloudRegion Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

Region Media Type

This class is identified by media type:   application/vnd.abiquo.region+json; version=3.10; application/vnd.abiquo.region+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

name

String

1

optional

 

The name of the region

endpoint

String

1

optional

The address for communicating with the region

 

RemoteService Media Type

This class is identified by media type:  application/vnd.abiquo.remoteservice+json; version=3.10; application/vnd.abiquo.remoteservice+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

configurationErrors

Errors Media Type

1

optional

List of configuration errors

id

Integer

1

optional

Identifier of the entity

status

int

1

optional

Current status of the remote service

type

RemoteServiceType

1

yes

Remote Service Type

uri

String

1

yes

URI of the remote service

uuidString1noUnique identifier of a shared remote services
RemoteServices Media Type

This class is identified by media type:  application/vnd.abiquo.remoteservices+json; version=3.10; application/vnd.abiquo.remoteservices+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of RemoteService Media Type

1..n

optional

The collection of List of RemoteService Media Type elements

configErrors

Errors Media Type

1

optional

List of configuration errors

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Infrastructure Rack and Machine Entities

Machine Media Type

This class is identified by media type:  application/vnd.abiquo.machine+json; version=3.10; application/vnd.abiquo.machine+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

agentIPString1optionalIP for the agent to connect to the hypervisor
agentPasswordString1optionalPassword of the agent to connect to the hypervisor
agentPortInteger1optionalPort for the agent to connect to the hypervisor
agentUserString1optionalUsername of the agent to connect to the hypervisor

datastores

Datastores Media Type

1

yes

List of datastore of the machine

description

String

1

optional

Description of the machine

id

Integer

1

optional

Identifier of the machine

initiatorIQN

String

1

optional

Initiator IQN of the machine used to use storage devices

ip

String

1

yes

IP of the machine

ipService

String

1

yes

IP of the hypervisor service of machine

ipmiIP

String

1

optional

IP of the impi service of the machine

ipmiPassword

String

1

optional

Password of the user for loggon into the impi service of the machine

ipmiPort

Integer

1

optional

Connection port of the impi service of the machine

ipmiUser

String

1

optional

Name of the user for logging in to the impi service of the machine

managerIpString1optionalManager IP address
managerPasswordString1optionalManager password for logging in to the hypervisor manager
managerPortInteger1optionalManager port
managerUserString1optionalManager user for logging in to the hypervisor manager

name

String

1

yes

Name of the machine

networkInterfaces

NetworkInterfaces Media Type

1

optional

The networkInterfaces

password

String

1

yes

Password of the user for logging in to the hypervisor service

port

Integer

1

yes

Connection port of the machine

state

MachineState

1

no

State of the machine, can be one of the following {STOPPED, PROVISIONED, NOT_MANAGED,
MANAGED, HALTED, UNLICENSED, HA_IN_PROGRESS, DISABLED_FOR_HA, HALTED_FOR_SAVE, CREATING}

type

HypervisorType

1

yes

Value of the hypervisor type supported by abiquo

user

String

1

yes

Name of the user for loggon into the hypervisor service

virtualCpuCores

Integer

1

yes

Numbre of cpus of the machine

virtualCpusUsed

Integer

1

yes

Numbre of used cpus of the machine

virtualRamInMb

Integer

1

yes

RAM in MB of the machine

virtualRamUsedInMb

Integer

1

yes

Used RAM in MB of the machine

Machines Media Type

This class is identified by media type:  application/vnd.abiquo.machines+json; version=3.10; application/vnd.abiquo.machines+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Machine Media Type

1..n

optional

The collection of List of Machine Media Type elements

errors

Errors Media Type

1

optional

 

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

MachineIpmiState Media Type

This class is identified by media type:  application/vnd.abiquo.machineipmistate+json; version=3.10; application/vnd.abiquo.machineipmistate+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

state

MachineIpmiState

1

optional

State of the ipmi configuration of the machine.

MachineState Media Type

This class is identified by media type:  application/vnd.abiquo.machinestate+json; version=3.10; application/vnd.abiquo.machinestate+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

state

MachineState

1

optional

State of the machine. Possible values: STOPPED, PROVISIONED, NOT_MANAGED, MANAGED, HALTED, UNLICENSED, HA_IN_PROGRESS, DISABLED_FOR_HA, HALTED_FOR_SAVE, CREATING

MachinesToCreate Media Type

This class is identified by media type:  application/vnd.abiquo.multiplemachines+json; version=3.10; application/vnd.abiquo.multiplemachines+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

hypervisor

String

1

yes

Value of the hypervisor type supported by abiquo.

ipFrom

String

1

yes

Start of the IP interval of the machines to discover.

ipTo

String

1

yes

End of the IP interval of the machines to discover.

password

String

1

yes

Password of the user for logging into the hypervisor service.

port

Integer

1

yes

Connection port of the machines to discover.

user

String

1

yes

Name of the user for logging into the hypervisor service.

vSwitch

String

1

yes

Virtual switch of the machines to discover

Mail Media Type

This class is identified by media type:  application/vnd.abiquo.mail+json; version=3.10; application/vnd.abiquo.mail+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

body

String

1

optional

body of the mail

subject

String

1

optional

subject of the mail

NetworkInterface Media Type

This class is identified by media type:  application/vnd.abiquo.networkinterface+json; version=3.10; application/vnd.abiquo.networkinterface+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

mac

String

1

optional

MAC address of the Network Interface in the target Hypervisor

name

String

1

optional

Name of the Network Interface in the target Hypervisor

networkServiceTypeLink

RESTLink

1

optional

 
NetworkInterfaces Media Type

This class is identified by media type:  application/vnd.abiquo.networkinterfaces+json; version=3.10; application/vnd.abiquo.networkinterfaces+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of NetworkInterface Media Type

1..n

optional

The collection of List of NetworkInterface Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Rack Media Type

This class is identified by media type:  application/vnd.abiquo.rack+json; version=3.10; application/vnd.abiquo.rack+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

haEnabled

boolean

1

optional

HA enabled in the rack.

id

Integer

1

no

Identifier of the entity.

longDescription

String

1

optional

Long description of the rack.

name

String

1

yes

Name of the rack.

nrsq

Integer

1

optional

Specify the percentatge of new virtual datacenters tolerance in allocation.

shortDescription

String

1

optional

Short description of the rack.

vlanIdMax

Integer

1

optional

Maximum value of the tag of the VLANs allowed in the rack.

vlanIdMin

Integer

1

optional

Minimum value of the tag of the VLANs allowed in the rack.

vlanPerVdcReserved

Integer

1

no

Deprecated Attribute.

vlansIdAvoided

String

1

optional

List of tags avoided in the VLANs allowed in the rack.

Racks Media Type

This class is identified by media type:  application/vnd.abiquo.racks+json; version=3.10; application/vnd.abiquo.racks+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of Rack Media Type

1..n

no

The collection of List of Rack Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

ReservedMachine Media Type

This class is identified by media type:  application/vnd.abiquo.reservedmachine+json; version=3.10; application/vnd.abiquo.reservedmachine+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

agentIPString1optionalIP for the agent to connect to the hypervisor
agentPasswordString1optionalPassword of the agent to connect to the hypervisor
agentPortInteger1optionalPort for the agent to connect to the hypervisor
agentUserString1optionalUsername of the agent to connect to the hypervisor

datacenter

Datacenter Media Type

1

optional

Datacenter of the physical machine

datastores

Datastores Media Type

1

yes

List of datastore of the machine

description

String

1

optional

Description of the machine

id

Integer

1

optional

Identifier of the machine

initiatorIQN

String

1

optional

Initiator IQN of the machine used to use storage devices

ip

String

1

yes

IP of the machine

ipService

String

1

yes

IP of the hypervisor service of machine

ipmiIP

String

1

optional

IP of the impi service of the machine

ipmiPassword

String

1

optional

Password of the user for loggon into the impi service of the machine

ipmiPort

Integer

1

optional

Connection port of the impi service of the machine

ipmiUser

String

1

optional

Name of the user for logging in to the impi service of the machine

managerIpString1optionalManager IP address
managerPasswordString1optionalManager password for logging in to the hypervisor manager
managerPortInteger1optionalManager port
managerUserString1optionalManager user for logging in to the hypervisor manager

name

String

1

yes

Name of the machine

networkInterfaces

NetworkInterfaces Media Type

1

optional

The networkInterfaces

password

String

1

yes

Password of the user for logging in to the hypervisor service

port

Integer

1

yes

Connection port of the machine

rack

Rack Media Type

1

optional

Rack of the physical machine

state

MachineState

1

no

State of the machine, can be one of the following {STOPPED, PROVISIONED, NOT_MANAGED,
MANAGED, HALTED, UNLICENSED, HA_IN_PROGRESS, DISABLED_FOR_HA, HALTED_FOR_SAVE, CREATING}

type

HypervisorType

1

yes

Value of the hypervisor type supported by abiquo

user

String

1

yes

Name of the user for loggon into the hypervisor service

virtualCpuCores

Integer

1

yes

Numbre of cpus of the machine

virtualCpusUsed

Integer

1

yes

Numbre of used cpus of the machine

virtualRamInMb

Integer

1

yes

RAM in MB of the machine

virtualRamUsedInMb

Integer

1

yes

Used RAM in MB of the machine

 

ReservedMachines Media Type

This class is identified by media type:  application/vnd.abiquo.reservedmachines+json; version=3.10; application/vnd.abiquo.reservedmachines+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of ReservedMachine Media Type

1..n

optional

The collection of List of ReservedMachine Media Type elements

errors

Errors Media Type

1

optional

 

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

VlanTagAvailability Media Type

This class is identified by media type:  application/vnd.abiquo.vlantagavailability+json; version=3.10; application/vnd.abiquo.vlantagavailability+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

available

VlanTagAvailabilityType

1

no

Return if the VLAN tag is available in to be used in the Datacenter

message

String

1

no

Return the reason why the tag is not available

Network Entities

AvailabilityZone Media Type

Attribute

Type

Occurs

Input Required

Description

name

String

1

no

Name of an availability zone

AvailabilityZones Media Type

This class is identified by mediatype: application/vnd.abiquo.availabilityzones+json; version=3.10; application/vnd.abiquo.availabilityzones+xml; version=3.10;   

Attribute

Type

Occurs

Input Required

Description

collection

List of AvailabilityZone Media Type

1..n

no

The collection of List of AvailabilityZone Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute  

 

Device Media Type

This class is identified by mediatype: application/vnd.abiquo.device+json; version=3.10; application/vnd.abiquo.device+xml; version=3.10;   

Attribute

Type

Occurs

Input Required

Description

endpoint

String

1

yes

Connection attribute: endpoint to use in the plugin

name

String

1

yes

Friendly name of the device

description

String

1

yes

Description of the VPC device

user

String

1

yes

Connection attribute: user name for authentication

password

String

1

yes

The list of methods that are not supported by the plugin interface

vdcDefault

boolean

1

optional

New virtual datacenters will use the device configured in their location

Includes links to:

  • edit

  • location

  • device type

  • virtual datacenters (0..n, optional)

  • enterprise

  • firewalls  (type application/vnd.abiquo. firewallpolicies)

  • "loadbalancers" (type application/vnd.abiquo. loadbalancers)

  • "addresses" (type application/vnd.abiquo. loadbalanceraddresses)

  • "sslcertificates" (type application/vnd.abiquo. sslcertificates)  

Devices Media Type

This class is identified by mediatype: application/vnd.abiquo.vpcdevices+json; version=3.10; application/vnd.abiquo.vpcdevices+xml; version=3.10;   

Attribute

Type

Occurs

Input Required

Description

collection

List of Device Media Type

1..n

no

The collection of List of Device Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute  

 

Device Interface Media Type

This class is identified by mediatype:  application/vnd.abiquo.deviceInterface+json; version=3.10; application/vnd.abiquo.deviceInterface+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

The name of the VPC device type

realName

String

1

yes

The friendly name of the VPC device type

constraints

Constraint

1..n

no

The list of constraints including supported protocols and elements

operations

Operation

1..n

no

The list of methods that are not supported by the plugin interface

Device Type Media Type

This class is identified by mediatype:  application/vnd.abiquo.devicetype+json; version=3.10; application/vnd.abiquo.devicetype+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

The name of the device type

deviceInterfaces

List of device interfaces (deviceInterfacetype)

1..n

no

The list of interfaces of the plugin, including for example:

  • VPC

  • Networking

  • ExternalNetworking

  • PublicNetworking

  • Firewall

  • LoadBalancers

  • DHCP

Device Types Media Type

This class is identified by mediatype: application/vnd.abiquo.devicetypes+json; version=3.10; application/vnd.abiquo.devicetypes+xml; version=3.10;   

Attribute

Type

Occurs

Input Required

Description

collection

List of Device Type Media Type

1..n

no

The collection of List of Device Type Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute 

DeviceInterfaceType Media Type

This class is identified by mediatype:  application/vnd.abiquo.deviceInterfacetype+json; version=3.10; application/vnd.abiquo.deviceInterfacetype+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

deviceInterface

String

1

yes

The name of the device interface type

realName

String

1

yes

The friendly name of the device interface type

constraints

Constraint

1..n

no

The list of constraints including supported protocols and elements

operations

Operation

1..n

no

The list of methods that are not supported by the plugin interface

DhcpOption Media Type

This class is identified by media type:  application/vnd.abiquo.dhcpoption+json; version=3.10; application/vnd.abiquo.dhcpoption+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

gateway

String

1

yes

Gateway of the static route

id

Integer

1

no

Identifier of the entity

mask

Integer

1

yes

Mask of the network of the static route in integer mode

netmask

String

1

yes

Mask of the network in 'xxx.xxx.xxx.xxx' format

networkAddress

String

1

yes

Network address of the static route

option

int

1

yes

The integer value that defines the option

DhcpOptions Media Type

This class is identified by media type:  application/vnd.abiquo.dhcpoptions+json; version=3.10; application/vnd.abiquo.dhcpoptions+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of DhcpOption Media Type

1..n

optional

The collection of List of DhcpOption Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

ExternalIp Media Type

This class is identified by media type:  application/vnd.abiquo.externalip+json; version=3.10; application/vnd.abiquo.externalip+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

available

boolean

1

optional

If the IP is available to be used by a customer"

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

ipv6

boolean

1

no

Whether the IP is IPv6 or not

mac

String

1

no

MAC address associated to the IP address

name

String

1

no

Lease name of the entity. It will be used by the DHCP server to identify the IP-MAC static
rule

networkName

String

1

no

Name of the network which the IP belongs to

quarantine

boolean

1

optional

IP in quarantine

ExternalIps Media Type

This class is identified by media type:  application/vnd.abiquo.externalips+json; version=3.10; application/vnd.abiquo.externalips+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of ExternalIp Media Type

1..n

optional

The collection of List of ExternalIp Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Ips Bulk Creation Media Type

This class is identified by media type:  application/vnd.abiquo.ipsbulkcreation+json; version=3.10; application/vnd.abiquo.ipsbulkcreation+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

ip

String

1

yes

String that represents the IP address

ipv6

Boolean

1

optional

Defines if the created ips will be of version. default: false

available

Boolean

1

optional

Defines if the created ips will be available to be used by the users. default: false

quarantine

Boolean

1

optional

Defines if the created ips will be in quarantine state. default: false

numips

Integer

1

yes

How many ips will be created including the given one

 

GlobalNetwork Media Type

This class is identified by media type:  application/vnd.abiquo.globalnetwork+json; version=3.10; application/vnd.abiquo.globalnetwork+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

providerId

Integer

1

no

Provider's ID for the global network

 

GlobalNetworks Media Type

This class is identified by media type:  application/vnd.abiquo.globalnetworks+json; version=3.10; application/vnd.abiquo.globalnetworks+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of GlobalNetwork Media Type

1..n

optional

The collection of List of GlobalNetwork Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

NetworkExcluded Media Type

This class is identified by media type: application/vnd.abiquo.networkexcluded+json; version=3.10; application/vnd.abiquo.networkexcluded+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the excluded network

address

String

1

yes

Network Address of the excluded network

mask

Integer

1

yes

Numerical value of the excluded network mask

ipv6boolean1yesIs the network IPv6? Set to true for IPv6 and false for IPv4. Default false


NetworksExcluded Media Type

This class is identified by media type: application/vnd.abiquo.networksexcluded+json; version=3.10; application/vnd.abiquo.networksexcluded+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of NetworkExcluded Media Type

1..n

optional

The collection of List of NetworkExcluded Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute


NetworkServiceType Media Type

This class is identified by media type:  application/vnd.abiquo.networkservicetype+json; version=3.10; application/vnd.abiquo.networkservicetype+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

defaultNST

boolean

1

no

Whenever the Network Service Type is the default one by the current datacenter

id

Integer

1

no

Identifier of the entity

name

String

1

yes

Name that defines the Network Service Type.

 

NetworkServiceTypes Media Type

This class is identified by media type:  application/vnd.abiquo.networkservicetypes+json; version=3.10; application/vnd.abiquo.networkservicetypes+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of NetworkServiceType Media Type

1..n

optional

The collection of List of NetworkServiceType Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Nic Media Type

This class is identified by media type:  application/vnd.abiquo.nic+json; version=3.10; application/vnd.abiquo.nic+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

ip

String

1

no

Ip address asociated to a NIC

mac

String

1

no

MAC address of the NIC

sequence

Integer

1

no

Sequence of the NIC inside its Virtual Machine

tagInteger1noThe tag from the hypervisor used in VM capture
Nics Media Type

This class is identified by media type:  application/vnd.abiquo.nics+json; version=3.10; application/vnd.abiquo.nics+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Nic Media Type

1..n

optional

The collection of List of Nic Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

PrivateIp Media Type

This class is identified by media type:  application/vnd.abiquo.privateip+json; version=3.10; application/vnd.abiquo.privateip+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

ipv6boolean1noWhether the IP is IPv6 or not

mac

String

1

no

MAC address associated to the IP address

name

String

1

no

Lease name of the entity. It will be used by the DHCP server to identify the IP-MAC static
rule

networkName

String

1

no

Name of the network which the IP belongs to

PrivateIps Media Type

This class is identified by media type:  application/vnd.abiquo.privateips+json; version=3.10; application/vnd.abiquo.privateips+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of PrivateIp Media Type

1..n

optional

The collection of List of PrivateIp Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

PublicIp Media Type

This class is identified by media type:  application/vnd.abiquo.publicip+json; version=3.10; application/vnd.abiquo.publicip+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

available

boolean

1

optional

If the IP is available to be used by a customer

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

ipv6

boolean

1

no

Whether the IP is IPv6 or not

mac

String

1

no

MAC address associated to the IP address

name

String

1

no

Lease name of the entity. It will be used by the DHCP server to identify the IP-MAC static
rule

networkName

String

1

no

Name of the network which the IP belongs to

providerIdString1noIdentifier of the IP in the remote provider

quarantine

boolean

1

optional

IP in quarantine

 

PublicIps Media Type

This class is identified by media type:  application/vnd.abiquo.publicips+json; version=3.10; application/vnd.abiquo.publicips+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of PublicIp Media Type

1..n

optional

The collection of List of PublicIp Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

UnmanagedIp Media Type

This class is identified by media type:  application/vnd.abiquo.unmanagedip+json; version=3.10; application/vnd.abiquo.unmanagedip+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

available

boolean

1

optional

If the IP is available to be used by a customer"

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

ipv6

boolean

1

no

Whether the IP is IPv6 or not

mac

String

1

no

MAC address associated to the IP address

name

String

1

no

Lease name of the entity. It will be used by the DHCP server to identify the IP-MAC static
rule

networkName

String

1

no

Name of the network which the IP belongs to

quarantine

boolean

1

optional

IP in quarantine

 

UnmanagedIps Media Type

This class is identified by media type:  application/vnd.abiquo.unmanagedips+json; version=3.10; application/vnd.abiquo.unmanagedips+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of UnmanagedIp Media Type

1..n

optional

The collection of List of UnmanagedIp Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VLANNetwork Media Type

This class is identified by media type:  application/vnd.abiquo.vlan+json; version=3.10; application/vnd.abiquo.vlan+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

address

String

1

yes

Network Address of the VLAN

defaultNetwork

Boolean

1

no

Return if it is used as Default Network.

dhcpOptions

DhcpOptions Media Type

1

optional

 

gateway

String

1

yes

Gateway of the VLAN

globalNetworkProviderIdString1optionalProvider's ID for the global network

id

Integer

1

optional

Identifier of the entity

ipv6boolean1yesIs the network IPv6? Set to true for IPv6 and false for IPv4. Default false

mask

Integer

1

yes

Numerical value of the VLAN mask

name

String

1

yes

Name of the VLAN

primaryDNS

String

1

optional

Primary DNS address

providerIdString1optionalProvider's ID for the network

secondaryDNS

String

1

optional

Secondary DNS value

strictboolean1yesFor an IPv6 network, is the network strict? Set to true for strict and false for not strict. Default false

sufixDNS

String

1

optional

Suffix DNS value

tag

Integer

1

optional

Tag of the VLAN. It will need an input value for PUBLIC, EXTERNAL and UNMANAGED networks

type

NetworkType

1

optional

Kind of network: PUBLIC, INTERNAL, EXTERNAL and UNMANAGED

unmanaged

Boolean

1

optional

Return if the VLAN is unmanaged

 

VLANNetworks Media Type

This class is identified by media type:  application/vnd.abiquo.vlans+json; version=3.10; application/vnd.abiquo.vlans+xml; version=3.10

Attribute

Type

Occurs

Input Required

Description

collection

List of VLANNetwork Media Type

1..n

optional

The collection of List of VLANNetwork Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VMNetworkConfiguration Media Type

This class is identified by media type:  application/vnd.abiquo.virtualmachinenetworkconfiguration+json; version=3.10; application/vnd.abiquo.virtualmachinenetworkconfiguration+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

gateway

String

1

no

Gateway of the network configuration

id

Integer

1

no

Identifier of the entity

primaryDNS

String

1

no

Primary DNS of the network configuration

secondaryDNS

String

1

no

Secondary DNS of the network configuration

suffixDNS

String

1

no

Suffix DNS of the network configuration

used

Boolean

1

optional

Check if this network configuration actually used by the virtual machine

 

VMNetworkConfigurations Media Type

This class is identified by media type:  application/vnd.abiquo.virtualmachinenetworkconfigurations+json; version=3.10; application/vnd.abiquo.virtualmachinenetworkconfigurations+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VMNetworkConfiguration Media Type

1..n

optional

The collection of List of VMNetworkConfiguration Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

Storage Entities

Datastore Media Type

This class is identified by media type:  application/vnd.abiquo.datastore+json; version=3.10; application/vnd.abiquo.datastore+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

datastoreUUID

String

1

yes

Unique identifier of the physical datastore

directory

String

1

optional

Direcotry of the datastore

enabled

boolean

1

yes

Indicates if the datastore is enabled to be used or not

id

Integer

1

no

Identifier of the datastore

name

String

1

yes

Name of the datastore

rootPath

String

1

yes

Path to the root of the datastore

size

long

1

yes

Size of the datastore

usedSize

long

1

yes

Used size of the datastore

Datastores Media Type

This class is identified by media type:  application/vnd.abiquo.datastores+json; version=3.10; application/vnd.abiquo.datastores+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Datastore Media Type

1..n

optional

The collection of List of Datastore Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Datastore Tier Media Type

This class is identified by the mediatype:  application/vnd.abiquo.datastoretier+json; version=3.10; application/vnd.abiquo.datastoretier+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the datastore tier. Use the same name in different location for accounting/billing of the same tier across different locations

description

String

1

optional 

Description of the datastore tier

enabled

boolean

1

yes

True if the tier is enabled for use

defaultAllowed

boolean

1

yes

If the tier is "default allowed", it will be allowed by default for new enterprises

storageAllocationPolicy

StorageAllocationPolicy

1

yes

Storage allocation policy to use for this tier, either progressive or performance. See Storage Pool Allocation

defaultForDatacenter

boolean

1

yes

True if the tier is the default for the datacenter. Note that there is an order of priority for default values. See user documentation of Datastore tiers

DatastoreTiers Media Type

This class is identified by media type:  application/vnd.abiquo.datastoretiers+json; version=3.10; application/vnd.abiquo.datastoretiers+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of DatastoreTier Media Type

1..n

optional

The collection of List of DatastoreTier Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

DiskManagement Media Type

This class is identified by media type:  application/vnd.abiquo.harddisk+json; version=3.10; application/vnd.abiquo.harddisk+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

idInteger1noThe ID of the entity
labelString1optionalThe friendly name of the hard disk

sequence

Integer

1

optional

Sequence number of the disk in a virtual machine

sizeInMb

Long

1

yes

Disk size in MegaBytes

diskFormatTypeString1optionalDisk format
pathString1noPath on storage device
diskFileSizeLong1noSize of deployed disk in megabytes
diskControllerTypeDiskControllerType1optionalDisk controller. Possible values are: SCSI, IDE or VIRTIO
diskControllerString1optionalController of the disk when attaching to a SCSI controller

bus

Integer

1

read only

Bus identifier for hard disk attachment. Cannot be specified in the request, only read once the virtualmachine is deployed in the hypervisor  

unit

Integer

1

read only

Unit identifier on the bus for hard disk attachment. C annot be specified in the request, only read once the virtualmachine is deployed in the hypervisor  

bootable

Boolean

1

yes

Specify if the disk is suitable to boot (it is possible to define it as virtualmachine with sequence 0 - (disk0 link))

uuidString1read onlyUnique universal identifier of the hard disk. This is the name of the disk in the target storage device that can be presented as the serial number in the guest OS

 

DisksManagement Media Type

This class is identified by media type:  application/vnd.abiquo.harddisks+json; version=3.10; application/vnd.abiquo.harddisks+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of DiskManagement Media TypeDiskManagement Media Type

1..n

optional

The collection of List of DiskManagement Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

DvdManagement Media Type

This class is identified by media type:  application/vnd.abiquo.dvd+json; version=3.10; application/vnd.abiquo.dvd+xml; version=3.10; 

 
InitiatorMapping Media Type

This class is identified by media type:  application/vnd.abiquo.initiatormapping+json; version=3.10; application/vnd.abiquo.initiatormapping+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

initiatorIqn

String

1

yes

IQN of the iSCSI initiator

targetIqn

String

1

yes

IQN of iSCSI the target

targetLun

Integer

1

yes

LUN in the iSCSI the target accessible by the initiator

InitiatorMappings Media Type

This class is identified by media type:  application/vnd.abiquo.initiatormappings+json; version=3.10; application/vnd.abiquo.initiatormappings+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of InitiatorMapping Media Type

1..n

optional

The collection of List of InitiatorMapping Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

StorageDevice Media Type

This class is identified by media type:  application/vnd.abiquo.storagedevice+json; version=3.10; application/vnd.abiquo.storagedevice+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

serviceIp

String

1

yes

Service IP (e.g. iSCSI IP) of the storage device, used by the hypervisors to connect to the device

servicePort

int

1

yes

Service port (e.g. iSCSI port) of the storage device, used by the hypervisors to connect to the device

managementIp

String

1

yes

Management IP of the storage device, used to connect to the management API

managementPort

int

1

yes

Management port of the storage device, used to connect to the management API

name

String

1

yes

Name of the storage device

password

String

1

optional

Password to connect to the management API, if any

storageTechnology

String

1

yes

Technology type of the storage device

username

String

1

optional

Username to connect to the management API, if any

 

StorageDevices Media Type

This class is identified by media type:  application/vnd.abiquo.storagedevices+json; version=3.10; application/vnd.abiquo.storagedevices+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of StorageDevice Media Type

1..n

optional

The collection of List of StorageDevice Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

StorageDeviceMetadata Media Type

This class is identified by media type:  application/vnd.abiquo.storagedevice+json; version=3.10; application/vnd.abiquo.storagedevice+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

defaultServicePort

int

1

no

The default ser

defaultManagementPort

int

1

no

The default port of the management API of the device

requiresAuthentication

boolean

1

no

Boolean indicating if the storage device requires authentication

type

String

1

no

The storage technology type of the storage device

StorageDevicesMetadata Media Type

This class is identified by media type:  application/vnd.abiquo.storagedevicesmetadata+json; version=3.10; application/vnd.abiquo.storagedevicesmetadata+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of StorageDeviceMetadata Media Type

1..n

optional

The collection of List of StorageDeviceMetadata Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

StoragePool Media Type

This class is identified by media type:  application/vnd.abiquo.storagepool+json; version=3.10; application/vnd.abiquo.storagepool+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

availableSizeInMb

long

1

yes

Available size in MB of the storage pool.

enabled

boolean

1

no

Returns true if the storage pool is enabled, false otherwise.

idStorage

String

1

optional

Identifier of the entity.

maxVolumesInteger1optionalMaximum number of volumes to create on NFS storage

name

String

1

yes

Name of the storage pool.

totalSizeInMb

long

1

yes

Total size in MB of the storage pool.

typeString1yesUsed to differentiate iSCSI and NFS storage pools
usablePercentInteger1optionalPerccentage of the NFS storage pool that can be used to create volumes

usedSizeInMb

long

1

yes

 

 

 

StoragePools Media Type

This class is identified by media type:  application/vnd.abiquo.storagepools+json; version=3.10; application/vnd.abiquo.storagepools+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of StoragePool Media Type

1..n

optional

The collection of List of StoragePool Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

StoragePoolWithDevice Media Type

This class is identified by media type:  application/vnd.abiquo.storagepoolwithdevicedto+json; version=3.10; application/vnd.abiquo.storagepoolwithdevicedto+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

availableSizeInMb

long

1

yes

Available size in MB of the storage pool.

device

StorageDevice Media Type

1

optional

Device where the storage pool belongs to.

enabled

boolean

1

no

Returns true if the storage pool is enabled, false otherwise.

idStorage

String

1

optional

Identifier of the entity.

maxVolumesInteger1optionalMaximum number of volumes to create on NFS storage

name

String

1

yes

Name of the storage pool.

totalSizeInMb

long

1

yes

Total size in MB of the storage pool.

typeString1yesUsed to differentiate iSCSI and NFS storage pools
usablePercentInteger1optionalPerccentage of the NFS storage pool that can be used to create volumes

usedSizeInMb

long

1

yes

Used size in MB of the storage pool.

 

StoragePoolsWithDevice Media Type

This class is identified by media type:  application/vnd.abiquo.storagepoolswithdevice+json; version=3.10; application/vnd.abiquo.storagepoolswithdevice+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of StoragePoolWithDevice Media Type

1..n

optional

The collection of List of StoragePoolWithDevice Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

StoragePoolWithTier Media Type

This class is identified by media type:  application/vnd.abiquo.storagepoolwithtier+json; version=3.10; application/vnd.abiquo.storagepoolwithtier+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

availableSizeInMb

long

1

yes

Available size in MB of the storage pool.

enabled

boolean

1

no

Returns true if the storage pool is enabled, false otherwise.

idStorage

String

1

optional

Identifier of the entity.

name

String

1

yes

Name of the storage pool.

tier

Tier Media Type

1

yes

Tier where the storage pool belongs to.

totalSizeInMb

long

1

yes

Total size in MB of the storage pool.

usedSizeInMb

long

1

yes

Used size in MB of the storage pool.

 

StoragePoolsWithTier Media Type

This class is identified by media type:  application/vnd.abiquo.storagepoolswithtier+json; version=3.10; application/vnd.abiquo.storagepoolswithtier+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of StoragePoolWithTier Media Type

1..n

optional

The collection of List of StoragePoolWithTier Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Tier Media Type

This class is identified by media type:  application/vnd.abiquo.tier+json; version=3.10; application/vnd.abiquo.tier+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

defaultAllowed

boolean

1

yes

If tier is default allowed, it will be allowed by default for new enterprises

description

String

1

optional

Description of the tier

enabled

boolean

1

yes

True if the tier is enabled, false otherwise

id

Integer

1

optional

Identifier of the tier

name

String

1

yes

Name of the tier

storageAllocationPolicyString1yesStorage allocation policy for the tier: PROGRESSIVE or PERFORMANCE. Default is progressive
Tiers Media Type

This class is identified by media type:  application/vnd.abiquo.tiers+json; version=3.10; application/vnd.abiquo.tiers+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Tier Media Type

1..n

optional

The collection of List of Tier Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VolumeManagement Media Type

This class is identified by media type:  application/vnd.abiquo.volume+json; version=3.10; application/vnd.abiquo.volume+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

allowResize

boolean

1

no

The API sets this value depending on the capacities of the storage device and support for it on the platform.

If the volume can be resized, it is "true", otherwise it is "false"

bootableboolean1yesIf true, the volume is registered in the platform as a disk that can be used to boot the VM
busInteger1noBus identifier for volume attachment. Cannot be specified in the request, only read once the virtualmachine is deployed in the hypervisor  
connectionString1optional

Address for the volume in the target device. This field is required when creating generic persistent volumes on NFS storage

description

String

1

optional

Description of the volume

diskControllerString1yesDisk controller for SCSI controllers: e.g. lsilogic. The default value is lsilogic
diskControllerTypeDiskControllerType1yesDisk controller type. Possible values: IDE, SCSI, VIRTIO

id

Integer

1

optional

Identifier of the entity

idImage

Integer

1

no

Returns the identifier of the image if the volume is persistent, returns null otherwise

idScsi

String

1

optional

iSCSI address for the volume in the target device. This Attribute is required when creating
generic iSCSI volumes

name

String

1

yes

Name of the volume

sequence

Integer

1

optional

The attachment order of this volume when attached to a virtual machine

sizeInMB

long

1

yes

Size in MB of the volume

state

String

1

no

State of the volume (attached/detached)

unitInteger1noUnit identifier on the bus for volume attachment. Cannot be specified in the request, only read once the virtualmachine is deployed in the hypervisor  

uuid

String

1

no

Unique universal identifier of the volume. This is the name of the volume in the target
storage device

VolumesManagement Media Type

This class is identified by media type:  application/vnd.abiquo.iscsivolumes+json; version=3.10; application/vnd.abiquo.iscsivolumes+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VolumeManagement Media Type

1..n

optional

The collection of List of VolumeManagement Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

VolumeManagementWithVirtualMachine Media Type

This class is identified by media type:  application/vnd.abiquo.volumewithvirtualmachine+json; version=3.10; application/vnd.abiquo.volumewithvirtualmachine+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

allowResize

boolean

1

no

The API sets this value depending on the capacities of the storage device and support for it on the platform.

If the volume can be resized, it is "true", otherwise it is "false"

bootableboolean1yesIf true, the volume is registered in the platform as a disk that can be used to boot the VM
busInteger1noBus identifier for volume attachment. Cannot be specified in the request, only read once the virtualmachine is deployed in the hypervisor  
connectionString1optional

Address for the volume in the target device. This field is required when creating generic persistent volumes on NFS storage

description

String

1

optional

Description of the volume

diskControllerString1yesDisk controller for SCSI controllers: e.g. lsilogic. The default value is lsilogic
diskControllerTypeDiskControllerType1yesDisk controller type. Possible values: IDE, SCSI, VIRTIO

id

Integer

1

optional

Identifier of the entity

idImage

Integer

1

no

Returns the identifier of the image if the volume is persistent, returns null otherwise

idScsi

String

1

optional

iSCSI address for the volume in the target device. This Attribute is required when creating
generic iSCSI volumes

name

String

1

yes

Name of the volume

sequence

Integer

1

optional

The attachment order of this volume when attached to a virtual machine

sizeInMB

long

1

yes

Size in MB of the volume

state

String

1

no

State of the volume (attached/detached)

unitInteger1noUnit identifier on the bus for volume attachment. Cannot be specified in the request, only read once the virtualmachine is deployed in the hypervisor  

uuid

String

1

no

Unique universal identifier of the volume. This is the name of the volume in the target
storage device

virtualDatacenterWithDatacenter

VirtualDatacenterWithDatacenter Media Type

1

no

Virtual datacenter where the volume is created in, also containing the datacenter where the
virtual datacenter belongs to

virtualAppliance

VirtualAppliance Media Type

1

no

Virtual appliance of the virtual machine where the volume is attached to

virtualMachine

VirtualMachine Media Type

1

no

Virtual machine where the volume is attached to

storagePoolWithDevice

StoragePoolWithDevice Media Type

1

no

Storage pool where the volume is created in, also containing the device where the storage
pool belongs to

 

VolumesManagementWithVirtualMachine Media Type

This class is identified by media type:  application/vnd.abiquo.iscsivolumeswithvirtualmachine+json; version=3.10; application/vnd.abiquo.iscsivolumeswithvirtualmachine+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VolumeManagementWithVirtualMachine Media Type

1..n

optional

The collection of List of VolumeManagementWithVirtualMachine Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

Pricing Entities

CostCode Media Type

This class is identified by media type:  application/vnd.abiquo.costcode+json; version=3.10; application/vnd.abiquo.costcode+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

currencyPricesList of Link to Currency Media Type and price1..noptionalPrices for the cost code in different currencies

description

String

1

yes

Description of the cost code

name

String

1

yes

The name of the cost code

 

CostCodes Media Type

This class is identified by media type:  application/vnd.abiquo.costcodes+json; version=3.10; application/vnd.abiquo.costcodes+xml; version=3.10;  

Attribute

Type

Occurs

Input Required

Description

collection

List of CostCode Media Type

1..n

optional

The collection of List of CostCode Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

CostCodeCurrency Media Type

This class is identified by media type:  application/vnd.abiquo.costcodecurrency+json; version=3.10; application/vnd.abiquo.costcodecurrency+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

price

BigDecimal

1

yes

The price in the currency given in this row

CostCodeCurrencies Media Type

This class is identified by media type:  application/vnd.abiquo.costcodecurrencies+json; version=3.10; application/vnd.abiquo.costcodecurrencies+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of CostCodeCurrency Media Type

1..n

optional

The collection of List of CostCodeCurrency Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Currency Media Type

This class is identified by media type:  application/vnd.abiquo.currency+json; version=3.10; application/vnd.abiquo.currency+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

digits

int

1

yes

Number of digits after the decimal point

name

String

1

yes

Unique name of the currency and the currency symbol, for example Dollar - $

symbol

String

1

yes

Standard currency code, for example USD

Currencies Media Type

This class is identified by media type:  application/vnd.abiquo.currencies+json; version=3.10; application/vnd.abiquo.currencies+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Currency Media Type

1..n

optional

The collection of List of Currency Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

PricingCostCode Media Type

This class is identified by media type:  application/vnd.abiquo.pricingcostcode+json; version=3.10; application/vnd.abiquo.pricingcostcode+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

price

BigDecimal

1

yes

The price set for this cost code in this pricing model

PricingCostCodes Media Type

This class is identified by media type: application/vnd.abiquo.pricingcostcodes+json; version=3.10; application/vnd.abiquo.pricingcostcodes+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of PricingCostCode Media Type

1..n

optional

The collection of List of PricingCostCode Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

PricingTemplate Media Type

Contains links to:

  • Currency
  • Scope
  • Edit

This class is identified by media type:  application/vnd.abiquo.pricingtemplate+json; version=3.10; application/vnd.abiquo.pricingtemplate+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

chargingPeriod

Integer

1

yes

Indicates the period of time to charge the user

defaultTemplate

boolean

1

optional

 

deployMessageString1optionalThe pricing estimate message

description

String

1

yes

Description of the pricing template

id

Integer

1

no

Identifier of the entity

lastUpdate

Date

1

no

Indicates the last modification

lastPriceUpdateDate1no

Indicates the last modification of the price of a pricing template

minimumCharge

Integer

1

yes

Indicates the minimum period of time that a user will be charged for

minimumChargePeriod

BigDecimal

1

yes

Minimum charge per Minimum Period

name

String

1

yes

The name of the pricing model

pricingAbstractDatacenterslist of #PricingAbstractDatacenter1..nyesPrices per datacenter
pricingCostCodesList of link to costcode
and BigDecimal price
1..nyesCost codes and prices

showChangesBefore

boolean

1

yes

Indicates if show the charges before deployment

showMinimumCharge

boolean

1

optional

 

standingChargePeriod

BigDecimal

1

yes

Standing charge per charging period

PricingAbstractDatacenter

Used in the pricingtemplate media type.

It contains a link to the datacenter that it applies to

Attribute

Type

Occurs

Input Required

Description

firewallBigDecimal1yesPrice of firewall

hdGB

BigDecimal

1

yes

Price of hypervisor datastores per gigabyte

layer

BigDecimal

1

yes

Price of using antiaffinity capacity

loadBalancer    

memoryGB

BigDecimal

1

yes

Price of memory per gigabyte

memoryOnGB

BigDecimal

1

yes

Price of memory per gigabyte with VM on

memoryOffGB

BigDecimal

1

yes

Price of memory per gigabyte with VM off

minimumCharge

Integer

1

yes

Indicates the minimum period of time that a user will be charged for

minimumChargePeriod

BigDecimal

1

yes

Minimum charge per Minimum Period

pricingTiersList of link to external storage tier
and BigDecimal price
1..nyesExternal storage tier prices
pricingDatastoreTiersList of link to datastoretier
and BigDecimal price
1..nyesDatastore tier prices

publicIp

BigDecimal

1

yes

Price per public IP address

repositoryGBBigDecimal1yesPrice of template Repository in GB (not including conversions)

vcpu

BigDecimal

1

yes

Price of CPU cores

vcpuOn

BigDecimal

1

yes

Price of CPU cores with VM on

vcpuOff

BigDecimal

1

yes

Price of CPU cores with VM off

vlan

BigDecimal

1

yes

Price per VLAN


PricingTemplates Media Type

This class is identified by media type:  application/vnd.abiquo.pricingtemplates+json; version=3.10; application/vnd.abiquo.pricingtemplates+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of PricingTemplate Media Type

1..n

optional

The collection of List of PricingTemplate Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Scheduler Entities

EnterpriseExclusionRule Media Type

This class is identified by media type:  application/vnd.abiquo.enterpriseexclusionrule+json; version=3.10; application/vnd.abiquo.enterpriseexclusionrule+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the entity

Also contains links to the two enterprises that will be blocked from using the same server:

<link rel="enterprise" href="http://example.com/api/admin/enterprises/{enterpriseId}"  title="enterprise1"/>
<link rel="enterprise" href="http://example.com/api/admin/enterprises/{enterpriseId}"  title="enterprise2"/>

 

EnterpriseExclusions Media Type

This class is identified by media type:  application/vnd.abiquo.enterpriseexclusionrules+json; version=3.10; application/vnd.abiquo.enterpriseexclusionrules+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of EnterpriseExclusionRule Media Type

1..n

optional

The collection of List of EnterpriseExclusionRule Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

FitPolicyRule Media Type

This class is identified by media type:  application/vnd.abiquo.fitpolicyrule+json; version=3.10; application/vnd.abiquo.fitpolicyrule+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

fitPolicy

FitPolicy

1

yes

Fit Policy possible values : PERFORMANCE or PROGRESSIVE"

id

Integer

1

optional

Identifier of the entity

FitPolicyRules Media Type

This class is identified by media type:  application/vnd.abiquo.fitpolicyrules+json; version=3.10; application/vnd.abiquo.fitpolicyrules+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of FitPolicyRule Media Type

1..n

optional

The collection of List of FitPolicyRule Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

DatastoreLoadRule Media Type

This class is identified by media type:  application/vnd.abiquo.datastoreloadrule+json; version=3.10; application/vnd.abiquo.datastoreloadrule+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

storageLoadPercentage

Integer

1

optional

datastore storage percentage

Send a link to the entity that you wish to create the rule for: datacenter, datastore tier or datastore. 

DatastoreLoadRules Media Type

This class is identified by media type:  application/vnd.abiquo.datastoreloadrules+json; version=3.10; application/vnd.abiquo.datastoreloadrules+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of DatastoreLoadRule Media Type

1..n

optional

The collection of List of DatastoreLoadRule Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

MachineLoadRule Media Type

This class is identified by media type:  application/vnd.abiquo.machineloadrule+json; version=3.10; application/vnd.abiquo.machineloadrule+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

cpuLoadPercentage

Integer

1

optional

cpu percentage

id

Integer

1

optional

Identifier of the entity

ramLoadPercentage

Integer

1

optional

ram percentage

aggregatedBoolean1optionalIf true, the machine rule applies to the sum of the resources of the group of machines affected by the rule
MachineLoadRules Media Type

This class is identified by media type:  application/vnd.abiquo.machineloadrules+json; version=3.10; application/vnd.abiquo.machineloadrules+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of MachineLoadRule Media Type

1..n

optional

The collection of List of MachineLoadRule Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Rules Media Type

This class is identified by media type:  application/vnd.abiquo.rules+json; version=3.10; application/vnd.abiquo.rules+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

enterpriseExclusionRules

EnterpriseExclusionsRules Media Type

1

optional

 

fitPolicyRules

FitPolicyRules Media Type

1

optional

 

machineLoadRules

MachineLoadRules Media Type

1

optional

 
datastoreLoadRules#DatastoreLoadRules Media Type1optional 

Statistics Entities

CloudUsage Media Type

This class is identified by media type:  application/vnd.abiquo.cloudusage+json; version=3.10; application/vnd.abiquo.cloudusage+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the Entity

numEnterprisesCreated

long

1

no

Total number of enterprises in system

numUsersCreated

long

1

no

Total number of users in system

numVdcCreated

long

1

no

Total number of Virtual DataCenters in system

publicIPsReserved

long

1

no

Total number of IPs assigned to a VirtualDatacenter (Reserved)

publicIPsTotal

long

1

no

Total number of IPs defined (managed)

publicIPsUsed

long

1

no

Total number of IPs used by virtual machines

serversRunning

long

1

no

Total number of Physical Machines running currently

serversTotal

long

1

no

Total number of Physical machines managed

storageReservedInMb

long

1

no

External storage reserved by Enterprises in Datacenters (in Megabytes)

storageReserved

long

1

no

External storage reserved by Enterprises in Datacenters

storageTotalInMb

long

1

no

External storage managed by Abiquo (in Megabytes)

storageTotal

long

1

no

External storage managed by Abiquo

storageUsedInMb

long

1

no

External storage used (attached or mounted) by any virtual machines (in Megabytes)

storageUsed

long

1

no

External storage used (attached or mounted) by any virtual machines

virtualCpuReserved

long

1

no

Maximum number of Virtual CPUs reserved by all enterprises

virtualCpuTotal

long

1

no

Total number of Virtual CPUs managed available for virtual machines

virtualCpuUsed

long

1

no

Number of Virtual CPUs used in Virtual Machines currently in a running state

virtualMachinesRunning

long

1

no

Total number of Virtual Machines currently in a running state

virtualMachinesTotal

long

1

no

Total number of Virtual Machines managed

virtualMemoryReservedInMb

long

1

no

Maximum amount of RAM reserved by all enterprises in Megabytes

virtualMemoryReserved

long

1

no

Maximum amount of RAM reserved by all enterprises

virtualMemoryTotalInMb

long

1

no

Total amount of RAM managed (can be used for VMs) in Megabytes

virtualMemoryTotal

long

1

no

Total amount of RAM managed (can be used for VMs)

virtualMemoryUsedInMb

long

1

no

Total amount of RAM used by Virtual Machines currently in a running state in Megabytes

virtualMemoryUsed

long

1

no

Total amount of RAM used by Virtual Machines currently in a running state

virtualStorageReservedInMb

long

1

no

Maximum storage size reserved by all enterprises for Virtual Machines in Megabytes

virtualStorageReserved

long

1

no

Maximum storage size reserved by all enterprises for Virtual Machines

virtualStorageTotalInMb

long

1

no

Total storage size managed to be used by Virtual Machines in Megabytes

virtualStorageTotal

long

1

no

Total storage size managed to be used by Virtual Machines

virtualStorageUsedInMb

long

1

no

Total storage size used by Virtual Machines currently in a running state in Megabytes

virtualStorageUsed

long

1

no

Total storage size used by Virtual Machines currently in a running state

vlanUsed

long

1

no

Total number of VLANs in use by any datacenter managed

repositoryUsedInMb

long

1

no

Total repository used by virtual machine templates not including conversions in Megabytes

repositoryUsed

long

1

no

Total repository used by virtual machine templates not including conversions

repositoryReservedInMb

long

1

no

Total repository reserved by all enterprises in Megabytes

repositoryReserved

long

1

no

Total repository reserved by all enterprises

CloudUsages Media Type

This class is identified by media type:  application/vnd.abiquo.cloudusages+json; version=3.10; application/vnd.abiquo.cloudusages+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of CloudUsage Media Type

1..n

optional

The collection of List of CloudUsage Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

EnterpriseResources Media Type

This class is identified by media type:  application/vnd.abiquo.enterpriseresources+json; version=3.10; application/vnd.abiquo.enterpriseresources+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the Entity

extStorageReservedInMb

long

1

no

Maximum external storage size reserved for this enterprise in Megabytes

extStorageReserved

long

1

no

Maximum external storage size reserved for this enterprise

extStorageUsedInMb

long

1

no

Storage in external storage volumes used (attached or mounted) by any virtual machines (in
Megabytes)

extStorageUsed

long

1

no

Storage in external storage volumes used (attached or mounted) by any virtual machines

localStorageReservedInMb

long

1

no

Maximum storage size reserved for this enterprise for Virtual Machines in Megabytes

localStorageReserved

long

1

no

Maximum storage size reserved for this enterprise for Virtual Machines

localStorageUsedInMb

long

1

no

Total storage size used by Virtual Machines currently in a running state in Megabytes

localStorageUsed

long

1

no

Total storage size used by Virtual Machines currently in a running state

memoryReservedInMb

long

1

no

Maximum amount of RAM reserved for this enterprise in Megabytes

memoryReserved

long

1

no

Maximum amount of RAM reserved for this enterprise

memoryUsedInMb

long

1

no

Total amount of RAM used by Virtual Machines currently in a running state in Megabytes

memoryUsed

long

1

no

Total amount of RAM used by Virtual Machines currently in a running state

publicIPsLimit

long

1

optional

Limit of public IPs for this enterprise

publicIPsReserved

long

1

no

Total number of IPs assigned to a VirtualDatacenter (Reserved)

publicIPsUsed

long

1

no

Total number of IPs used by virtual machines

repositoryReservedInMb

long

1

no

Maximum repository size reserved for this enterprise in Megabytes

repositoryReserved

long

1

no

Maximum repository size reserved for this enterprise

repositoryUsedInMb

long

1

no

Total repository size currently used for this enterprise in Megabytes

repositoryUsed

long

1

no

Total repository size currently used for this enterprise

virtualCpuReserved

long

1

no

Maximum number of Virtual CPUs reserved for this enterprise

virtualCpuUsed

long

1

no

Total number of Virtual CPUs in Virtual Machines currently in a running state

vlanReserved

long

1

no

Total maximum number of VLANs reserved for this enterprise. (enterprise.vlanHard)

vlanUsed

long

1

no

Total number of VLANs in use by any datacenter managed

EnterprisesResources Media Type

This class is identified by media type:  application/vnd.abiquo.enterprisesresources+json; version=3.10; application/vnd.abiquo.enterprisesresources+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of EnterpriseResources Media Type

1..n

optional

The collection of List of EnterpriseResources Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VirtualAppResources Media Type

This class is identified by media type:  application/vnd.abiquo.virtualappresources+json; version=3.10; application/vnd.abiquo.virtualappresources+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the virtual machine template definition.

idEnterprise

int

1

no

The id enterprise.

idVirtualDataCenter

int

1

no

The id virtual data center.

vappName

String

1

no

Name for this virtual appliance.

vdcName

String

1

no

Name for the virtualdatacenter.

vmActive

int

1

no

Number of virtual machines currently running in this virtual appliance.

vmCreated

int

1

no

Number of virtual machines created in this virtual appliance.

volAttached

int

1

no

Number of volumes currently attached to a virtual machine in this virtual appliance.

 

VirtualAppsResources Media Type

This class is identified by media type:  application/vnd.abiquo.virtualappsresources+json; version=3.10; application/vnd.abiquo.virtualappsresources+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualAppResources Media Type

1..n

no

The collection of List of VirtualAppResources Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

VirtualDatacenterResources Media Type

This class is identified by media type:  application/vnd.abiquo.virtualdatacenterresources+json; version=3.10; application/vnd.abiquo.virtualdatacenterresources+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the virtual datacenter

extStorageReservedInMb

long

1

no

Maximum external storage size reserved for this enterprise in this virtual datacenter in
Megabytes.

extStorageReserved

long

1

no

Maximum external storage size reserved for this enterprise in this virtual datacenter

extStorageUsedInMb

long

1

no

External storage used (attached or mounted) by any virtual machines (in Megabytes).

extStorageUsed

long

1

no

External storage used (attached or mounted) by any virtual machines

idEnterprise

int

1

no

The id enterprise.

localStorageReservedInMb

long

1

no

Maximum storage size reserved for this enterprise in this virtual datacenter for Virtual
Machines in Megabytes.

localStorageReserved

long

1

no

Maximum storage size reserved for this enterprise in this virtual datacenter for Virtual
Machines

localStorageUsedInMb

long

1

no

Total storage size used by Virtual Machines currently in a running state in Megabytes.

localStorageUsed

long

1

no

Total storage size used by Virtual Machines currently in a running state

memoryReservedInMb

long

1

no

Maximum amount of RAM reserved for this enterprise in this virtual datacenter in Megabytes.

memoryReserved

long

1

no

Maximum amount of RAM reserved for this enterprise in this virtual datacenter

memoryUsedInMb

long

1

no

Total amount of RAM used by Virtual Machines currently in a running state in Megabytes.

memoryUsed

long

1

no

Total amount of RAM used by Virtual Machines currently in a running state

publicIPsReserved

long

1

no

Total number of IPs assigned to this virtualDatacenter (Reserved).

publicIPsUsed

long

1

no

Total number of IPs used by virtual machines.

vdcName

String

1

no

virtual datacenter's name.

virtualCpuReserved

long

1

no

The virtual cpu reserved.

virtualCpuUsed

long

1

no

Total number of Virtual CPUs in Virtual Machines currently in a running state.

vlanReserved

long

1

no

Total maximum number of VLANs reserved for this enterprise in this virtual datacenter.
(enterprise.vlanHard)

vlanUsed

long

1

no

Total number of VLANs in use by this virtual datacenter.

vmActive

int

1

no

Number of virtual machines currently running in this virtual datacenter.

vmCreated

int

1

no

Number of virtual machines created in this virtual datacenter.

volAttached

int

1

no

Number of volumes currently attached to a virtual machine in this virtual datacenter.

volCreated

int

1

no

Number of volumes created in this virtual datacenter.

VirtualDatacentersResources Media Type

This class is identified by media type:  application/vnd.abiquo.virtualdatacentersresources+json; version=3.10; application/vnd.abiquo.virtualdatacentersresources+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualDatacenterResources Media Type

1..n

optional

The collection of List of VirtualDatacenterResources Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

Task Entities

Job Media Type

This class is identified by media type:  application/vnd.abiquo.job+json; version=3.10; application/vnd.abiquo.job+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

creationTimestamp

Long

1

yes

Creation timestamp in standard UNIX timestamp

description

String

1

no

Description of the job

id

String

1

yes

Identifier of the job

parentTaskId

String

1

no

Identifier of the parent task

rollbackState

JobState

1

no

Current rollback state of the job

state

JobState

1

no

Current state of the job

timestamp

Long

1

yes

Timestamp of the last update on the job in standard UNIX timestamp

type

JobType

1

yes

Type of the job

 

Jobs Media Type

This class is identified by media type:  application/vnd.abiquo.jobs+json; version=3.10; application/vnd.abiquo.jobs+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Job Media Type

1..n

no

The collection of List of Job Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

JobExtended Media Type

This class is identified by media type:  application/vnd.abiquo.jobextended+json; version=3.10; application/vnd.abiquo.jobextended+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

creationTimestamp

Long

1

yes

Creation timestamp in standard UNIX timestamp

description

String

1

no

Description of the job

errorCause

String

1

optional

 

id

String

1

yes

Identifier of the job

parentTaskId

String

1

no

Identifier of the parent task

progress

Integer

1

optional

 

rollbackState

JobState

1

no

Current rollback state of the job

state

JobState

1

no

Current state of the job

timestamp

Long

1

yes

Timestamp of the last update on the job in standard UNIX timestamp

type

JobType

1

yes

Type of the job

guestInitialPasswordString1no3.10.5+ Attribute returned in API response from deploy. if deploy task finishes successfully and user requesting the task is the VM owner

 

JobsExtended Media Type

This class is identified by media type:  application/vnd.abiquo.jobsextended+json; version=3.10; application/vnd.abiquo.jobsextended+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of JobExtended Media Type

1..n

no

The collection of List of JobExtended Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

Task Media Type

This class is identified by media type:  application/vnd.abiquo.task+json; version=3.10; application/vnd.abiquo.task+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

creationTimestamp

Long

1

yes

Creation timestamp in standard UNIX timestamp

jobs

Jobs Media Type

1

no

Jobs collection of the task

ownerId

String

1

yes

Identifier of the task owner

state

TaskState

1

yes

Current state of the task

taskId

String

1

yes

Identifier of the task

timestamp

long

1

yes

Timestamp of the last update on the task in standard UNIX timestamp

type

TaskType

1

yes

Type of the task

userId

String

1

no

Identifier of the user who created the task

 

Tasks Media Type

This class is identified by media type:  application/vnd.abiquo.tasks+json; version=3.10; application/vnd.abiquo.tasks+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Task Media Type

1..n

no

The collection of List of Task Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

 

TaskExtended Media Type

This class is identified by media type:  application/vnd.abiquo.taskextended+json; version=3.10; application/vnd.abiquo.taskextended+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

creationTimestamp

Long

1

yes

Creation timestamp in standard UNIX timestamp

jobs

Jobs Media Type

1

no

Jobs collection of the task

jobsExtended

JobsExtended Media Type

1

no

Extended jobs collection of the task

ownerId

String

1

yes

Identifier of the task owner

state

TaskState

1

yes

Current state of the task

taskId

String

1

yes

Identifier of the task

timestamp

long

1

yes

Timestamp of the last update on the task in standard UNIX timestamp

type

TaskType

1

yes

Type of the task

userId

String

1

no

Identifier of the user who created the task

 

User Enterprise Entities

Credentials Media Type

This class is identified by media type:  application/vnd.abiquo.publiccloudcredentials+json; version=3.10; application/vnd.abiquo.publiccloudcredentials+xml; version=3.10;  

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the credentials

access

String

1

yes

Access identifier of the credentials

key

String

1

yes

Key for the credentials

DatacenterLimits Media Type

This class is identified by media type:  application/vnd.abiquo.limit+json; version=3.10; application/vnd.abiquo.limit+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

cpuCountHardLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Hard limit

cpuCountSoftLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Soft limit

hdHardLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Hard limit

hdSoftLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Soft limit

id

Integer

1

optional

Identifier of the limit

publicIpsHard

long

1

yes

Total amount of Public IPs that may be defined. Hard limit

publicIpsSoft

long

1

yes

Total amount of Public IPs that may be defined. Soft limit

ramHardLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Hard limit

ramSoftLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Soft limit

repositoryHardLimitsInMb

long

1

yes

Total size of repository space to be used. Hard limit

repositorySoftLimitsInMb

long

1

yes

Total size of repository space to be used. Soft limit

storageHard

long

1

yes

Total size of external storage that may be assigned. Hard limit

storageSoft

long

1

yes

Total size of external storage that may be assigned. Soft limit

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

DatacentersLimits Media Type

This class is identified by media type:  application/vnd.abiquo.datacenterlimits+json; version=3.10; application/vnd.abiquo.datacenterlimits+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of DatacenterLimits Media Type

1..n

optional

The collection of List of DatacenterLimits Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Enterprise Media Type

This class is identified by media type:  application/vnd.abiquo.enterprise+json; version=3.10; application/vnd.abiquo.enterprise+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

chefClient

String

1

no

This must be a Chef admin client on the chef server. The Abiquo Server will use it to work
with the Chef Server

chefClientCertificate

String

1

no

The admin client certificate, which may be stored in a file called adminclient.pem

chefURL

String

1

no

URL of the Chef Server containing recipes

chefValidator

String

1

no

The validator client is used to create nodes. You must use the name of the validator client
on the chef server

chefValidatorCertificate

String

1

no

The validator certificate, which may be stored in a file called organization-validator or
validation.pem

cpuCountHardLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Hard limit

cpuCountSoftLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Soft limit

hdHardLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Hard limit

hdSoftLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Soft limit

id

Integer

1

no

Identifier of the Entity

idPricingTemplate

Integer

1

no

Identifier for the pricing template associated to this enterprise

isReservationRestricted

boolean

1

no

You can also restrict an enterprise so that it may only deploy virtual machines on the
physical machines reserved for it and not on any others

name

String

1

yes

The name of the Enterprise

publicIpsHard

long

1

yes

Total amount of Public IPs that may be defined. Hard limit

publicIpsSoft

long

1

yes

Total amount of Public IPs that may be defined. Soft limit

ramHardLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Hard limit

ramSoftLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Soft limit

repositoryHard

long

1

yes

Hard limit established for repository size

repositorySoft

long

1

yes

Soft limit stablished for repository size

storageHard

long

1

yes

Total size of external storage that may be assigned. Hard limit

storageSoft

long

1

yes

Total size of external storage that may be assigned. Soft limit

twoFactorAuthenticationMandatoryboolean1yesWhether users of this tenant must use two-factor authentication or not

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

workflowboolean1yesWhether this tenant must use workflow or not
Enterprises Media Type

This class is identified by media type:  application/vnd.abiquo.enterprises+json; version=3.10; application/vnd.abiquo.enterprises+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of Enterprise Media Type

1..n

optional

The collection of List of Enterprise Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

EnterpriseIdName Media Type

This class is identified by media type:  application/vnd.abiquo.enterprise-id-name+json; version=3.10; application/vnd.abiquo.enterprise-id-name+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

cpuCountHardLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Hard limit

cpuCountSoftLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Soft limit

hdHardLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Hard limit

hdSoftLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Soft limit

id

Integer

1

no

Identifier of the Entity

name

String

1

no

Enterprise's name

publicIpsHard

long

1

yes

Total amount of Public IPs that may be defined. Hard limit

publicIpsSoft

long

1

yes

Total amount of Public IPs that may be defined. Soft limit

ramHardLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Hard limit

ramSoftLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Soft limit

storageHard

long

1

yes

Total size of external storage that may be assigned. Hard limit

storageSoft

long

1

yes

Total size of external storage that may be assigned. Soft limit

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

EnterprisesIdName Media Type

This class is identified by media type:  application/vnd.abiquo.enterprises-id-name+json; version=3.10; application/vnd.abiquo.enterprises-id-name+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of EnterpriseIdName Media Type

1..n

optional

The collection of List of EnterpriseIdName Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

EnterpriseProperties Media Type

This class is identified by media type:  application/vnd.abiquo.enterpriseproperties+json; version=3.10; application/vnd.abiquo.enterpriseproperties+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the Entity

properties

Map

1

no

Properties set for this enterprise

EnterpriseTheme Media Type

This class is identified by media type:  application/vnd.abiquo.enterprisetheme+json; version=3.10; application/vnd.abiquo.enterprisetheme+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

chefClient

String

1

no

This must be a Chef admin client on the chef server. The Abiquo Server will use it to work
with the Chef Server

chefClientCertificate

String

1

no

The admin client certificate, which may be stored in a file called adminclient.pem

chefURL

String

1

no

URL of the Chef Server containing recipes

chefValidator

String

1

no

The validator client is used to create nodes. You must use the name of the validator client
on the chef server

chefValidatorCertificate

String

1

no

The validator certificate, which may be stored in a file called organization-validator or
validation.pem

companyLogoPath

String

1

no

Custom theme's logo path (image)

cpuCountHardLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Hard limit

cpuCountSoftLimit

int

1

yes

Total amount of Virtual CPUs that may be used by Virtual Machines. Soft limit

hdHardLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Hard limit

hdSoftLimitInMb

long

1

yes

Total size of Hard Disks that may be used by Virtual Machines. Soft limit

id

Integer

1

no

Identifier of the Entity

idPricingTemplate

Integer

1

no

Identifier for the pricing template associated to this enterprise

isReservationRestricted

boolean

1

no

You can also restrict an enterprise so that it may only deploy virtual machines on the
physical machines reserved for it and not on any others

name

String

1

yes

The name of the Enterprise

publicIpsHard

long

1

yes

Total amount of Public IPs that may be defined. Hard limit

publicIpsSoft

long

1

yes

Total amount of Public IPs that may be defined. Soft limit

ramHardLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Hard limit

ramSoftLimitInMb

int

1

yes

Total amount of RAM memory that may be used by Virtual Machines. Soft limit

repositoryHard

long

1

yes

Hard limit established for repository size

repositorySoft

long

1

yes

Soft limit stablished for repository size

storageHard

long

1

yes

Total size of external storage that may be assigned. Hard limit

storageSoft

long

1

yes

Total size of external storage that may be assigned. Soft limit

theme

String

1

no

Custom theme's name

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

User Role and Scope and Privilege Entities

Privilege Media Type

This class is identified by media type:  application/vnd.abiquo.privilege+json; version=3.10; application/vnd.abiquo.privilege+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the privilege

name

String

1

yes

Name of the privilege

Privileges Media Type

This class is identified by media type:  application/vnd.abiquo.privileges+json; version=3.10; application/vnd.abiquo.privileges+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Privilege Media Type

1..n

optional

The collection of List of Privilege Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Role Media Type

This class is identified by media type:  application/vnd.abiquo.role+json; version=3.10; application/vnd.abiquo.role+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

blocked

boolean

1

no

This role is not editable or changeable. Used for Cloud Admin

id

Integer

1

no

Identifier for this role

idEnterprise

Integer

1

no

Identifier for the enterprise that the role belongs to. Leave empty for global (or system) role

externalRoles

String

1

no

The external groups or roles that map to this role. Required in external authentication mode (openid, ldap)

name

String

1

yes

The name of the role

Roles Media Type

This class is identified by media type:  application/vnd.abiquo.roles+json; version=3.10; application/vnd.abiquo.roles+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Role Media Type

1..n

optional

The collection of List of Role Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute


RoleWithPrivileges Media Type

This class is identified by media type:  application/vnd.abiquo.role+json; version=3.10; application/vnd.abiquo.role+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

blocked

boolean

1

no

This role is not editable or changeable. Used for Cloud Admin

enterprise

Enterprise Media Type

1

no

Enteprise associated to this role

id

Integer

1

no

Identifier for this role

idEnterprise

Integer

1

no

Identifier for the enterprise that the role belongs to. Leave empty for global (or system)
role

externalRoles

String

1

no

The external groups or roles that map to this role. Required in external authentication mode (openid, ldap)

name

String

1

yes

The name of the role

privileges

Privileges Media Type

1

no

All privileges included in this role

Scope Media Type

This class is identified by media type:  application/vnd.abiquo.scope+json; version=3.10; application/vnd.abiquo.scope+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

automaticAddDatacenter

boolean

1

optional

true if all new datacenters created are added into this scope

automaticAddEnterprise

boolean

1

optional

true if all new enterprises created are added into this scope

id

Integer

1

optional

The id of the entity

name

String

1

optional

Name of the scope, name "Global scope" is reserved for default scope

scopeEntities

List of ScopeEntity Media Type

1

optional

All limit entities of a scope

Scopes Media Type

This class is identified by media type:  application/vnd.abiquo.scopes+json; version=3.10; application/vnd.abiquo.scopes+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Scope Media Type

1..n

optional

The collection of List of Scope Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

ScopeEntity Media Type

This class is identified by media type:  application/vnd.abiquo.scoperesource+json; version=3.10; application/vnd.abiquo.scoperesource+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Id of the entity

idResource

int

1

optional

Identifier of the resource

type

String

1

optional

Type of the resource, can be 'ENTERPRISE' or 'DATACENTER'

User Entities

Application Media Type

This class is identified by media type:  application/vnd.abiquo.application+json; version=3.10; application/vnd.abiquo.application+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the application

name

String

1

yes

Name of the application

description

String

1

optional

Description of the application

apiKey

String

1

no

OAuth consumer key for the application

apiSecret

String

1

no

OAuth consumer secret for the application

Applications Media Type

This class is identified by media type:  application/vnd.abiquo.applications+json; version=3.10; application/vnd.abiquo.applications+xml; version=3.10;

Attribute

Type

Occurs

Input Required

Description

collection

List of Application Media Type

1..n

optional

The collection of List of Application Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

Session Media Type

This class is identified by media type:  application/vnd.abiquo.session+json; version=3.10; application/vnd.abiquo.session+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

authType

AuthType

1

no

The authentication type of the session

expirationDate

Date

1

no

The expiration date of the session

id

Integer

1

no

The identifier of the entity

idUser

Integer

1

no

The id of the user associated with the session

key

String

1

no

The session key

nick

String

1

no

The username of the user associated with the session

Sessions Media Type

This class is identified by media type:  application/vnd.abiquo.sessions+json; version=3.10; application/vnd.abiquo.sessions+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Session Media Type

1..n

optional

The collection of List of Session Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

User Media Type

This class is identified by media type:  application/vnd.abiquo.user+json; version=3.10; application/vnd.abiquo.user+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

active

boolean

1

yes

Flag indicating if the user is activated or not

authType

String

1

yes

Auth type selected for this user. Possible values are: abiquo, ldap, openid
(from AuthType enumerator).

availableVirtualDatacenters

String

1

no

List of IDs of restricted VDCs for this user separated by commas

description

String

1

no

A short description of the user

email

String

1

no

The contact e-mail address of the user for Abiquo messages

firstLoginboolean1noFlag indicating if the user is logging in for the first time or not

id

Integer

1

no

Identifier for this user

locale

String

1

no

Locale assigned to this user

lockedboolean1noFlag indicating if the user is locked for too many failed password attempts

name

String

1

yes

User's real first name

nick

String

1

yes

User name / nickname. The username for login

oldPasswordString1yesCurrent user password to change password in Abiquo

password

String

1

no

Password set for this user

phoneNumberString1noUser's phone number. The platform does not validate the format and the expected formats are E.164 or RFC 3966 (for numbers with extensions)
publicSshKeyString1optionalUser's public SSH key

surname

String

1

no

User's real last name

Users Media Type

This class is identified by media type:  application/vnd.abiquo.users+json; version=3.10; application/vnd.abiquo.users+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of User Media Type

1..n

optional

The collection of List of User Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute

UserWithRole Media Type

This class is identified by media type:  application/vnd.abiquo.userwithrole+json; version=3.10; application/vnd.abiquo.userwithrole+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

active

boolean

1

yes

Flag indicating if the user is activated or not

authType

String

1

yes

Auth type selected for this user: Abiquo managed or LDAP
{@link com.abiquo.model.enumerator.AuthType} value.

availableVirtualDatacenters

String

1

no

List with restricted VDCs for this user separated by commas

description

String

1

no

A short description of the user

email

String

1

no

The contact e-mail address of the user for Abiquo messages

enterprise

Enterprise Media Type

1

no

Enterprise for this user

id

Integer

1

no

Identifier for this user

locale

String

1

no

Locale assigned to this user

name

String

1

yes

User's real first name

nick

String

1

yes

User name / nickname. The username for login

password

String

1

no

Password set for this user

role

RoleWithPrivileges Media Type

1

no

Role and privileges assigned to this user

surname

String

1

no

User's real last name

UsersWithRoles Media Type

This class is identified by media type:  application/vnd.abiquo.userswithroles+json; version=3.10; application/vnd.abiquo.userswithroles+xml; version=3.10; 

Attribute

Type

Occurs

Input Required

Description

collection

List of UserWithRole Media Type

1..n

optional

The collection of List of UserWithRole Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' Attribute