Abiquo Documentation Cookies Policy

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


Abiquo 4.4

Skip to end of metadata
Go to start of metadata


For an index of data media types, see List of Abiquo Data Media Types

Appliance Library Entities 

Category Media Type

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

Attribute

Type

Occurs

Input Required

Description

defaultCategory

boolean

1

yes

If true, the category is the default

erasable

boolean

1

yes

If true, 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=4.2; application/vnd.abiquo.categories+xml; version=4.2;

Attribute

Type

Occurs

Input Required

Description

collection

List of Category Media Type

1..n

optional

The collection of Category Media Type elements

 

Conversion Media Type

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

Attribute

Type

Occurs

Input Required

Description

sourceFormat

DiskFormatType

1

yes

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

sourcePath

String

1

yes

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

startTimestamp

Date

1

yes

When the conversion started

state

ConversionState

1

yes

Result status of the conversion

targetFormat

DiskFormatType

1

yes

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

targetPath

String

1

yes

Path relative to the repository of the template disk file resulting from the conversion

targetSizeInBytes

Long

1

yes

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

 

Conversions Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Conversion Media Type

1..n

no

The collection of Conversion Media Type elements

 

DatacenterRepository Media Type

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

Attribute

Type

Occurs

Input Required

Description

error

String

1

optional

Any repository error

lastTaskTask1noThe task to track the last repository refresh

name

String

1

yes

Name of the datacenter repository

repositoryCapacityMb

long

1

optional

Capacity of the repository in MB

repositoryLocation

String

1

yes

The repository location, which may be the IP address and folder of the NFS share

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=4.2; application/vnd.abiquo.datacenterrepositories+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of DatacenterRepository Media Type

1..n

optional

The collection of DatacenterRepository Media Type elements

 

Disk Media Type

For disks that are part of a virtualmachinetemplate.

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

Attribute

Type

Occurs

Input Required

Description

label

String

1

optional

Friendly name

sequence

Integer

1

yes

Boot order

path

String

1

yes

Path of the VM template disk file, relative to the datacenter repository. Null for empty disks

diskFormatType

String

1

yes

Disk format type of the VM template. See DiskFormatType Media Type

diskFileSize

Long

1

yes

The disk file size in bytes of the VM template disk file

hdRequiredLong1optional

Capacity of the disk, which is the required hard disk space for the deployed disk, in bytes

state

VMTemplateState

1

no

Current state of the VM template (based on the tasks)

diskControllerType

DiskControllerType

1

optional

Type of disk controller (IDE or SCSI) and on KVM (IDE, SCSI, or VIRTIO). NOTE not all the hypervisor plugins will use this attribute

diskController

String

1

optional

Controller implementation to use for the disk. The default is lsilogic

creationDate

Date

1

optional

The date when the disk was created

bootableBoolean1yesSpecify if the disk is suitable to boot from (meaning that it's possible to define it in a VM with sequence 0 - (disk0 link))
allocationDiskAllocationType1optionalAllocation type to override platform default value

 

Disks Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Disk Media Type

1..n

optional

The collection of Disk Media Type elements

 

DiskAllocationType Media Type

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

Attribute

Type

Occurs

Input Required

Description

Name

String

1

no

Identifies the disk allocation type, for example, THIN, THICK, THICK_EAGER_ZERO


DiskAllocationTypes Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of DiskAllocationType Media Type

1..n

optional

The collection of DiskAllocationType Media Type elements

 

DiskControllerType Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

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

 

DiskControllerTypes Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of DiskControllerType

1..n

optional

The collection of DiskControllerType elements

 

DiskFormatType Media Type

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

Attribute

Type

Occurs

Input Required

Description

description

String

1

optional

Description of the disk format 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=4.2; application/vnd.abiquo.diskformattypes+xml; version=4.2;

Attribute

Type

Occurs

Input Required

Description

collection

List of DiskFormatType Media Type

1..n

optional

The collection of DiskFormatType Media Type elements

 

DiskRequest Media Type

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

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 datacenter repository of the VM template disk file. Null for empty disks

diskFormatType

String

1

yes

Disk format type of the VM template. See DiskFormatType Media Type

diskFileSize

Long

1

yes

The disk file size in bytes of the VM template disk file

hdRequiredLong1optional

The capacity of the hard disk, which is the hard disk space required for the disk, in bytes

state

VMTemplateState

1

no

Current state of the VM template (based on the tasks)

diskControllerType

DiskControllerType

1

optional

Type of disk controller (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 for this disk

creationDate

Date

1

optional

The date when the disk was created

bootableboolean1yesIf true, the disk is suitable to boot (meaning it's possible to define it in a VM with sequence 0 - (disk0 link))
newSequenceInteger1yesPosition in the boot order that the disk should be copied to

 

EthernetDriverType Media Type

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

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=4.2; application/vnd.abiquo.ethernetdrivertypes+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of EthernetDriverType

1..n

optional

The collection of EthernetDriverType elements

 

OSType Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Identifies the operating system type

description

String

1

optional

Friendly descx86ription of the operating system

is64b

Boolean

1

optional

If true, the operating system is x64; If false, it is x86

 

OSTypes Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of OSType

1..n

optional

The collection of OSType elements

 

TemplateDefinition Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

yes

Identifier of the template definition

url

String

1

yes

URL of the source .ovf envelope document

name

String

1

yes

Name of the template definition

description

String

1

yes

Description of the template definition

productName

String

1

optional

Additional info about the installed software used by the Apps library

productVendor

String

1

optional

Additional info about the installed software

productUrl

String

1

optional

Link to additional info about the installed software

productVersion

String

1

optional

Additional version info about the installed software

iconUrl

String

1

optional

The URI of the icon of the template definition

loginUser

String

1

optional

Default login user

loginPassword

String

1

optional

Default login password

osType

OSType

1

optional

Type of operating system used

osVersion

String

1

optional

Version of the operating system used with the osType

ethernetDriverType

EthernetDriverType

1

optional

Kind of network driver (PCNet32, VMXNET3 or E1000) and on KVM (VIRTIO). NOTE not all the hypervisor plugins will use this info. By default all use E1000

templatedefinitiondisksList of TemplateDefinitionDisk
media type
  The template disks 

 

TemplateDefinitions Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of TemplateDefinition Media Type

1..n

no

The collection of TemplateDefinition Media Type elements

 

TemplateDefinitionDisk Media Type

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

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

The capacity of the deployed disk, which is the hard disk space required for it, in bytes

diskControllerType

DiskControllerType

1

optional

Type 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 of the disk

 

TemplateDefinitionDisks Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of TemplateDefinitionDisk

1..n

optional

The collection of TemplateDefinitionDisk elements

 

TemplateDefinitionList Media Type

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

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 it is possible to request a refresh of the template definition list (fetch the OVFs again)

 

TemplateDefinitionLists Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of TemplateDefinitionList Media Type

1..n

no

The collection of TemplateDefinitionList Media Type elements

 

TemplateState Media Type

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

Attribute

Type

Occurs

Input Required

Description

ovfId

String

1

no

Identifier of the OVF of the template

status

TemplateStatusEnumType

1

no

Status of the template:

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


TemplatesState Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of TemplateState Media Type

1..n

optional

The collection of TemplateState Media Type elements. (The XML root element is templatesState, and the XML element name is ovfInstanceState)

 

VirtualMachineTemplate Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

yes

Identifier of the VM template

name

String

1

yes

Name of the VM template

description

String

1

optional

Description of the VM template

osType

OSType

1

optional

Type of operating system used on the VM template. Used to set the VMware guest operating system type

osVersion

String

1

optional

Additional info for the ''osType'', which can be used to provide details of operating systems and set the VMware guest operating system type

cpuRequired

Integer

1

yes

The number of CPUs required

coresPerSocket

Integer

1

optional

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

ramRequired

Integer

1

yes

The RAM in megabytes required for the VM template

shared

boolean

1

yes

If true, the VM template has scopes assigned, meaning that it can be used in other enterprises

state

VMTemplateState

1

no

Current state of the VM template (based on the tasks)

    • UNAVAILABLE, the template disk is not present in the repository filesystem, but it is in use by VMs or instances.

    • IN_PROGRESS, a download or promote task is running

    • FAILED, a download or promote task was finished unsuccessfully

    • DONE, the template is available and ready to use

costCode

Integer

1

optional

Cost code identifier

creationDate

Date

1

no

Creation date

creationUser

String

1

no

Username of the creation user

iconUrl

String

1

optional

The URI of the icon of the VM template that will be the default for VMs that users create from this template

loginUser

String

1

optional

Default login user for the VM template

loginPassword

String

1

optional

Default login password for the VM template

ethernetDriverType

EthernetDriverType

1

optional

Type of network driver (PCNet32, VMXNET3 or E1000). NOTE not all the hypervisor plugins will use this info. By default all use E1000

variables

HashMap of String

1

optional

Variables defined by name and value to send to the VM before first boot

enableCpuHotAdd

boolean

1

optional

Enable users to hot add CPU in Abiquo on supported hypervisors with a supported guest OS

enableRamHotAdd

boolean

1

optional

Enable users to hot-add RAM in Abiquo on supported hypervisors with a supported guest OS

enableDisksHotReconfigure

boolean

1

optional

Enable hot reconfigure to add or remove SCSI disks in Abiquo on supported hypervisors with a supported guest OS. To reorder disks in the boot sequence, power off the VM.

enableNicsHotReconfigure

boolean

1

optional

Enable hot reconfigure of NICs in Abiquo on supported hypervisors with a supported guest OS

enableRemoteAccessHotReconfigure

boolean

1

optional

Enable hot reconfigure to enable or disable remote access in Abiquo, which also resets remote access password, on supported hypervisors with a supported guest OS

cpuMinInteger1optionalMinimum CPU that users can allocate to a VM created from this template
cpuMaxInteger1optionalMaximim CPU that users can allocate to a VM created from this template
ramMinInteger1optionalMinimum RAM that users can allocate to a VM created from this template (MB)
ramMaxInteger1optionalMaximum RAM that users can allocate to a VM created from this template (MB)
enableOnlyHPRecommendedboolean1optionalOnly allow the user to work with recommended hardware profiles
guestSetupString1optionalIndicate the guest configuration automation for first boot, with value of CLOUD_INIT or HYPERVISOR_TOOLS. Configuration with hypervisor tools can also run when adding a NIC on Linux virtual machines. See Guest setup
generateGuestInitialPasswordboolean1optionalIf true, generate initial password and inject into guest, and send password to VM owner by email or SMS according to the configuration

 

VirtualMachineTemplates Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualMachineTemplate Media Type

1..n

no

The collection of VirtualMachineTemplate Media Type elements

 

VirtualMachineTemplatePersistent Media Type

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

Attribute

Type

Occurs

Input Required

Description

persistentTemplateName

String

1

yes

Name for the new persistent VM template

persistentVolumeName

String

1

optional

Name of the new volume to hold the persistent VM template. If it is null, the platform will use the value of persistentTemplateName
for a new volume or omit it if the storage link supplies an existing volume

 

VirtualMachineTemplateRequest Media Type

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

Attribute

Type

Occurs

Input Required

Description

promotedName

String

1

optional

Name for the new promoted VM template. Only required for a PROMOTE task, which is when a VM template instance link is present

 

Base Entities

AcceptedRequest Media Type

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

Attribute

Type

Occurs

Input Required

Description

message

Object

1

optional

The message explaining that you can track the status of the request using the status link

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=4.2; application/vnd.abiquo.error+xml; version=4.2; 

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=4.2; application/vnd.abiquo.errors+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Error Media Type

1..n

optional

The collection of Error Media Type elements

 

LimitExceededError Media Type

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

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
hardLimitboolean1noIf true, 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=4.2; application/vnd.abiquo.link+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

link

RESTLink

1

yes

Required attributes are rel and href. Optional attributes are title and type

 

Links Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Link Media Type

1..n

no

The collection of Link Media Type elements

 

EntityLinksCollection Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Link Media Type

1..n

no

The collection of Link Media Type elements


Metadata Media Type

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

Attribute

Type

Occurs

Input Required

Description

metadata

String

1

yes

The VM metadata with reserved keys for "chef", "startup-script", and "monitoring-metrics". See Manage virtual machine metadata via API for more details

 

Cloud Backup Entities

BackupResult Media Type

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

Attribute

Type

Occurs

Input Required

Description

providerId

String

1

no

Identifier of the backup in the backup system

nameString1noName of the backup in Abiquo
sizeInMbLong1noSize of the backup in megabytes
creationDateString1noTime when the backup was created in UTC format
expirationDateString1noTime when the backup will expire in UTC format
statusBackupResultStatus1noResult status of the backup, possible values: IN_PROGRESS, DONE, FAILED
typeBackupeType1noType of backup
storageString1noType of storage of the backup
replicaBoolean1noIf true, the backup uses replication
restoreResultsList of RestoreResult1noList of results of the restores of the backup

 

BackupResults Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of BackupResult Media Type

1..n

optional

The collection of BackupResult Media Type elements

 

RestoreBackup Media Type

You can restore a backup by supplying only the providerId. 

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

Attribute

Type

Occurs

Input Required

Description

id

String

1

no

Identifier of the backup in Aibquo

nameString1noName of the backup in Abiquo
statusString1noResult status of the backup with possible values: IN_PROGRESS, DONE, FAILED
dateString1noUTC format date and time when the backup was created
sizeLong1noSize of the backup in megabytes
typeString1noType of backup
providerIdString noIdentifier of the backup in the backup system


RestoreResult Media Type

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

Attribute

Type

Occurs

Input Required

Description

providerId

String

1

no

Identifier of the backup in the backup system

nameString1noName of the backup in Abiquo
sizeInMbLong1noSize of the backup in megabytes
dateString1noDate and time when the backup was created in UTC format
statusBackupResultStatus1noResult status of the backup with possible values: IN_PROGRESS, DONE, FAILED
typeString1noType of backup

 

OnDemandBackup Media Type

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

Attribute

Type

Occurs

Input Required

Description

replication

boolean

1

yes

If true, the replication option is to be used

 

Cloud Virtual Appliance Entities

Layer Media Type

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

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=4.2; application/vnd.abiquo.layers+xml; version=4.2;   

Attribute

Type

Occurs

Input Required

Description

collection

List of Layer Media Type

1..n

optional

The collection of Layer Media Type elements

 

VirtualMachineCloneOptions Media Type

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

Attribute

Type

Occurs

Input Required

Description

keepInLayerBoolean1yesIf true, when creating clones to scale out, add new VMs to the same anti-affinity layer
ScalingGroup Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the scaling group

createdBy

String

1

no

Username (nick) of the user that created the scaling group

defaultCooldownSeconds

Integer

1

yes

Time to wait until checking if a new scaling operation is required, from the start of a scaling operation

minSize

Integer

1

yes

Minimum number of deployed machines in the scaling group

maxSize

Integer

1

yes

Maximum number of deployed machines in the scaling group

keepInLayerBoolean1yesIf true, when creating clones to scale out, add new VMs to the same anti-affinity layer
disableWorkflowBoolean1yesIf true, for scaling, disable the workflow feature and ignore existing workflows
maintenanceModeBoolean1yesIf true, disable scaling and allow the user to make changes to the scaling group
lastScaleActivityTimeLong1noThe time of the last scaling activity
scaleOutRulesList of ScalingRule1yesThe collection of rules to use for scale-out operations
scaleInRulesList of ScalingRule1yesThe collection of rules to use for scale-in operations

 

ScalingGroups Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of ScalingGroup Media Type

1..n

no

The collection of ScalingGroup Media Type elements

 

ScalingRule Media Type

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

Attribute

Type

Occurs

Input Required

Description

numberOfInstances

Integer

1

yes

Number of VMs to deploy in a scaling operation

cooldownSecondsInteger1optionalTime to wait until checking if a new scaling operation is required, from the start of a scaling operation. Override default cooldownSeconds. If not supplied, defaultCooldownSeconds will be used.

startTime

Timestamp

1

optional

Time to start scaling process. If the startTime and endTime are not supplied, this is the default scaling rule. If there is already a default scaling rule, the startTime is required

endTime

Timestamp

1

optional

Time to stop scaling process. If the startTime and endTime are not supplied, this is the default scaling rule. If there is already a default scaling rule, the endTime is required

 

ScalingRules Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of ScalingRule Media Type

1..n

no

The collection of ScalingRule Media Type elements

 

VirtualAppliance Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

ID of the virtual appliance.

error

Integer

1

no

An error in the last operation on any of the VMs

highDisponibility

Integer

1

optional

Deprecated

lastTasks Media Type

Tasks

1

no

Last task of every VM in the virtual appliance

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 VMs

subState

VirtualApplianceState

1

optional

Deprecated

iconUrlString1optionalURL of the virtual appliance icon
descriptionString1optionalDescription of the virtual appliance

notAllocatedVirtualMachines

Integer1noNumber of VMs in the virtual appliance that are not allocated (not deployed)

onVirtualMachines

Integer1noNumber of VMs in the virtual appliance that are powered on

offVirtualMachines

Integer1noNumber of VMs in the virtual appliance that are powered off

pausedVirtualMachines

Integer1noNumber of VMs in the virtual appliance that are paused

allocatedVirtualMachines

Integer1noNumber of VMs in the virtual appliance that are allocated to a hypervisor. Usually this is a momentary state before a VM is configured

configuredVirtualMachines

Integer1noNumber of VMs in the virtual appliance that are configured. Usually this is a momentary state before a VM is powered on

unknownVirtualMachines

Integer1noNumber of VMs in the virtual appliance without a known state in the platform. This is usually after an error has occurred
lockedVirtualMachinesInteger1noNumber of VMs in the virtual appliance that are locked, for example, by a deploy, undeploy or reconfigure process, or by the administrator

 

VirtualAppliances Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualAppliance Media Type

1..n

no

The collection of VirtualAppliance Media Type elements

Alert Media Type

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

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

Name of the alert

description

String

1

yes

Description of the alert

muted

boolean

1

yes

If true, the alert must be ignored

active

boolean

1

no

If true, all the alarms in the alert are activated, meaning the alert is active, 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 subscriber emails to which notifications must be sent when the alert activates

Alerts Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualApplianceAlert Media Type

1..n

no

The collection of VirtualApplianceAlert Media Type elements


AlertHistory Media Type

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

Attribute

Type

Occurs

Input Required

Description

timestamp

Timestamp

1

no

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

active

boolean

1

no

If true, 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

AlertHistories Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualApplianceAlertHistory Media Type

1..n

no

The collection of VirtualApplianceAlertHistory Media Type elements


VirtualAppliancePrice Media Type

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

Attribute

Type

Occurs

Input Required

Description

additionalVolumCost

BigDecimal

1

yes

Value of external storage volumes

antiaffinityCost

BigDecimal

1

yes

Value of VMs in antiaffinity layers

computeCost

BigDecimal

1

yes

Value of the CPU and RAM in the VMs

costCodeCost

BigDecimal

1

yes

Value of the VM templates to deploy

minimumCharge

Integer

1

yes

Minimum charge.

minimumChargePeriod

BigDecimal

1

yes

Minimum charge period.

networkCost

BigDecimal

1

yes

Value of the public IPs and NAT IPs

standingCharge

BigDecimal

1

yes

Value for deploying

storageCost

BigDecimal

1

yes

Value of the datastore deployed hard disks

totalCost

BigDecimal

1

yes

Total value of the virtual appliance.

 

 

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=4.2; application/vnd.abiquo.virtualappliancespec+xml; version=4.2; 

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

Username (nick) of the user that created the spec

creationDate

Date

1

no

Creation date

defaultSpec

Boolean

1

optional

If true, the spec version is the default

sharedBoolean1noIf true, the spec is shared

virtualMachineSpecs

List of virtualMachineSpec

1

no

Spec of the virtual appliance's VMs

virtualMachineTemplateSpecs

List of virtualMachineTemplateSpec

1

no

Spec of templates used in the VMs of the virtual appliance

networkSpecs

List of networkSpec

1

no

Spec of networks used in the VMs of the virtual appliance

loadBalancersSpecs

List of loadBalancersSpec

1

no

Spec of load balancers used in the VMs of the virtual appliance

firewallPolicySpecs

List of firewallPolicySpec

1

no

Spec of firewalls used in the VMs of the virtual appliance

tierSpecs

List of tierSpec

1

no

Spec of tiers used in the VMs of the virtual appliance

datastoreTierSpecs

List of datastoreTierSpec

1

no

Spec of datastore tiers used in the VMs of the virtual appliance

alertSpecsList of alertSpec1noSpec of alerts used in the virtual appliance
sslCertificatesList of sslCertificateSpec1noSpec of SSL certificates used in the load balancers of the virtual appliance
backupPolicySpecsList of backupPolicySpec1noSpec of backup policies used in the VMs of the virtual appliance

 

 

VirtualApplianceSpecs Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualApplianceSpec Media Type

1..n

no

The collection of VirtualApplianceSpec Media Type elements

 

VirtualApplianceSpecValidation Media Type

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

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

If true, the spec is using Chef-enabled VMs

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=4.2; application/vnd.abiquo.virtualappliancestate+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

power

VirtualApplianceState

1

no

Current state of the virtual appliance. The state is inferred from its VMs. Values can be: DEPLOYED, NOT_DEPLOYED, NEEDS_SYNC, LOCKED, UNKNOWN, EMPTY

 

Cloud Virtual Datacenter Entities

 

Firewall Policy Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

The identifier of the firewall policy

nameString1yesName of the firewall policy
descriptionString1yesDescription 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=4.2; application/vnd.abiquo.firewallpolicies+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of FirewallPolicy Media Type

1..n

optional

The collection of FirewallPolicy Media Type elements

 

FirewallRule Media Type

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

 

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the firewall rule

providerIdString1noThe provider's ID for the firewall rule
protocolString1yesProtocol of the firewall rule
fromPortInteger1yesStart of the port range that the rule applies to
toPortInteger1yesEnd of the port range that the rule applies to
targetslist of target (String)1..nyesTarget ports for outgoing traffic in egress rule
sourceslist 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=4.2; application/vnd.abiquo.firewallrules+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of FirewallRule Media Type

1..n

optional

The collection of FirewallRule Media Type elements

 

HealthState Media Type

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

Describes when a VM 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

If true, the VM has not passed the health checks and should not receive traffic

 

HealthStates Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of HealthState Media Type

1..n

optional

The collection of HealthState Media Type elements


HealthCheck 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=4.2; application/vnd.abiquo.healthcheck+xml; version=4.2;

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 for performing 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 for the result of 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

Optional additional path information for performing the check, for example, 'webapp/index.html'

statusRegex

String

1

false

Regular expression to match a healthy node in check response status, for example, ''^[234] [0-9] [0-9]$''

bodyRegex

String

1

false

Regular expression to match a healthy node in check response body

 

HealthChecks Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of HealthCheck Media Type

1..n

optional

The collection of HealthCheck Media Type elements

 

LoadBalancer Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

true

Friendly name

algorithm

String (note_algorithm)

1

true

Distribution strategy with valid *algorithm* values based on plugin constraint *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 rules. 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 )

 

LoadBalancers Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of LoadBalancer Media Type

1..n

optional

The collection of LoadBalancer Media Type elements

 

LoadBalancerAddress Media Type

Address to be used to reach the load balancer

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

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


LoadBalancerAddresses Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of LoadBalancerAddress Media Type

1..n

optional

The collection of LoadBalancerAddress Media Type elements


RoutingRule Media Type

Define forward functions in the load balancer

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

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 with valid *protocolIn* values based on plugin constraint *LOADBALANCER_ROUTINGRULES_PROTOCOLS_CSV* :
curl -XGET http://<abiquoIP>/api/config/hypervisortypes

portOut

Integer

1

true

outbound port

protocolOut

String

1

true

outbound protocol with valid *protocolOut* values based on plugin constraint *LOADBALANCER_ROUTINGRULES_PROTOCOLS_CSV* :
curl -XGET http://<abiquoIP>/api/config/hypervisortypes

sslCertificateSslCertificate1optionalSSL certificate for the routing rule


RoutingRules Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of RoutingRule Media Type

1..n

optional

The collection of RoutingRule Media Type elements

 

SSLCertificate Media Type

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

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 for verifying the certificate

providerId

String

1

no

Provider ID of the virtual datacenter to synchronize

 

SSLCertificates Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of SSLCertificate Media Type

1..n

optional

The collection of SSLCertificate Media Type element


SyncVirtualDatacenter Media Type

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

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=4.2; application/vnd.abiquo.virtualdatacenter+xml; version=4.2;

Attribute

Type

Occurs

Input Required

Description

cpuHard

int

1

yes

Total number of virtual CPUs that may be used by VMs in the virtual datacenter. Hard limit that users cannot exceed

cpuSoft

int

1

yes

Total number of virtual cPUs that may be used by VMs in the virtual datacenter. Soft limit that can show that users are approaching the hard limit

hdHard

long

1

yes

Total size of hard disks that may be used by VMs in the virtual datacenter. Hard limit that users cannot exceed

hdSoft

long

1

yes

Total size of hard disks that may be used by VMs in the virtual datacenter. Soft limit that can show that users are approaching the hard 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

ID of the virtual datacenter

name

String

1

yes

Virtual datacenter's name

providerIdString1noThe cloud provider's identifier of the virtual datacenter entity

publicIpsHard

long

1

yes

Total number of public IPs that may be obtained for the virtual datacenter. Hard limit that users cannot exceed

publicIpsSoft

long

1

yes

Total number of public IPs that may be obtained for the virtual datacenter. Soft limit that can show that users are approaching the hard limit

ramHard

int

1

yes

Total amount of RAM memory that may be used by VMs in the virtual datacenter. Hard limit that users cannot exceed

ramSoft

int

1

yes

Total amount of RAM memory that may be used by VMs in the virtual datacenter. Soft limit that can show that users are approaching the hard limit

storageHard

long

1

yes

Total size of external storage that may be assigned in the virtual datacenter. Hard limit that users cannot exceed

storageSoft

long

1

yes

Total size of external storage that may be assigned in the virtual datacenter. Soft limit that can show that users are approaching the hard 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

network

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 number of VLANs that may be defined in the virtual datacenter. Hard limit that users cannot exceed

vlansSoft

long

1

yes

Total number of VLANs that may be defined in the virtual datacenter. Soft limit that can show that users are approaching the hard 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=4.2; application/vnd.abiquo.virtualdatacenters+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualDatacenter Media Type

1..n

no

The collection of VirtualDatacenter Media Type elements

 

VirtualDatacenterWithDatacenter Media Type

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

Attribute

Type

Occurs

Input Required

Description

cpuHard

int

1

yes

Total number of virtual CPUs that may be used by VMs in the virtual datacenter. Hard limit that users cannot exceed

cpuSoft

int

1

yes

Total number of virtual CPUs that may be used by VMs in the virtual datacenter. Soft limit that can show that users are approaching the hard limit

datacenter

Datacenter Media Type

1

no

Datacenter that the virtual datacenter belongs to

hdHard

long

1

yes

Total size of hard disks that may be used by VMs in the virtual datacenter. Hard limit that users cannot exceed

hdSoft

long

1

yes

Total size of hard disks that may be used by VMs in the virtual datacenter. Soft limit that can show that users are approaching the hard limit

hypervisorType

HypervisorType

1

yes

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

id

Integer

1

no

ID of the virtual datacenter.

name

String

1

yes

Name of the virtual datacenter.

publicIpsHard

long

1

yes

Total number of public IPs that may be obtained for the virtual datacenter. Hard limit that users cannot exceed

publicIpsSoft

long

1

yes

Total number of public IPs that may be obtained for the virtual datacenter. Soft limit that can show that users are approaching the hard limit

ramHard

int

1

yes

Total amount of RAM memory that may be used by VMs in the virtual datacenter. Hard limit that users cannot exceed

ramSoft

int

1

yes

Total amount of RAM memory that may be used by VMs in the virtual datacenter. Soft limit that can show that users are approaching the hard limit

storageHard

long

1

yes

Total size of external storage that may be assigned in the virtual datacenter. Hard limit that users cannot exceed

storageSoft

long

1

yes

Total size of external storage that may be assigned in the virtual datacenter. Soft limit that can show that users are approaching the hard limit

network

VLANNetwork Media Type

1

yes

Virtual datacenter network.

vlansHard

long

1

yes

Total number of VLANs that may be defined in the virtual datacenter. Hard limit that users cannot exceed

vlansSoft

long

1

yes

Total number of VLANs that may be defined in the virtual datacenter. Soft limit that can show that users are approaching the hard limit

 

Cloud Virtual Machine Entities

 

BackupPolicyDefinition Media Type

Specific instance of backup policy in a virtual machine

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

Attribute

Type

Occurs

Input Required

Description

configurationslist of backupConfigurationDefinition1..nyesBackup configurations (type, period, time) of backup policy definition

 

BackupConfigurationDefinition

Attribute

Type

Occurs

Input Required

Description

typeBackupType1yesBackup type (e.g. "SNAPSHOT")
subtypeBackupSubType1yesBackup subtype (e.g. "DAILY")
valueString optionalBackup date and/or time value (e.g. 5 or "10:15:00 +100")
daysString1..noptionalBackup days of the week (e.g. "MONDAY")
sourcesList of Path or Disk1..noptionalBackup these sources that are either paths or disks. Disks are links to disks, and paths are strings (e.g. "path": "/usr/bin")
 
Cluster Media Type

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

Attribute

Type

Occurs

Input Required

Description

providerIdString1noThe cluster identifier in the provider

providerType

String

1

no

The provider's hypervisor type

nameString1noThe cluster name in the provider

 

Clusters Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Cluster Media Type

1..n

no

The collection of clusters


Datapoint Media Type

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

Attribute

Type

Occurs

Input Required

Description

timestampTimestamp1yesTimestamp of the metric datapoint

value

Double

1

yes

Value of the metric datapoint


Datapoints Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Datapoint Media Type

1..n

no

The collection of Datapoints

 


Metric Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

no

Metric name

namespace

String

1

no

Metric namespace

unitString1noMetric unit
descriptionString1noMetric description
datapointslist of datapoint media type1..nnoMetric datapoints

 

Metrics Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Metric Media Type

1..n

no

The collection of Metric Media Type elements

 

MetricMetadata Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

no

Metric name

description

String

0..1

no

Metric description

unit

String

0..1

no

Metric unit

namespace

String

1

no

Metric namespace

dimensionsHash map of String, String metric dimensions1noHash map of Metric dimensions

 

MetricsMetadata Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of MetricMetadata Media Type

1..n

no

The collection of MetricMetadata Media Type elements

Alarm Media Type

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

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

Name of the alarm

description

String

1

yes

Description of 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

If true, 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

Alarms Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Alarm Media Type

1..n

optional

The collection of Alarm Media Type elements

MonitoringLevel Media Type

This class is identified by media type:   application/vnd.abiquo.monitoringlevel+json; version=4.2; application/vnd.abiquo.monitoringlevel+xml; version=4.2;  
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=4.2; application/vnd.abiquo.monitoringlevels+xml; version=4.2; 

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 MonitoringLevel Media Type elements

RunlistElement Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the runlist element for automated configuration with Chef

description

String

1

optional

Description of the runlist element

priority

int

1

yes

Order in which this runlist element should be applied

selected

boolean

1

yes

If true, the runlist element is selected for the VM

 

RunlistElements Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of RunlistElement Media Type

1..n

no

The collection of RunlistElement Media Type elements

 

VirtualMachine Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

ID of the VM

uuid

String

1

no

UUID of the VM

name

String

1

yes

Name of the VM. By default, the name is ABQ-uuid

labelString1optionalFriendly name of the VM. Displayed as the "Name" field in the user interface.
fqdnString1optionalFully qualified domain name of the VM. Can be entered and modified before deploy

description

String

1

optional

Optional description of the VM

cpu

Integer

1

yes

Number of CPUs in the VM

coresPerSocket

Integer

1

optional

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

ram

Integer

1

yes

Amount of memory in the VM in megabytes

vrdpEnabledboolean1optionalIf true, the VM should accept remote access connections

vdrpPort

int

1

no

Virtual remote desktop port

vdrpIP

String

1

no

Virtual remote desktop IP

idState

int

1

optional

ID of the state

state

VirtualMachineState

1

optional

Current VM state

idType

int

1

optional

Deprecated

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

highDisponibility

int

1

yes

Deprecated

password

String

1

optional

Remote acess password for opening a connection to a VM console

keymap

String

1

optional

Keymap for the keyboard to be set on the VM

runlist

RunlistElements Media Type

1

optional

Chef runlist to bootstrap the VM

metadataVirtualMachineMetadata1optionalVM metadata used to store data for cloud-init, Chef, monitoring, etc.
monitoredBoolean1yesFetch metrics for this VM and enable monitoring features such as alarms, alerts, and action plans
monitoringLevelmonitoringLevel (String name)1yesThe monitoring level configured for the provider. Some providers such as AWS offer DETAILED and DEFAULT monitoring levels
protectedboolean1yesIf true, the VM is protected by the administrator and the standard user cannot perform platform operations on the VM
protectedCauseString1optionalThe reason why the VM was protected
variablesHashmap of String1..noptionalList of variables defined by name and value to send to the VM before first boot
creationTimestampTimestamp1noTimestamp of when the VM was created in milliseconds
backupPoliciesList of BackupPolicyDefinition1..noptionalList of Backup policy definitions for the VM
lastSynchronizeString1noUser cannot reconfigure a VM until lastSynchronize has a value, reflecting that information from cloud node/provider has been updated in the platform since the VM was deployed
generateGuestInitialPasswordboolean1optionalIf true, generate initial password and inject into guest, and send password to VM owner by mail or SMS, according to platform configuration
natRulesNatRules1optionalList of NAT rules associating an original IP and a translated IP

 

VirtualMachines Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualMachine Media Type

1..n

optional

The collection of VirtualMachine Media Type elements

 

VirtualMachineFlat Media Type

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

Attribute

Type

Occurs

Input Required

Description

backupPoliciesList of BackupPolicyDefinition1optionalList of Backup policy definitions for the VM

cpu

Integer

1

yes

Number of CPUs in the VM

coresPerSocket

Integer

1

optional

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

creationTimestampTimestamp1noTimestamp of when the VM was created

description

String

1

optional

Description of the VM 

disksDisksManagement Media Type1noDisks attached to the VM

dvd

DvdManagement Media Type

1

optional

Deprecated

highDisponibility

int

1

yes

Deprecated

id

Integer

1

no

ID of the VM

idState

int

1

optional

ID of the state.

idType

int

1

optional

Deprecated

keymap

String

1

optional

Keymap of the keyboard to be set on the VM

labelString1optionalAntiaffinity feature
metadataVirtualMachineMetadata1optionalVM metadata used to store data for cloud-init, Chef, monitoring, etc.
monitoredBoolean1yesFetch metrics for this VM and enable monitoring features such as alarms, alerts, and action plans
monitoringLevelmonitoringLevel (String (name))1yesThe monitoring level FOR the provider. Some providers such as AWS offer DETAILED and DEFAULT monitoring levels
protectedboolean1yesIf true, the VM is protected by the administrator and the standard user cannot perform platform operations on the VM
protectedCauseString1optionalThe reason why the VM was protected

name

String

1

yes

Name of the VM

nicsNics Media Type1yesNICs attached to the VM

password

String

1

optional

Remote acess password for opening a connection to a VM console

ram

Integer

1

yes

Amount of memory in the VM in megabytes

runlist

RunlistElements Media Type

1

optional

Chef runlist to bootstrap the VM

state

VirtualMachineState

1

optional

Current VM state

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

uuid

String

1

no

UUID of the VM

variablesHashmap of String1..noptionalList of variables in key:value format to send to the VM before first boot
volumesVolumesManagement Media Type1..noptionalVolumes attached to the VM
vrdpEnabledboolean1optionalIf true, the VM should accept remote access connections

vdrpIP

String

1

no

Virtual remote desktop IP

vdrpPort

int

1

no

Virtual remote desktop port

generateGuestInitialPasswordboolean1optionalIf true, the platform is to generate an initial password and inject it into the guest, and send the password to the VM owner by mail or SMS as configured
natRulesNatRules1optionalList of NAT rules associating an original IP with a translated IP


VirtualMachineConsole Media Type

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

Attribute

Type

Occurs

Input Required

Description

protocol

String

1

no

Protocol to use to connect to the VM console

url

String

1

no

URL to use to connect to the VM console

parametersHashmap of String, String parameter key and value1noHash map of parameters to connect to the VM console

 

 

VirtualMachineActionPlan Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

optional

Name of the action plan

description

String

1

optional

Description of the action plan

createdByString1noUsername of the creator of the action plan
entriesList of VirtualMachineActionPlanEntry Media Type1yesOrdered list of VirtualMachineActionPlanEntry

 

VirtualMachineActionPlans Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualMachineActionPlans Media Type

1..n

optional

The collection of VirtualMachineActionPlans Media Type elements

 

VirtualMachineActionPlanEntry Media Type

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

Attribute

Type

Occurs

Input Required

Description

sequence

Integer

1

no

Sequence of this entry in the action plan

typeOne of the VirtualMachineActionPlanEntry Types1yesSee list of VirtualMachineActionPlanEntry Types

name

String

1

optional

Name of the action plan

parameter

String

1

optional

Parameter for the action plan

parameterTypeString1noType of the parameter

 

VirtualMachineActionPlanEntry Type

Type

Parameter required

Parameter Type

Parameter Description

RESET

no

 

 

POWER_ONno  
POWER_OFFno  
SHUTDOWNno  
DEPLOYno  

UNDEPLOY

no

 

 

INCREASE_CPU

yes

Unsigned integer

The increment of the CPU in units

INCREASE_RAM

yes

Ram

The increment of RAM and the units, either MB or GB, e.g.
{"quantity":"128", "unit":"MB"}

DECREASE_CPUyesUnsigned integerThe decrement of CPU in units
DECREASE_RAMyesRamThe decrement of RAM in units, either MB or GB, e.g.
{"quantity":"128", "unit":"MB"}
INSTANCEyesInstanceThe base name of the instance. The platform will add the creation time. And the disk sequence numbers of the disks to instance. E.g.
{"instanceName": "MyInstance", "diskSequences" : [0,2]}
SEND_EMAILyesEmail{ "addressesTo" : [], "addressesCc" : [], "subject" : "", "body" : "" } 
SCALE_OUTno  
SCALE_INno  
START_MAINTENANCEno  
END_MAINTENANCEno  

 

IntervalBasedSchedule Media Type

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

Attribute

Type

Occurs

Input Required

Description

intervalSeconds

Integer

1

yes

The repeat interval in seconds. The platform waits for this interval before each execution of the action plan.

repeatCountInteger1yesThe number of times to repeat the action plan. A value of 0 means repeat forever
startTimeLong1optionalThe start time for the trigger in milliseconds since January 1, 1970, 00:00:00 GMT
endTimeLong1optionalThe end time for the trigger in milliseconds since January 1, 1970, 00:00:00 GMT
executionCountInteger1noThe execution count, read only. Null if repeatCount is 0

 

IntervalBasedSchedules Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of IntervalBasedSchedule Media Type

1..n

optional

The collection of IntervalBasedSchedule Media Type elements

 

CronBasedSchedule Media Type

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

Attribute

Type

Occurs

Input Required

Description

seconds

String

1

yes

Allowed values: 0-59 , - * /

minutes

String

1

yes

Allowed values: 0-59 , - * /

hoursString1yesAllowed values: 0-23 , - * /
dayOfMonthString1yesAllowed values: 1-31 , - * ? / L W
monthString1yesAllowed values: 0-11 or JAN-DEC , - * / 
dayOfWeekString1yesAllowed values: 1-7 or SUN-SAT , - * ? / L #
yearString1yesAllowed values: 1970-2199 , - * / 

 

CronBasedSchedules Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of CronBasedSchedule Media Type

1..n

optional

The collection of CronBasedSchedule Media Type elements

 

VirtualMachineActionPlanFlat Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

optional

Name of the action plan

description

String

1

optional

Description of the action plan

createdByString1noUsername of the creator of the action plan
entriesList of VirtualMachineActionPlanEntry Media Type1yesOrdered list of VirtualMachineActionPlanEntry
intervalBasedSchedulesList of intervalBasedSchedule Media Type1optionalList of intervalBasedSchedule Media Type elements
cronBasedSchedulesList of cronBasedSchedule Media Type1optionalList of cronBasedSchedule Media Type elements

 

VirtualMachineActionPlansFlat Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualMachineActionPlanFlat Media Type

1..n

optional

The collection of VirtualMachineActionPlanFlat Media Type elements

 

VirtualMachineInstance Media Type

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

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=4.2; application/vnd.abiquo.virtualmachinestate+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

state

VirtualMachineState

1

yes

State of the VM. Valid values for the user to change to a state 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=4.2; application/vnd.abiquo.virtualmachinetask+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

forceUndeploy

Boolean

1

optional

If true, the platform will force an undeploy of an imported VM. Imported VMs do not have an image stored in the platform repository. If we undeploy them, we have lost the image and it cannot be deployed again

 

Configuration Entities

HypervisorType Media Type

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

Attribute

Type

Occurs

Input Required

Description

baseformat

DiskFormatType

1

yes

Base format of the hypervisor type

compatibleformatsList of format1..nyesTemplate format compatibility table
diskcontrollertypesList of diskcontrollertype1optionalList of compatible disk controllers
diskallocationtypesList of diskallocationtype1optionalList of compatible disk allocation types

name

String

1

yes

Name of the hypervisor type

realName

String

1

yes

Friendly name of the hypervisor type

constraintsString1yesHypervisor plugin constraints
operationsString1yesHypervisor operations
guestsetupsList of guestsetup1optionalList of compatible guest setups

 

HypervisorTypes Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of HypervisorType Media Type

1..n

optional

The collection of HypervisorType Media Type elements

BackupTypes Media Type

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

Attribute

Type

Occurs

Input Required

Description

backupTypesbackupType1..nnoList of supported backup types, for example: COMPLETE, SNAPSHOT, FILESYSTEM, OPTIONS, each with its own list of subtypes. The supported subtypes may be periods or options, for example: DEFINED_HOUR, HOURLY, DAILY, WEEKLY_PLANNED, MONTHLY, REPLICATION

 

BackupPluginType Media Type

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

Attribute

Type

Occurs

Input Required

Description

nameString1noName of the backup plugin

type

backupType

1

no

Type of the backup plugin, not editable, e.g. Avamar

constraintsString1noList of constraints, for example, "restore_vm_in_power_on": "false"
operationsString1noList of operations that can be performed by the backup plugin

 

BackupPluginTypes Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of BackupPluginType Media Type

1..n

optional

The collection of BackupPluginType Media Type elements

License Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

The identifier of the entity

numcores

Integer

1

no

The number of cores that the license enables

expiration

String

1

no

The expiration date of the license

code

String

1

yes

The license code

scalingGroupsEnabledBoolean1noIf true, scaling groups are enabled

 

Licenses Media Type

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

Attribute

Type

Occurs

Input Required

Description

availablecores

Integer

1

optional

Total number of cores that the platform can manage 

collection

List of License Media Type

1..n

optional

The collection of License Media Type elements

 

SystemProperty Media Type

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

Attribute

Type

Occurs

Input Required

Description

description

String

1

optional

A description of the usage of the property

id

Integer

1

no

Identifier of the entity

name

String

1

yes

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=4.2; application/vnd.abiquo.systemproperties+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of SystemProperty Media Type

1..n

optional

The collection of SystemProperty Media Type elements

 

Event Entities

Event Media Type

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

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

Identifier of the event

idDatacenter

Integer

1

no

Identifier of the datacenter where the event took place.

idEnterprise

Integer

1

no

Identifier of the user's enterprise.

idNetwork

Integer

1

no

Identifier of the network if the action was performed on a network.

idPhysicalMachine

Integer

1

no

Identifier of the physical machine if the action was performed on a physical machine.

idRack

Integer

1

no

Identifier of the rack if the action was performed on a rack.

idStoragePool

String

1

no

Identifier of the storage pool if the action was performed on a storage pool.

idStorageSystem

Integer

1

no

Identifier of the storage system if the action was performed on a storage system.

idSubnet

Integer

1

no

Identifier of the subnet if the action was performed on a subnet.

idUser

Integer

1

no

Identifier of the user that triggered the event.

idVirtualApp

Integer

1

no

Identifier of the virtual appliance if the action was performed on a virtual appliance.

idVirtualDatacenter

Integer

1

no

Identifier of the virtual datacenter if the action was performed on virtual datacenter.

idVirtualMachine

Integer

1

no

Identifier of the virtual machine if the action was performed on a virtual machine.

idVolume

String

1

no

Identifier of the volume if the action was performed on volume.

network

String

1

no

The network if the action was performed on a network.

performedBy

String

1

no

The user or entity that performed the action.

physicalMachine

String

1

no

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

rack

String

1

no

The rack if the action was performed on a rack.

severity

SeverityType

1

no

The severity:

  • INFO

  • WARN

  • ERROR

stacktrace

String

1

no

The stacktrace. If the action is an error, then this is the java stack trace.

storagePool

String

1

no

The storage pool if the action was performed on a storage pool

storageSystem

String

1

no

The storage system if the action was performed on a storage system

subnet

String

1

no

The subnet if the action was performed on a subnet

timestamp

Date

1

no

The timestamp of the time when the event took place

user

String

1

no

The user who performed the action

virtualApp

String

1

no

The virtual appliance if the action was performed on a virtual appliance

virtualDatacenter

String

1

no

The virtual datacenter if the action was performed on a virtual datacenter

virtualMachine

String

1

no

The VM if the action was performed on a VM

volume

String

1

no

The volume if the action was performed on a volume

 

Events Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Event Media Type

1..n

no

The collection of Event Media Type elements

 

EventTypes Media Type

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

Attribute

Type

Occurs

Input Required

Description

actions

EventActions Media Type

1..n

no

List of EventAction Media Type elements

severities

EventSeverities Media Type

1..n

no

List of EventSeverity Media Type elements

 

Infrastructure Datacenter and Public Cloud Region Entities

BackupConfiguration Media Type

A backup configuration created in the datacenter as part of backup policy.

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

Attribute

Type

Occurs

Input Required

Description

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

subtype

Subtype

1

yes

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

time

String

1

yes

Time when the backup will be performed in UTC format. It can include a date (e.g. "2018/01/01 09:00:00 +0100")

days

List of String

1

yes

List of days of the week when the backup will be performed (e.g. "MONDAY","TUESDAY")

 

BackupDatacenterProperties

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

Attribute

Type

Occurs

Input Required

Description

enableMultipleRestoreboolean1yesIf true, the user can request multiple restores after a restore completes or fails

enableMultiplePolicies

boolean

1

yes

If true, the user can select multiple policies for a VM

enableUpdateWhileDeployed

boolean

1

yes

If true, the the user can update the backup options when the VM is deployed

enableManualBackup

boolean

1

yes

If true, the user can request an immediate backup

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

 

BackupManager Media Type

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

Attribute

Type

Occurs

Input Required

Description

endpoint

String

1

yes

The complete endpoint URL of the plugin manager

name

String

1

yes

Name of the backup manager

password

String

1

yes

The password for the API connection authorization

typeBackupManagerType1noType of the plugin to use as loaded in the platform. Cannot be edited

user

String

1

yes

The user for the API connection authorization

 

BackupPolicy Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the datacenter that the backup policy will belong to

code

String

1

yes

Code to identify the backup policy

description

String

1

yes

Description of the backup policy

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


BackupPolicies Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of BackupPolicy Media Type

1..n

optional

The collection of BackupPolicy Media Type elements

 

Datacenter Media Type

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

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

 

Datacenters Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Datacenter Media Type

1..n

optional

The collection of Datacenter Media Type elements

 

DatacenterLight Media Type

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

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=4.2; application/vnd.abiquo.datacenterslight+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of DatacenterLight Media Type

1..n

optional

The collection of DatacenterLight Media Type elements

 

HardwareProfile Media Type

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

Attribute

Type

Occurs

Input Required

Description

providerIdString1noThe provider's ID for the hardware profile
nameString1noName of the hardware profile

cpu

Integer

1

no

CPU defined for the hardware profile

ramInMbInteger1noRAM in megabytes defined for the hardware profile
activeBoolean1noIf true, the hardware profile is visible to administrators and can be made available to users in the datacenter

 

HardwareProfiles Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of HardwareProfile Media Type

1..n

optional

The collection of HardwareProfile Media Type elements

 

IpLiterals Media Type

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

Attribute

Type

Occurs

Input Required

Description

ips

List of ip String

1..n

optional

A list of IPs

 

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=4.2; application/vnd.abiquo.datacenter+xml; version=4.2; application/vnd.abiquo.publiccloudregion+json; version=4.2; application/vnd.abiquo.publiccloudregion+xml; version=4.2; 

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

 

PublicCloudRegion Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

name

String

1

yes

Name of a public cloud region

remoteServices

RemoteServices Media Type

1

optional 

List of remote services assigned to the public cloud region

 

PublicCloudRegions Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of PublicCloudRegion Media Type

1..n

optional

The collection of PublicCloudRegion Media Type elements

 

Region Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

optional

 Name of the region

endpoint

String

1

optional

The address for communicating with the region


Regions Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Region Media Type

1..n

optional

The collection of Region Media Type elements

 

RemoteService Media Type

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

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=4.2; application/vnd.abiquo.remoteservices+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of RemoteService Media Type

1..n

optional

The collection of RemoteService Media Type elements

configErrors

Errors Media Type

1

optional

List of configuration errors

 

Infrastructure Rack and Machine Entities

ManagedHostLocator Media Type

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

Attribute

Type

Occurs

Input Required

Description

ip

String

1

yes

IP of the managed host

hostname

String

1

yes

Hostname of the managed host

Includes a link to the machine entity of the host.

ManagedHostLocators Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of ManagedHostLocator Media Type

1..n

optional

The collection of ManagedHostLocator elements

Machine Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the machine

name

String

1

yes

Name of the machine

description

String

1

optional

Description of the machine

state

MachineState

1

no

State of the machine, which 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

ip

String

1

yes

IP of the machine

hostnameString1noRead only hostname of the machine, set the hostname to the machine name by default

ipService

String

1

yes

IP of the hypervisor service of machine

port

Integer

1

yes

Connection port of the machine

virtualRamInMb

Integer

1

yes

RAM in MB of the machine

virtualRamUsedInMb

Integer

1

yes

Used RAM in MB of the machine

virtualCpuCores

Integer

1

yes

Number of CPUs of the machine

virtualCpusUsed

Integer

1

yes

Number of used CPUs of the machine

user

String

1

yes

Name of the user for logging in to the hypervisor service

password

String

1

yes

Password of the user for logging in to the hypervisor service

initiatorIQN

String

1

optional

Initiator IQN of the machine used to use storage devices

ipmiIP

String

1

optional

IP of the IPMI service of the machine

ipmiPort

Integer

1

optional

Connection port of the IPMI service of the machine

ipmiUser

String

1

optional

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

ipmiPassword

String

1

optional

Password of the user for logging in to the IPMI service of the machine

datastores

Datastores Media Type

1

yes

List of datastores of the machine

networkInterfaces

NetworkInterfaces Media Type

1

optional

The network interfaces of the machine

managerIpString1optionalManager IP address
managerPortInteger1optionalManager port
managerUserString1optionalManager user for logging in to the hypervisor manager
managerPasswordString1optionalManager password for logging in to the hypervisor manager
agentIPString1optionalIP for 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
agentPasswordString1optionalPassword of the agent to connect to the hypervisor

 

Machines Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Machine Media Type

1..n

optional

The collection of Machine Media Type elements

errors

Errors Media Type

1

optional

 

 

MachineIpmiState Media Type

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

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=4.2; application/vnd.abiquo.machinestate+xml; version=4.2; 

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

Mail Media Type

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

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=4.2; application/vnd.abiquo.networkinterface+xml; version=4.2; 

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=4.2; application/vnd.abiquo.networkinterfaces+xml; version=4.2;

Attribute

Type

Occurs

Input Required

Description

collection

List of NetworkInterface Media Type

1..n

optional

The collection of NetworkInterface Media Type elements

 

Rack Media Type

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

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

The percentage of tolerance in the number of tags to reserve for existing virtual datacenters that is used to determine if new virtual datacenters can be created on the rack

shortDescription

String

1

optional

Short description of the rack.

vlanIdMax

Integer

1

optional

Value of the tag at the end of the range of VLANs allowed in the rack.

vlanIdMin

Integer

1

optional

Value of the tag at the start of the range of VLANs allowed in the rack

vlanPerVdcReserved

Integer

1

no

The expected number of VLANs that the administrator estimates will be required per VDC. These VLANs are not reserved for any specific virtual datacenter but the value will affect the number of VDCs that can be created on the rack. The value is multiplied by the number of VDCs that already exist and the percentage of tolerance (nrsq) per VDC is added to determine how many VLANs are required for existing VDCs. To create a new VDC, there must be enough tags for the virtual datacenter so that users can create the expected number of VLANs with tolerance

vlansIdAvoided

String

1

optional

List of tags not permitted for use by the VLANs allowed in the rack.

 

Racks Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Rack Media Type

1..n

no

The collection of Rack Media Type elements

 

ReservedMachine Media Type

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

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 datastores 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 for working with 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 IPMI service of the machine

ipmiPassword

String

1

optional

Password of the user for logging in to the IPMI service of the machine

ipmiPort

Integer

1

optional

Connection port of the IPMI service of the machine

ipmiUser

String

1

optional

Name of the user for logging in to the IPMI 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 network interfaces of the machine

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 the platform

user

String

1

yes

Name of the user for logging in to the hypervisor service

cpu

Integer

1

yes

Number of CPUs in the machine

cpuUsed

Integer

1

yes

Number of CPUs used in the machine

ram

Integer

1

yes

Memory in MB in the machine

ramUsed

Integer

1

yes

Used memory in MB in the machine

 

ReservedMachines Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of ReservedMachine Media Type

1..n

optional

The collection of ReservedMachine Media Type elements

errors

Errors Media Type

1

optional

 

 

VlanTagAvailability Media Type

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

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 the availability zone

 

AvailabilityZones Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of AvailabilityZone Media Type

1..n

no

The collection of AvailabilityZone Media Type elements

 

Device Media Type

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

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

If true, new virtual datacenters will use this device when it is 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=4.2; application/vnd.abiquo.vpcdevices+xml; version=4.2;   

Attribute

Type

Occurs

Input Required

Description

collection

List of Device Media Type

1..n

no

The collection of Device Media Type elements

 

DeviceInterfaceType Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the VPC device type

realName

String

1

yes

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

 

DeviceType Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the device type

deviceinterfaces

List of deviceinterface (deviceInterfacetype)

1..n

no

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

  • VPC

  • Networking

  • ExternalNetworking

  • PublicNetworking

  • Firewall

  • LoadBalancers

  • DHCP

 

DeviceTypes Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of DeviceType Media Type

1..n

no

The collection of Device Type Media Type elements

 

DeviceInterfaceType Media Type

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

Attribute

Type

Occurs

Input Required

Description

deviceInterface

String

1

yes

Name of the device interface type

realName

String

1

yes

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=4.2; application/vnd.abiquo.dhcpoption+xml; version=4.2; 

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 as an integer

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=4.2; application/vnd.abiquo.dhcpoptions+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of DhcpOption Media Type

1..n

optional

The collection of DhcpOption Media Type elements

 

ExcludedNetwork Media Type

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

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

ipv6boolean1yesIf true, the network is IPv6; If false, it is IPv4. The default is false

 

ExcludedNetworks Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of ExcludedNetwork Media Type

1..n

optional

The collection of ExcludedNetwork Media Type elements


ExternalIp Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

mac

String

1

no

MAC address associated with 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 that the IP belongs to

ipv6

boolean

1

no

If true, the network is IPv6; If false, it is IPv4

usedByString1noProviderId of the entity using this IP. The entity can be managed by the platform

available

boolean

1

optional

If true, the IP is available to be used by a customer. Can be set in Infrastructure

quarantine

boolean

1

optional

If true, the IP is in quarantine

 

ExternalIps Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of ExternalIp Media Type

1..n

optional

The collection of ExternalIp Media Type elements

 

Ips Bulk Creation Media Type

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

Attribute

Type

Occurs

Input Required

Description

ip

String

1

yes

String that represents the IP address

ipv6

Boolean

1

optional

If true, the IPs created will be IPv6; If false, they will be IPv4. The default is false

available

Boolean

1

optional

If true, the IPs created will be available to be used by the users. The default is false

quarantine

Boolean

1

optional

If true, the IPs created will be in quarantine state. The default is false

numips

Integer

1

yes

Number of IPs to create including the starting IP address given as "ip"

 

NatIp Media Type

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

Attribute

Type

Occurs

Input Required

Description

providerId

String

1

no

Identifier of the entity in the network provider

ip

String

1

yes

String that represents the IP address

available

boolean

1

optional

If true, the IP is available to be used by a customer

quarantineboolean1optionalIf true, the IP is in quarantine


NatIps Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of NatIp Media Type

1..n

optional

The collection of NatIp Media Type elements

 

NatNetwork Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the NAT network

cidr

String

1

yes

Network address and mask of the NAT network in CIDR notation


NatNetworks Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of NatNetwork Media Type

1..n

optional

The collection of NatNetwork Media Type elements

 

NatRule Media Type

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

Relates a privateIp and a natIp with port mappings. This media type has links to the original source IP and the translated destination IP.

Attribute

Type

Occurs

Input Required

Description

providerId

String

1

yes

Name of the NAT rule

originalPort

Integer

1

yes

Original or source port of the NAT rule

translatedPortInteger1yesTranslated or destination port of the NAT rule
snatBoolean1yesIf true, the NAT rule is SNAT; If false, it is DNAT
protocolString1yesProtocol to be used for the NAT rule if it is a DNAT rule (e.g. TCP, UDP)
NatRules Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of NatRule Media Type

1..n

optional

The collection of NatRule Media Type elements


NetworkConfiguration Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

gateway

String

1

no

Gateway of the network configuration

primaryDNS

String

1

no

Primary DNS of the network configuration

secondaryDNS

String

1

no

Secondary DNS of the network configuration

suffixDNS

String

1

no

DNS suffix of the network configuration

 
NetworkServiceType Media Type

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

Attribute

Type

Occurs

Input Required

Description

defaultNST

boolean

1

no

If true, the network service type is the default for the current datacenter

id

Integer

1

no

Identifier of the entity

name

String

1

yes

Name of the network service type

 

NetworkServiceTypes Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of NetworkServiceType Media Type

1..n

optional

The collection of NetworkServiceType Media Type elements

 

Nic Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

ip

String

1

no

IP address asociated with the NIC

mac

String

1

no

MAC address of the NIC

sequence

Integer

1

no

Sequence ord of the NIC in the VM

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=4.2; application/vnd.abiquo.nics+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Nic Media Type

1..n

optional

The collection of Nic Media Type elements

 

AbstractIp Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

mac

String

1

no

MAC address associated with 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 that the IP belongs to

ipv6boolean1noIf true, the IP is IPv6; If false, it is IPv4
usedByString1noProviderId of the entity using this IP. The entity can be managed by the platform or not
PrivateIp Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

mac

String

1

no

MAC address associated with 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 that the IP belongs to

ipv6boolean1noIf true, the IP is IPv6; If false, the IP is IPv4
usedByString1noProviderId of the entity using this IP. The entity can be managed by Abiquo or not
availableboolean1noIf the IP is available to be used by a customer or not. Read-only attribute

 

PrivateIps Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of PrivateIp Media Type

1..n

optional

The collection of PrivateIp Media Type elements

 

PublicIp Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

mac

String

1

no

MAC address associated with 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 that the IP belongs to

ipv6

boolean

1

no

If true, the IP is IPv6; If false, the IP is IPv4

usedByString1noProviderId of the entity using this IP. The entity can be managed by Abiquo or not
availableboolean1noIf true, the IP is available to be used by a customer

quarantine

boolean

1

optional

If true, the IP is in quarantine

providerIdString1noIdentifier of the IP in the remote provider

 

PublicIps Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of PublicIp Media Type

1..n

optional

The collection of PublicIp Media Type elements

 

UnmanagedIp Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

mac

String

1

no

MAC address associated with 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 that the IP belongs to

ipv6

boolean

1

no

If true, the IP is IPv6; If false, it is IPv4

usedByString1noProviderId of the entity using this IP. The entity can be managed by Abiquo or not

available

boolean

1

optional

If true, the IP is available to be used by a customer. Can be set in Infrastructure view

quarantine

boolean

1

optional

If true, the IP is in quarantine

 

UnmanagedIps Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of UnmanagedIp Media Type

1..n

optional

The collection of UnmanagedIp Media Type elements

 

VLANNetwork Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the entity

name

String

1

yes

Name of the VLAN

address

String

1

yes

Network address of the VLAN

mask

Integer

1

yes

Numerical value of the VLAN mask

gateway

String

1

yes

Gateway of the VLAN

primaryDNS

String

1

optional

Primary DNS address

secondaryDNS

String

1

optional

Secondary DNS value

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

defaultNetwork

Boolean

1

no

If true, the network is used as a default network.

unmanaged

Boolean

1

optional

If true, the VLAN is unmanaged

type

NetworkType

1

optional

Type of network: PUBLIC, INTERNAL, EXTERNAL and UNMANAGED

dhcpOptions

DhcpOptions Media Type

1

optional

DHCP options are used for static routes

ipv6boolean1yesIf true, the network is IPv6; If false, the network is IPv4. The default is false
strictboolean1yesIf true, the IPv6 network is strict; If false, it is not strict. The default is false
providerIdString1optionalProvider's ID for the network
restrictedBoolean1optionalIf true, the ability to attach or detach NICs in this external or public network is restricted by privileges
internetGatewayRoleBoolean1optionalIf true, the network provides the internet gateway for the VDC
ipRangesList IpRange1optionalList of ipRange, with firstIp and lastIp available in the range, to define provider IP networks and reserved IPs.
excludedFromFirewallBoolean1optionalIf true, the platform will not apply VM firewalls to this network. The default is false

 

VLANNetworks Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VLANNetwork Media Type

1..n

optional

The collection of VLANNetwork Media Type elements

 

VMNetworkConfiguration Media Type

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

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

DNS suffix of the network configuration

used

Boolean

1

optional

If true, this network configuration is used by the virtual machine

 

VMNetworkConfigurations Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VMNetworkConfiguration Media Type

1..n

optional

The collection of VMNetworkConfiguration Media Type elements

 

OpenID Entities

OIDCTokens Media Type

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

Attribute

Type

Occurs

Input Required

Description

tokenType

String

1

yes

OpenID token type

expires_in

Integer

1

yes

Expires in

id_token

String

1

yes

ID of the token

access_token

String

1

yes

Access token

refresh_token

String

1

yes

Refresh token

scope

String

1

yes

Scope

Storage Entities

Datastore Media Type

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

Attribute

Type

Occurs

Input Required

Description

datastoreUUID

String

1

yes

Unique identifier of the physical datastore

directory

String

1

optional

Directory of the datastore

enabled

boolean

1

yes

If true, the datastore is enabled to be used

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=4.2; application/vnd.abiquo.datastores+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Datastore Media Type

1..n

optional

The collection of Datastore Media Type elements

 

DatastoreTier Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

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

description

String

1

optional 

Description of the datastore tier

enabled

boolean

1

yes

If true, the tier is enabled for use

defaultAllowed

boolean

1

yes

If true, the tier 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

If true, 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=4.2; application/vnd.abiquo.datastoretiers+xml; version=4.2;

Attribute

Type

Occurs

Input Required

Description

collection

List of DatastoreTier Media Type

1..n

optional

The collection of DatastoreTier Media Type elements

 

DiskManagement Media Type

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

Attribute

Type

Occurs

Input Required

Description

idInteger1noIdentifier of the entity
labelString1optionalFriendly 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. See Template Compatibility Table
pathString1noPath on storage device
diskFileSizeLong1noSize of deployed disk in megabytes
diskControllerTypeDiskControllerType1optionalDisk controller with possible values of 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. It cannot be specified in the request, it can only be read after the VM is deployed in the hypervisor  

unit

Integer

1

read only

Unit identifier on the bus for hard disk attachment. It cannot be specified in the request, it can only be read after the virtualmachine is deployed in the hypervisor  

bootable

Boolean

1

yes

If true, the disk is suitable to boot (meaning it's possible to define it in a VM 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
allocationString1optionalAllocation type of the disk

 

DisksManagement Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of DiskManagement Media Type

1..n

optional

The collection of DiskManagement Media Type elements

 

DvdManagement Media Type

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

 
InitiatorMapping Media Type

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

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 the iSCSI target

targetLun

Integer

1

yes

LUN in the iSCSI device of the target, accessible by the initiator

 

InitiatorMappings Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of InitiatorMapping Media Type

1..n

optional

The collection of InitiatorMapping Media Type elements

 

MovedVolume Media Type

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

Attribute

Type

Occurs

Input Required

Description

volume

A VolumeManagement Media Type

1

optional

The volume that was moved


StorageDevice Media Type

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

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=4.2; application/vnd.abiquo.storagedevices+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of StorageDevice Media Type

1..n

optional

The collection of StorageDevice Media Type elements

 

StorageDeviceMetadata Media Type

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

Attribute

Type

Occurs

Input Required

Description

defaultServicePort

int

1

no

The default service port

defaultManagementPort

int

1

no

The default port of the management API of the device

requiresAuthentication

boolean

1

no

If true, 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=4.2; application/vnd.abiquo.storagedevicesmetadata+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of StorageDeviceMetadata Media Type

1..n

optional

The collection of StorageDeviceMetadata Media Type elements

 

 

StoragePool Media Type

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

Attribute

Type

Occurs

Input Required

Description

availableSizeInMb

long

1

yes

Available size in MB of the storage pool

enabled

boolean

1

no

If true, the storage pool is enabled

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.

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

Disk space used in the storage pool in megabytes 

 

 

StoragePools Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of StoragePool Media Type

1..n

optional

The collection of StoragePool Media Type elements

 

StoragePoolWithDevice Media Type

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

Attribute

Type

Occurs

Input Required

Description

availableSizeInMb

long

1

yes

Available size in megabytes of the storage pool.

device

StorageDevice Media Type

1

optional

Device that the storage pool belongs to.

enabled

boolean

1

no

If true, 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 megabytes 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=4.2; application/vnd.abiquo.storagepoolswithdevice+xml; version=4.2;

Attribute

Type

Occurs

Input Required

Description

collection

List of StoragePoolWithDevice Media Type

1..n

optional

The collection of StoragePoolWithDevice Media Type elements

 

StoragePoolWithTier Media Type

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

Attribute

Type

Occurs

Input Required

Description

availableSizeInMb

long

1

yes

Available size in MB of the storage pool.

enabled

boolean

1

no

If true, 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 that 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=4.2; application/vnd.abiquo.storagepoolswithtier+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of StoragePoolWithTier Media Type

1..n

optional

The collection of StoragePoolWithTier Media Type elements

 

Tier Media Type

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

Attribute

Type

Occurs

Input Required

Description

defaultAllowed

boolean

1

yes

If true, the tier is allowed by default for new enterprises

description

String

1

optional

Description of the tier

enabled

boolean

1

yes

If true, 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. The default is progressive

 

Tiers Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Tier Media Type

1..n

optional

The collection of Tier Media Type elements

 

VolumeManagement Media Type

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

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. It cannot be specified in the request, it can only be read after the VM 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 VM

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. It cannot be specified in the request, it can only be read after the VM 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=4.2; application/vnd.abiquo.iscsivolumes+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of VolumeManagement Media Type

1..n

optional

The collection of VolumeManagement Media Type elements

 

VolumeManagementWithVirtualMachine Media Type

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

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. It cannot be specified in the request, it can only be read after the VM 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 VM

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. It cannot be specified in the request, it can only be read after the VM 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, also containing the datacenter that the virtual datacenter belongs to

virtualAppliance

VirtualAppliance Media Type

1

no

Virtual appliance of the VM that the volume is attached to

virtualMachine

VirtualMachine Media Type

1

no

VM that the volume is attached to

storagePoolWithDevice

StoragePoolWithDevice Media Type

1

no

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

 

VolumesManagementWithVirtualMachine Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VolumeManagementWithVirtualMachine Media Type

1..n

optional

The collection of VolumeManagementWithVirtualMachine Media Type elements

 

Pricing Entities

CostCode Media Type

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

Attribute

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the cost code

description

String

1

yes

Description of the cost code

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

 

CostCodes Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of CostCode Media Type

1..n

optional

The collection of CostCode Media Type elements

 

CostCodeCurrency Media Type

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

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=4.2; application/vnd.abiquo.costcodecurrencies+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of CostCodeCurrency Media Type

1..n

optional

The collection of CostCodeCurrency Media Type elements

 

Currency Media Type

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

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=4.2; application/vnd.abiquo.currencies+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Currency Media Type

1..n

optional

The collection of Currency Media Type elements

 

PricingCostCode Media Type

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

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=4.2; application/vnd.abiquo.pricingcostcodes+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of PricingCostCode Media Type

1..n

optional

The collection of PricingCostCode Media Type elements

 

PricingTemplate Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

name

String

1

yes

Name of the pricing model

description

String

1

yes

Description of the pricing template

deployMessageString1optionalThe pricing estimate message

minimumCharge

Integer

1

yes

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

showChangesBefore

boolean

1

yes

If true, the platform will display the charges before deployment

minimumChargePeriod

BigDecimal

1

yes

Minimum charge per minimum period

showMinimumCharge

boolean

1

optional

If true, the platform will display the minimum charge  

chargingPeriod

Integer

1

yes

Indicates the period of time to charge the user for

standingChargePeriod

BigDecimal

1

yes

Standing charge per charging period

defaultTemplate

boolean

1

optional


lastUpdate

Date

1

no

Indicates the last modification

lastPriceUpdateDate1no

Indicates the last modification of the price of a pricing template

pricingCostCodesList of link to costcode
and BigDecimal price
1..nyesCost codes and prices
pricingTiersList of link to tiers
and BigDecimal price
1..nyesTiers and prices
pricingAbstractDatacenterslist of PricingAbstractDatacenter1..nyesPrices per datacenter
pricingDatastoreTiersList of link to datastore tiers
and BigDecimal price
1..nyesDatastore tiers and prices
pricingHardwareProfilesList of link to hardware profiles
and BigDecimal price
1..nyesTiers and prices

 

Contains links to:

  • Currency
  • Scope
  • Edit
PricingAbstractDatacenter

Used in the pricingtemplate media type.

It contains a link to the datacenter that it applies to

Attribute

Type

Occurs

Input Required

Description

hdGB

BigDecimal

1

yes

Price of hypervisor datastores per gigabyte

vlan

BigDecimal

1

yes

Price per VLAN

publicIp

BigDecimal

1

yes

Price per public IP address

vcpu

BigDecimal

1

yes

Price of CPU cores

vcpuOn

BigDecimal

1

yes

Price of CPU cores with the VM powered on

vcpuOff

BigDecimal

1

yes

Price of CPU cores with the VM powered off

memoryGB

BigDecimal

1

yes

Price of memory per gigabyte

memoryOnGB

BigDecimal

1

yes

Price of memory per gigabyte with the VM powered on

memoryOffGB

BigDecimal

1

yes

Price of memory per gigabyte with the VM powered off

repositoryGBBigDecimal1yesPrice of template repository in GB (conversions are not charged)

layer

BigDecimal

1

yes

Price of using antiaffinity functionality

firewallBigDecimal1yesPrice of a firewall
loadBalancer BigDecimalyes Price of a load balancer

 

PricingTemplates Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of PricingTemplate Media Type

1..n

optional

The collection of PricingTemplate Media Type elements

Billing Entities

Bill Media Type

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

Attribute

Type

Occurs

Input Required

Description

provider

String

1

yes

Name of the provider, which also identifies the provider and displays in the provider selectors of the billing dashboard widgets. For example, 'Amazon' or 'Azure', or a custom provider name

date

String

1

yes

Date of the bill UTC format: yyyy/MM/dd HH:mm:ss Z (where 'Z' is the adjustment for the time zone, for example, 2018/04/19 23:59:59 +0000).

priceBigDecimal1yesAmount for this provider. If the bill entity represents a past bill, this is the total amount of the bill. If the bill entity represents a cost record for creating an estimate, this is the cost for a day.
currencyCodeString1optionalCurrency code as in Abiquo pricing, for example, USD
billingPeriodStartDateDate1yesStart of billing period in UTC format
billingPeriodEndDateDate1yesEnd of the biling period in UTC format

totalVms

Integer

1

yes

Number of VMs in this provider; used to calculate the average cost per VM in the UI

estimatedBigDecimal1see noteIf the bill entity represents a past bill, this value is not given. If the bill entity represents a provider estimate, this value is the estimated cost for the period. If the bill entity represents a cost record for calculating an estimate, this value must be set to 0.
Bills Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Bill Media Type

1..n

optional

The collection of Bill Media Type elements


BillProviders Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of String

1..n

optional

The collection of BillProvider Media Type elements


Scheduler Entities

EnterpriseExclusionRule Media Type

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

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"/>

 

EnterpriseExclusionsRules Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of EnterpriseExclusionRule Media Type

1..n

optional

The collection of EnterpriseExclusionRule Media Type elements

 

FitPolicyRule Media Type

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

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=4.2; application/vnd.abiquo.fitpolicyrules+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of FitPolicyRule Media Type

1..n

optional

The collection of FitPolicyRule Media Type elements

 

MachineLoadRule Media Type

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

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, this rule applies to the sum of the resources in the machines affected by the rule, even those that are powered off

 

MachineLoadRules Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of MachineLoadRule Media Type

1..n

optional

The collection of MachineLoadRule Media Type elements

 

DatastoreLoadRule Media Type

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

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=4.2; application/vnd.abiquo.datastoreloadrules+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of DatastoreLoadRule Media Type

1..n

optional

The collection of DatastoreLoadRule Media Type elements

 

Rules Media Type

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

Attribute

Type

Occurs

Input Required

Description

enterpriseExclusionRules

EnterpriseExclusionsRules Media Type

1

optional

 

fitPolicyRules

FitPolicyRules Media Type

1

optional

 

machineLoadRules

MachineLoadRules Media Type

1

optional

 
datastoreLoadRulesDatastoreLoadRules Media Type1optional 

 

Statistics Entities

CloudUsage Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the Entity

numEnterprisesCreated

long

1

no

Total number of enterprises in the platform

numUsersCreated

long

1

no

Total number of users in the platform

numVdcCreated

long

1

no

Total number of virtual datacenters in the platform

publicIPsReserved

long

1

no

Total number of IPs assigned to a virtual datacenter (reserved)

publicIPsTotal

long

1

no

Total number of IPs defined (managed)

publicIPsUsed

long

1

no

Total number of IPs used by VMs

serversRunning

long

1

no

Total number of physical machines that are currently running

serversTotal

long

1

no

Total number of physical machines managed by the platform

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 the platform (in megabytes)

storageTotal

long

1

no

External storage managed by the platform

storageUsedInMb

long

1

no

External storage used (attached or mounted) by any VMs (in megabytes)

storageUsed

long

1

no

External storage used (attached or mounted) by any VMs

virtualCpuReserved

long

1

no

Maximum number of virtual CPUs reserved by all enterprises

virtualCpuTotal

long

1

no

Total number of virtual CPUs managed that are available for VMs

virtualCpuUsed

long

1

no

Number of virtual CPUs used in VMs that are currently in a running state

virtualMachinesRunning

long

1

no

Total number of VMs currently in a running state

virtualMachinesTotal

long

1

no

Total number of VMs managed by the platform

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 (that can be used for VMs) in megabytes

virtualMemoryTotal

long

1

no

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

virtualMemoryUsedInMb

long

1

no

Total amount of RAM used by VMs currently in a running state in megabytes

virtualMemoryUsed

long

1

no

Total amount of RAM used by VMs currently in a running state

virtualStorageReservedInMb

long

1

no

Maximum storage size reserved by all enterprises for VMs in megabytes

virtualStorageReserved

long

1

no

Maximum storage size reserved by all enterprises for VMs

virtualStorageTotalInMb

long

1

no

Total storage size managed for use by VMs in megabytes

virtualStorageTotal

long

1

no

Total storage size managed for use by VMs

virtualStorageUsedInMb

long

1

no

Total storage size used by VMs currently in a running state in megabytes

virtualStorageUsed

long

1

no

Total storage size used by VMs 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 VM templates, which does not include coversions, in megabytes

repositoryUsed

long

1

no

Total repository used by VM 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=4.2; application/vnd.abiquo.cloudusages+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of CloudUsage Media Type

1..n

optional

The collection of CloudUsage Media Type elements

 

EnterpriseResources Media Type

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

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 VMs 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 VMs currently in a running state in megabytes

localStorageUsed

long

1

no

Total storage size used by VMs 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 VMs currently in a running state in megabytes

memoryUsed

long

1

no

Total amount of RAM used by VMs 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 Virtual datacenter (Reserved)

publicIPsUsed

long

1

no

Total number of IPs used by VMs

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

lbsNotUsed

long

1

no

Total number of load balancers created but not used

 

EnterprisesResources Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of EnterpriseResources Media Type

1..n

optional

The collection of EnterpriseResources Media Type elements

 

StatisticIp Media Type

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

Attribute

Type

Occurs

Input Required

Description

ip

String

1

yes

IP address

providerId

int

1

no

Identifier of the IP in the remote provider

vlanName

STring

1

no

Name of the VLAN that the IP belongs to

 

StatisticIps Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of StatisticIp Media Type

1..n

optional

The collection of StatisticIp Media Type elements


VirtualAppResources Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the VM template definition.

idEnterprise

int

1

no

Identifier of the enterprise.

idVirtualDataCenter

int

1

no

Identifier of the virtual data center.

vappName

String

1

no

Name of this virtual appliance.

vdcName

String

1

no

Name of the virtualdatacenter.

vmActive

int

1

no

Number of VMs currently running in this virtual appliance.

vmCreated

int

1

no

Number of VMs created in this virtual appliance.

volAttached

int

1

no

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

 

VirtualAppsResources Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualAppResources Media Type

1..n

no

The collection of VirtualAppResources Media Type elements

 

VirtualDatacenterResources Media Type

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

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 VMs in megabytes

extStorageUsed

long

1

no

External storage used (attached or mounted) by VMs

idEnterprise

int

1

no

Identifier of the enterprise

localStorageReservedInMb

long

1

no

Maximum storage size reserved for this enterprise in this virtual datacenter for VMs in megabytes.

localStorageReserved

long

1

no

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

localStorageUsedInMb

long

1

no

Total storage size used by VMs currently in a running state in megabytes.

localStorageUsed

long

1

no

Total storage size used by VMs 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 VMs currently in a running state in megabytes.

memoryUsed

long

1

no

Total amount of RAM used by VMs currently in a running state

publicIPsReserved

long

1

no

Total number of public IPs obtained by this virtualDatacenter

publicIPsUsed

long

1

no

Total number of public IPs used by VMs

vdcName

String

1

no

Name of the virtual datacenter

virtualCpuReserved

long

1

no

The virtual CPU reserved.

virtualCpuUsed

long

1

no

Total number of virtual CPUs in VMs 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 VMs currently running in this virtual datacenter.

vmCreated

int

1

no

Number of VMs created in this virtual datacenter.

volAttached

int

1

no

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

volCreated

int

1

no

Number of volumes created in this virtual datacenter.

cpuHard

int

1

yes

Total number of virtual CPUs that may be used by VMs. Hard limit

cpuSoft

int

1

yes

Total number of virtual CPUs that may be used by VMs. Soft limit

hdHard

long

1

yes

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

hdSoft

long

1

yes

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

publicIpsHard

long

1

yes

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

publicIpsSoft

long

1

yes

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

ramHard

int

1

yes

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

ramSoft

int

1

yes

Total amount of RAM memory that may be used by VMs. 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 number of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total number of VLANs that may be defined. Soft limit

VirtualDatacentersResources Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualDatacenterResources Media Type

1..n

optional

The collection of VirtualDatacenterResources Media Type elements

 

VirtualMachineLastDeployed Media Type

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

Attribute

Type

Occurs

Input Required

Description

virtualMachineLabel

String

1

no

Label of the VM, which is the VM friendly name, by default the template name

state

VirtualMachineState

1

no

The current state of the VM

startTime

String

1

no

The time when the VM was started up

VirtualMachinesLastDeployed Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualMachineLastDeployed Media Type

1..n

optional

The collection of VirtualMachineLastDeployed Media Type elements


VirtualMachineMostTimeOn Media Type

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

Attribute

Type

Occurs

Input Required

Description

virtualMachineLabel

String

1

no

Label of the VM, which is the VM friendly name used in the UI. By default it is the template name

state

VirtualMachineState

1

no

The current state of the VM

periods

Long

1

no

The number of hours that the VM has been in a running state


VirtualMachinesMostTimeOn Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualMachineMostTimeOn Media Type

1..n

optional

The collection of VirtualMachineMostTimeOn Media Type elements

VirtualMachineUsage Media Type

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

Attribute

Type

Occurs

Input Required

Description

statName

String

1

no

Statistic name

average

Double

1

no

Average of the statistic

maximum

Double

1

no

Maximum of the statistic

minimum

Double

1

no

Minimum of the statistic

virtaulmachineLabel

String

1

no

Friendly name of the VM, which by default is the template name

virtualMachineName

String

1

no

Name of the VM, which by default is ABQ_uuid

VirtualMachineUsages Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of VirtualMachineUsage Media Type

1..n

optional

The collection of VirtualMachineUsage Media Type elements

Workload Media Type

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

Attribute

Type

Occurs

Input Required

Description

countVms

Long

1

no

Number of VMs in a datacenter and on a specific hypervisor type


Workloads Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Workload Media Type

1..n

optional

The collection of Workload Media Type elements


Task Entities

Job Media Type

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

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=4.2; application/vnd.abiquo.jobs+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Job Media Type

1..n

no

The collection of Job Media Type elements

 

JobExtended Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

String

1

yes

Identifier of the job

parentTaskId

String

1

no

Identifier of the parent task

type

JobType

1

yes

Type of job

description

String

1

no

Description of the job

state

JobState

1

no

Current state of the job

rollbackState

JobState

1

no

Current rollback state of the job

creationTimestamp

Long

1

yes

Creation timestamp in standard UNIX timestamp format

timestamp

Long

1

yes

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

progress

Integer

1

optional

 

errorCause

String

1

optional

 

guestInitialPasswordString1no

Password generated for the guest during the deploy process. This attribute will only appear if the deploy process generated a random password for the guest
and the user that requests the job is the owner of the virtual machine.

 

JobsExtended Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of JobExtended Media Type

1..n

no

The collection of JobExtended Media Type elements

 

Task Media Type

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

Attribute

Type

Occurs

Input Required

Description

creationTimestamp

Long

1

yes

Creation timestamp in standard UNIX timestamp format

jobs

Jobs Media Type

1

no

Collection of jobs in 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 format

type

TaskType

1

yes

Type of 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=4.2; application/vnd.abiquo.tasks+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Task Media Type

1..n

no

The collection of Task Media Type elements

 

TaskExtended Media Type

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

Attribute

Type

Occurs

Input Required

Description

creationTimestamp

Long

1

yes

Creation timestamp in standard UNIX timestamp format

jobs

Jobs Media Type

1

no

Collection of jobs in the task

jobsExtended

JobsExtended Media Type

1

no

Extended collection of jobs in 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 fromat

type

TaskType

1

yes

Type of task

userId

String

1

no

Identifier of the user who created the task

 

User Enterprise Entities

PublicCloudCredentials Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the credentials

key

String

1

yes

Key for the credentials

access

String

1

yes

Access identifier of the credentials

 

PublicCloudCredentialsList Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of PublicCloudCredentials Media Type

1..n

no

The collection of PublicCloudCredentials Media Type elements


DatacenterLimits Media Type

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

Attribute

Type

Occurs

Input Required

Description

cpuHard

int

1

yes

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

cpuSoft

int

1

yes

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

enabledHardwareProfilesBoolean1yesIf true, hardware profiles are enabled for this enterprise in the datacenter

hdHard

long

1

yes

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

hdSoft

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 number of Public IPs that may be defined. Hard limit

publicIpsSoft

long

1

yes

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

ramHard

int

1

yes

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

ramSoft

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 number of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total number of VLANs that may be defined. Soft limit

 

DatacentersLimits Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of DatacenterLimits Media Type

1..n

optional

The collection of DatacenterLimits Media Type elements

 

Enterprise Media Type

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

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

cpuHard

int

1

yes

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

cpuSoft

int

1

yes

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

hdHard

long

1

yes

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

hdSoft

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

Name of the enterprise

publicIpsHard

long

1

yes

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

publicIpsSoft

long

1

yes

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

ramHard

int

1

yes

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

ramSoft

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 number of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total number 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=4.2; application/vnd.abiquo.enterprises+xml; version=4.2;

Attribute

Type

Occurs

Input Required

Description

collection

List of Enterprise Media Type

1..n

optional

The collection of Enterprise Media Type elements

 

EnterpriseIdName Media Type

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

Attribute

Type

Occurs

Input Required

Description

cpuHard

int

1

yes

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

cpuSoft

int

1

yes

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

hdHard

long

1

yes

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

hdSoft

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 number of Public IPs that may be defined. Hard limit

publicIpsSoft

long

1

yes

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

ramHard

int

1

yes

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

ramSoft

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 number of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total number 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=4.2; application/vnd.abiquo.enterprises-id-name+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of EnterpriseIdName Media Type

1..n

optional

The collection of EnterpriseIdName Media Type elements

 

EnterpriseProperties Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

no

Deprecated. Use enterprise link instead. 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=4.2; application/vnd.abiquo.enterprisetheme+xml; version=4.2;

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)

cpuHard

int

1

yes

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

cpuSoft

int

1

yes

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

hdHard

long

1

yes

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

hdSoft

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

Name of the enterprise

publicIpsHard

long

1

yes

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

publicIpsSoft

long

1

yes

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

ramHard

int

1

yes

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

ramSoft

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 number of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total number of VLANs that may be defined. Soft limit

 

TwoFactorAuthCredentials Media Type

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

Attribute

Type

Occurs

Input Required

Description

authenticatorURL

String

1

yes

URL of the authenticator for two-factor authentication

provider

String

1

yes

Provider for two-factor authentication

scratchcodesList of scratchcode String1..nyesScratch codes for two-factor authentication


TwoFactorAuthProvider Media Type

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

Attribute

Type

Occurs

Input Required

Description

type

String

1

yes

Type of the provider for two-factor authentication


 


User Role and Scope and Privilege Entities

Privilege Media Type

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

Attribute

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the privilege

name

String

1

yes

Name of the privilege

eventsList of event String1noList of the events that this privilege allows a user to retrieve

 

Privileges Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Privilege Media Type

1..n

optional

The collection of Privilege Media Type elements

 

Role Media Type

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

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

Name of the role

 

Roles Media Type

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

Attribute

Type

Occurs

Input Required

Description

collection

List of Role Media Type

1..n

optional

The collection of Role Media Type elements

RoleWithPrivileges Media Type

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

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 of roles that map to this role. Required in external authentication mode (openid, ldap)

name

String

1

yes

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=4.2; application/vnd.abiquo.scope+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

automaticAddDatacenter

boolean

1

optional

If true, all new datacenters created are added into this scope

automaticAddEnterprise

boolean

1

optional

If true, all new enterprises created are added into this scope

id

Integer

1

optional

Identifier 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=4.2; application/vnd.abiquo.scopes+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Scope Media Type

1..n

optional

The collection of Scope Media Type elements

 

ScopeEntity Media Type

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

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=4.2; application/vnd.abiquo.application+xml; version=4.2;

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=4.2; application/vnd.abiquo.applications+xml; version=4.2;

Attribute

Type

Occurs

Input Required

Description

collection

List of Application Media Type

1..n

optional

The collection of Application Media Type elements

 

Session Media Type

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

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

Identifier 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=4.2; application/vnd.abiquo.sessions+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of Session Media Type

1..n

optional

The collection of Session Media Type elements

 

User Media Type

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

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=4.2; application/vnd.abiquo.users+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of User Media Type

1..n

optional

The collection of User Media Type elements

 

UserWithRole Media Type

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

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=4.2; application/vnd.abiquo.userswithroles+xml; version=4.2; 

Attribute

Type

Occurs

Input Required

Description

collection

List of UserWithRole Media Type

1..n

optional

The collection of UserWithRole Media Type elements