Skip to end of metadata
Go to start of metadata

 

Appliance Library Entities

TemplateDefinition Media Type

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

Field

Type

Occurs

Input Required

Description

description

String

1

yes

Description of the template definition

diskControllerType

DiskControllerType

1

optional

Kind of controller type (IDE or SCSI) additionally, from Abiquo 3.1.3 on KVM (VIRTIO)

NOTE not all the hypervisor plugins will use this info

diskFileSize

long

1

yes

The disk file size in MegaBytes of the disk file

diskFormatType

String

1

yes

Disk format type of the disk file @see {@link DiskFormatType}

ethernetDriverType

EthernetDriverType

1

optional

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

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

iconUrl

String

1

optional

The URI of the icon of the template definition

id

Integer

1

yes

Identifier of the template definition

loginPassword

String

1

optional

Default login password

loginUser

String

1

optional

Default login user

name

String

1

yes

Name of the template definition

osType

OSType

1

optional

Kind of Operating System

osVersion

String

1

optional

Additional info for the ''osType''

productName

String

1

optional

Additional info about the installed software

productUrl

String

1

optional

Link to additional info about the installed software

productVendor

String

1

optional

Additional info about the installed software

productVersion

String

1

optional

Additional version info about the installed software

url

String

1

yes

URL of the source .ovf Envelope document.

 

 

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachineTemplatePersistent Media Type

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

Field

Type

Occurs

Input Required

Description

persistentTemplateName

String

1

yes

Name for the new persistent virtual machine template

persistentVolumeName

String

1

optional

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

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Categories Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Category Media Type

1..n

optional

The collection of List of Category Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachineTemplate Media Type

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

Field

Type

Occurs

Input Required

Description

chefEnabled

boolean

1

optional

Determine if its suitable for the Chef integration feature

costCode

Integer

1

optional

Cost code identifier

cpuRequired

Integer

1

yes

The number of CPU required

coresPerSocketInteger1optional

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

creationDate

Date

1

no

Creation date

creationUser

String

1

no

Nickname of the creation user

description

String

1

optional

Description of the virtual machine template

diskControllerType

DiskControllerType

1

optional

Kind of controller type (IDE or SCSI)

NOTE not all the hypervisor plugins will use this info

diskFileSize

Long

1

yes

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

diskFormatType

String

1

yes

Disk format type of the virtual machine template @see {@link DiskFormatType}

ethernetDriverType

EthernetDriverType

1

optional

Kind of network driver (PCNet32, VMXNET3 or E1000)

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

hdRequired

Long

1

optional

The HD required in bytes for the virtual machine template (Primary disk capacity)

iconUrl

String

1

optional

The URI of the icon of the virtual machine template

id

Integer

1

yes

Identifier of the virtual machine template

loginPassword

String

1

optional

Default login password

loginUser

String

1

optional

Default login user

name

String

1

yes

Name of the virtual machine template

osType

OSType

1

optional

Kind of Operating System

osVersion

String

1

optional

Additional info for the ''osType''

path

String

1

yes

Path relative to the Abiquo datacenter repository of the virtual machine template disk file

ramRequired

Integer

1

yes

The RAM in MegaBytes required for the virtual machine template

shared

boolean

1

yes

Determine if virtual machine template can be used in other enterprises

state

VMTemplateState

1

no

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

    • UNAVAILABLE, the template disk is missing the the repository filesystem, but some virtual machines or instances are using it.
    • IN_PROGRESS, a download or promote task is running
    • FAILED, a download or promote task was finish unsuccessfully
    • DONE the template is available and ready to use

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

DiskFormatType Media Type

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

Field

Type

Occurs

Input Required

Description

alias

DiskFormatTypeAlias

1

optional

Alias of the disk format type

description

String

1

optional

Description of the type

id

Integer

1

optional

Identifier of the entity

uri

String

1

optional

URI of the Disk Format type

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Conversion Media Type

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

Field

Type

Occurs

Input Required

Description

sourceFormat

DiskFormatType

1

yes

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

sourcePath

String

1

yes

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

startTimestamp

Date

1

yes

When the conversion starts

state

ConversionState

1

yes

Result status of the conversion

targetFormat

DiskFormatType

1

yes

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

targetPath

String

1

yes

Path relative to the Abiquo repository of resulting template disk file

targetSizeInBytes

Long

1

yes

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

DatacenterRepositories Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of DatacenterRepository Media Type

1..n

optional

The collection of List of DatacenterRepository Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Category Media Type

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

Field

Type

Occurs

Input Required

Description

defaultCategory

boolean

1

yes

true if the category is default

erasable

boolean

1

yes

true if the category is erasable

id

Integer

1

optional

Identifier of the entity

name

String

1

yes

Name of the category

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

TemplateDefinitions Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of TemplateDefinition Media Type

1..n

no

The collection of List of TemplateDefinition Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

DiskFormatTypes Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of DiskFormatType Media Type

1..n

optional

The collection of List of DiskFormatType Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachineTemplateRequest Media Type

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

Field

Type

Occurs

Input Required

Description

promotedName

String

1

optional

Name for the new promoted virtual machine template

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')


TemplateDefinitionLists Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of TemplateDefinitionList Media Type

1..n

no

The collection of List of TemplateDefinitionList Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

TemplateDefinitionList Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

yes

Identifier of the template definition list

name

String

1

yes

Name of the template definition list

templateDefinitions

TemplateDefinitions Media Type

1

optional

The template definitions of the list

url

String

1

optional

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

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Conversions Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Conversion Media Type

1..n

no

The collection of List of Conversion Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachineTemplates Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VirtualMachineTemplate Media Type

1..n

no

The collection of List of VirtualMachineTemplate Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

DatacenterRepository Media Type

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

Field

Type

Occurs

Input Required

Description

error

String

1

optional

Any error in repository

name

String

1

yes

Name of the datacenter repository

repositoryCapacityMb

long

1

optional

Capacity of repository in MB

repositoryLocation

String

1

yes

The repository location

repositoryRemainingMb

long

1

optional

Remaining capacity of the repository in MB

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Base Entities

Links Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Link Media Type

1..n

no

The collection of List of Link Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Link Media Type

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

Field

Type

Occurs

Input Required

Description

link

RESTLink

1

yes

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

AcceptedRequest Media Type

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

Field

Type

Occurs

Input Required

Description

entity

Object

1

optional

The returning entity. Normally a message.

statusLink

RESTLink

1

optional

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Errors Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Error Media Type

1..n

optional

The collection of List of Error Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Error Media Type

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

Field

Type

Occurs

Input Required

Description

code

String

1

optional

 

message

String

1

optional

 

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Cloud Entities

VirtualMachineInstance Media Type

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

Field

Type

Occurs

Input Required

Description

instanceName

String

1

yes

Instance name

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualAppliancePrice Media Type

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

Field

Type

Occurs

Input Required

Description

additionalVolumCost

BigDecimal

1

yes

Value for the volume.

antiaffinityCost

BigDecimal

1

yes

Value for antiaffinity.

computeCost

BigDecimal

1

yes

Value for the CPU, memory.

costCodeCost

BigDecimal

1

yes

Value for the image being deployed.

minimumCharge

Integer

1

yes

Minimum Charge.

minimumChargePeriod

BigDecimal

1

yes

Value for minimum charge period.

networkCost

BigDecimal

1

yes

Value for public IPs.

standingCharge

BigDecimal

1

yes

Value for deploy.

storageCost

BigDecimal

1

yes

Value for the datastore.

totalCost

BigDecimal

1

yes

Value total.

 

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

Pricing Period CodeDescription
0MINUTE
1HOUR
2DAY
3WEEK
4MONTH
5QUARTER
6YEAR

 

 

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachineWithNode Media Type

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

Field

Type

Occurs

Input Required

Description

cpu

Integer

1

yes

Number of CPUs of the virtual machine.

description

String

1

optional

 

dvd

DvdManagement Media Type

1

optional

Whether the virtual machine must mount a CD or DVD drive.

hdInBytes

Long

1

yes

Hard disk size in Bytes.

highDisponibility

int

1

yes

Deprecated

id

Integer

1

no

Opaque ID of the virtual machine.

idState

int

1

optional

Opaque ID of the state.

idType

int

1

optional

Opaque ID of the virtual machine type.

keymap

String

1

optional

Keyboard keymap to be setted on the virtual machine.

name

String

1

yes

Name of the virtual machine.

nodeId

Integer

1

optional

Node ID, nothing to do with the virtual machine ID

nodeName

String

1

yes

Friendly name to be displayed. Only used in the Abiquo flex client

password

String

1

optional

VNC password.

ram

Integer

1

yes

Ram size of the virtual machine.

runlist

RunlistElements Media Type

1

optional

Chef runlist to bootstrap.

state

VirtualMachineState

1

optional

Current virtual machine state.

uuid

String

1

no

UUID of the virtual machine.

vdrpIP

String

1

no

Virtual remote desktop IP.

vdrpPort

int

1

no

Virtual remote desktop port.

x

int

1

yes

X coordinate

y

int

1

yes

Y coordinate

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachineState Media Type

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

Field

Type

Occurs

Input Required

Description

state

VirtualMachineState

1

yes

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachineTask Media Type

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

Field

Type

Occurs

Input Required

Description

forceUndeploy

Boolean

1

optional

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualApplianceState Media Type

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

Field

Type

Occurs

Input Required

Description

power

VirtualApplianceState

1

no

Machine power state. Current state of the virtual appliance. The state is inferred from its
virtual machines

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Bootstrap Media Type

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

Field

Type

Occurs

Input Required

Description

chefConfig

ChefBootstrap

1

no

Chef configuration.

nodeName

String

1

no

Name of the chef node.

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

RunlistElements Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of RunlistElement Media Type

1..n

no

The collection of List of RunlistElement Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

RunlistElement Media Type

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

Field

Type

Occurs

Input Required

Description

description

String

1

optional

The description of the runlist element.

name

String

1

yes

The name of the runlist element.

priority

int

1

yes

Order in which this runlist element should be applied.

selected

boolean

1

yes

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Layers Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Layer Media Type

1..n

optional

The collection of List of Layer Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachinesWithNodeExtended Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VirtualMachineWithNodeExtended Media Type

1..n

optional

The collection of List of VirtualMachineWithNodeExtended Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachine Media Type

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

Field

Type

Occurs

Input Required

Description

cpu

Integer

1

yes

Number of CPUs of the virtual machine.

coresPerSocketInteger1optional

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

description

String

1

optional

 

dvd

DvdManagement Media Type

1

optional

Whether the virtual machine must mount a CD or DVD drive.

hdInBytes

Long

1

yes

Hard disk size in Bytes.

highDisponibility

int

1

yes

Deprecated

id

Integer

1

no

Opaque ID of the virtual machine.

idState

int

1

optional

Opaque ID of the state.

idType

int

1

optional

Opaque ID of the virtual machine type.

keymap

String

1

optional

Keyboard keymap to be setted on the virtual machine.

name

String

1

yes

Name of the virtual machine.

password

String

1

optional

VNC password.

ram

Integer

1

yes

Ram size of the virtual machine.

runlist

RunlistElements Media Type

1

optional

Chef runlist to bootstrap.

state

VirtualMachineState

1

optional

Current virtual machine state.

uuid

String

1

no

UUID of the virtual machine.

vdrpIP

String

1

no

Virtual remote desktop IP.

vdrpPort

int

1

no

Virtual remote desktop port.

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

HypervisorDiscovery Media Type

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

Field

Type

Occurs

Input Required

Description

ipFrom

String

1

yes

Starting IP

ipTo

String

1

yes

Ending IP

password

String

1

yes

Hypervisor password

port

Integer

1

yes

Hypervisor port

type

HypervisorType

1

yes

Hypervisor type

user

String

1

yes

Hypervisor credentials

vSwitch

String

1

yes

VSwitch

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

HypervisorType Media Type

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

Field

Type

Occurs

Input Required

Description

baseFormat

DiskFormatType

1

yes

Base format of the hypervisor type

compatibilityTable

DiskFormatType[]

1

optional

Compatibility of the hypervisor type

defaultPort

int

1

yes

Default port of the hypervisor type

id

Integer

1

optional

Opaque ID of the hypervisor type

name

String

1

yes

Name of the hypervisor type

realName

String

1

yes

Friendly name of the hypervisor type

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

HypervisorTypes Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of HypervisorType Media Type

1..n

optional

The collection of List of HypervisorType Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachinesWithNode Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VirtualMachineWithNode Media Type

1..n

optional

The collection of List of VirtualMachineWithNode Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachines Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VirtualMachine Media Type

1..n

optional

The collection of List of VirtualMachine Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualDatacenters Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VirtualDatacenter Media Type

1..n

no

The collection of List of VirtualDatacenter Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualAppliance Media Type

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

Field

Type

Occurs

Input Required

Description

error

int

1

no

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

highDisponibility

int

1

optional

Deprecated.

id

Integer

1

no

Opaque ID of the virtual appliance.

lastTasks

Tasks Media Type

1

no

Last task of every virtual machine.

name

String

1

yes

Name of the virtual appliance.

nodeconnections

String

1

optional

Logical connections made through the Abiquo flex client.

publicApp

int

1

optional

Deprecated.

state

VirtualApplianceState

1

no

Current state. Inferred from its virtual machines

subState

VirtualApplianceState

1

optional

Deprecated.

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualAppliances Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VirtualAppliance Media Type

1..n

no

The collection of List of VirtualAppliance Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualDatacenterWithDatacenter Media Type

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

Field

Type

Occurs

Input Required

Description

cpuCountHardLimit

int

1

yes

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

cpuCountSoftLimit

int

1

yes

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

datacenter

Datacenter Media Type

1

no

Datacenter which belongs the virtual datacenter.

hdHardLimitInMb

long

1

yes

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

hdSoftLimitInMb

long

1

yes

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

hypervisorType

HypervisorType

1

yes

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

id

Integer

1

no

Opaque ID of the virtual datacenter.

name

String

1

yes

Virtual datacenter's name.

publicIpsHard

long

1

yes

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

publicIpsSoft

long

1

yes

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

ramHardLimitInMb

int

1

yes

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

ramSoftLimitInMb

int

1

yes

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

storageHard

long

1

yes

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

storageSoft

long

1

yes

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

vlan

VLANNetwork Media Type

1

yes

Virtual datacenter network.

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Layer Media Type

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

Field

Type

Occurs

Input Required

Description

name

String

1

yes

Name of the layer

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualDatacenter Media Type

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

Field

Type

Occurs

Input Required

Description

cpuCountHardLimit

int

1

yes

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

cpuCountSoftLimit

int

1

yes

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

hdHardLimitInMb

long

1

yes

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

hdSoftLimitInMb

long

1

yes

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

hypervisorType

HypervisorType

1

yes

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

id

Integer

1

no

Opaque ID of the virtual datacenter.

name

String

1

yes

Virtual datacenter's name.

publicIpsHard

long

1

yes

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

publicIpsSoft

long

1

yes

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

ramHardLimitInMb

int

1

yes

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

ramSoftLimitInMb

int

1

yes

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

storageHard

long

1

yes

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

storageSoft

long

1

yes

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

vlan

VLANNetwork Media Type

1

yes

Virtual datacenter network.

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualMachineWithNodeExtended Media Type

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

Field

Type

Occurs

Input Required

Description

cpu

Integer

1

yes

Number of CPUs of the virtual machine.

description

String

1

optional

 

dvd

DvdManagement Media Type

1

optional

Whether the virtual machine must mount a CD or DVD drive.

enterpriseName

String

1

no

Enterprise name to which belongs the user who owns this virtual machine.

hdInBytes

Long

1

yes

Hard disk size in Bytes.

highDisponibility

int

1

yes

Deprecated

id

Integer

1

no

Opaque ID of the virtual machine.

idState

int

1

optional

Opaque ID of the state.

idType

int

1

optional

Opaque ID of the virtual machine type.

keymap

String

1

optional

Keyboard keymap to be setted on the virtual machine.

name

String

1

yes

Name of the virtual machine.

nodeId

Integer

1

optional

Node ID, nothing to do with the virtual machine ID

nodeName

String

1

yes

Friendly name to be displayed. Only used in the Abiquo flex client

password

String

1

optional

VNC password.

ram

Integer

1

yes

Ram size of the virtual machine.

runlist

RunlistElements Media Type

1

optional

Chef runlist to bootstrap.

state

VirtualMachineState

1

optional

Current virtual machine state.

userName

String

1

no

User's name who owns this virtual machine.

userSurname

String

1

no

User's surname who owns this virtual machine.

uuid

String

1

no

UUID of the virtual machine.

vdrpIP

String

1

no

Virtual remote desktop IP.

vdrpPort

int

1

no

Virtual remote desktop port.

x

int

1

yes

X coordinate

y

int

1

yes

Y coordinate

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Load Balancer Media Type

Define the configuration of the workload distribution across virtual machines.
application/vnd.abiquo.loadbalancer

Field

Type

Occurs

Input Required

Description

name

String

1

true

Friendly name

algorithm

String (note_algorithm)

1

true

Distribution strategy

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

routingRules

Routing Rules Media Type

1

true during POST

Initial routing rules

healthChecks

Health Check Media Type

1

false

Initial health checks

note_algorithm valid *algorithm* values based on plugin constrain *LOADBALANCER_ALGORITHMS_CSV* :
curl -XGET http://10.60.1.223/api/config/hypervisortypes
note loadBalancerAddresses/routingRules/healthChecks only used during POST request, not returned in the responses (will return links )

Routing Rule Media Type

Define forward functions in the load balancer
application/vnd.abiquo.routingrule

Field

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

portOut

Integer

1

true

outbound port

protocolOut

String

1

true

outbound protocol

valid *protocolIn/Out* values based on plugin constrain *LOADBALANCER_ROUTINGRULES_PROTOCOLS_CSV* :
curl -XGET http://10.60.1.223/api/config/hypervisortypes

Health Check Media Type

Define how to know if a certain virtual machine is suitable to accept traffic from the load balancer
application/vnd.abiquo.healthcheck

Field

Type

Occurs

Input Required

Description

name

String

1

true

Friendly name

providerId

String

1

false

Identifies the health check in the provider

protocol

String

1

true

Connection type to perform the check

port

Integer

1

true

Where open the connection during the check. 0, 65535

intervalInMs

Integer

1

true

Time between checks

timeoutInMs

Integer

1

true

Time to wait during the check

attempts

Integer

1

true

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

path

String

1

false

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

statusRegex

String

1

false

Regular expression to match a healthy node during check response status. (example ''^2340-90-9$'')

bodyRegex

String

1

false

Regular expression to match a healthy node during check response body

timout < interval
valid *protocol* values based on plugin constrain *LOADBALANCER_HEALTHCHECK_PROTOCOLS_CSV* :
curl -XGET http://10.60.1.223/api/config/hypervisortypes

Load Balancer Address Media Type

Address to be used to reach the load balancer
application/vnd.abiquo.loadbalanceraddress

Field

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

 

Configuration Entities

Licenses Media Type

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

Field

Type

Occurs

Input Required

Description

availablecores

Integer

1

optional

 

collection

List of License Media Type

1..n

optional

The collection of List of License Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

SystemProperties Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of SystemProperty Media Type

1..n

optional

The collection of List of SystemProperty Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

License Media Type

Changes in Abiquo 3.1

The License media type has changed in Abiquo 3.1. Please see API Changelog v3.1.

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

Field

Type

Occurs

Input Required

Description

active

boolean

1

optional

 

code

String

1

yes

The license code

expiration

String

1

no

The expiration date of the license

id

Integer

1

no

The identifier of the entity

numcores

Integer

1

no

The number of cores that the license enables

enabledPluginsString1optionalThe plugins that are enabled by the license

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

SystemProperty Media Type

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

Field

Type

Occurs

Input Required

Description

description

String

1

optional

A desription of the usage of the property

id

Integer

1

no

Identifier of the entity

name

String

1

yes

The name of the property

value

String

1

yes

The value of the property

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Enterprise Entities

DatacentersLimits Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of DatacenterLimits Media Type

1..n

optional

The collection of List of DatacenterLimits Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

ScopeEntity Media Type

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

Field

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' from version 2.2

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Sessions Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Session Media Type

1..n

optional

The collection of List of Session Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Privilege Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the privilege

name

String

1

yes

Name of the privilege

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

EnterpriseProperties Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the Entity

properties

Map

1

no

Properties set for this enterprise

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Scopes Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Scope Media Type

1..n

optional

The collection of List of Scope Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Role Media Type

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

Field

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

ldap

String

1

no

The LDAP group that the user belongs to. Required in LDAP mode

name

String

1

yes

The name of the role

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Enterprises Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Enterprise Media Type

1..n

optional

The collection of List of Enterprise Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

UserWithRole Media Type

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

Field

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

RoleWithPrivileges Media Type

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

Field

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

ldap

String

1

no

The LDAP group that the user belongs to. Required in LDAP mode

name

String

1

yes

The name of the role

privileges

Privileges Media Type

1

no

All privileges included in this role

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

DatacenterLimits Media Type

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

Field

Type

Occurs

Input Required

Description

cpuCountHardLimit

int

1

yes

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

cpuCountSoftLimit

int

1

yes

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

hdHardLimitInMb

long

1

yes

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

hdSoftLimitInMb

long

1

yes

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

id

Integer

1

optional

Identifier of the limit

publicIpsHard

long

1

yes

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

publicIpsSoft

long

1

yes

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

ramHardLimitInMb

int

1

yes

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

ramSoftLimitInMb

int

1

yes

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

repositoryHardLimitsInMb

long

1

yes

Total size of repository space to be used. Hard limit

repositorySoftLimitsInMb

long

1

yes

Total size of repository space to be used. Soft limit

storageHard

long

1

yes

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

storageSoft

long

1

yes

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

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Privileges Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Privilege Media Type

1..n

optional

The collection of List of Privilege Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

RolesLdap Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of RoleLdap Media Type

1..n

optional

The collection of List of RoleLdap Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

User Media Type

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

Field

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

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

surname

String

1

no

User's real last name

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

RoleWithLdap Media Type

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

Field

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

idLdap

Integer

1

no

Identifier for LDAP group

ldap

String

1

optional

 

name

String

1

yes

The name of the role

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

EnterpriseIdName Media Type

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

Field

Type

Occurs

Input Required

Description

cpuCountHardLimit

int

1

yes

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

cpuCountSoftLimit

int

1

yes

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

hdHardLimitInMb

long

1

yes

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

hdSoftLimitInMb

long

1

yes

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

id

Integer

1

no

Identifier of the Entity

name

String

1

no

Enterprise's name

publicIpsHard

long

1

yes

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

publicIpsSoft

long

1

yes

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

ramHardLimitInMb

int

1

yes

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

ramSoftLimitInMb

int

1

yes

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

storageHard

long

1

yes

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

storageSoft

long

1

yes

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

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Scope Media Type

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

Field

Type

Occurs

Input Required

Description

automaticAddDatacenter

boolean

1

optional

true if all new datacenters created are added into this scope

automaticAddEnterprise

boolean

1

optional

true if all new enterprises created are added into this scope

id

Integer

1

optional

The id of the entity

name

String

1

optional

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

scopeEntities

List of ScopeEntity Media Type

1

optional

All limit entities of a scope

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

EnterpriseTheme Media Type

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

Field

Type

Occurs

Input Required

Description

chefClient

String

1

no

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

chefClientCertificate

String

1

no

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

chefURL

String

1

no

URL of the Chef Server containing recipes

chefValidator

String

1

no

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

chefValidatorCertificate

String

1

no

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

companyLogoPath

String

1

no

Custom theme's logo path (image)

cpuCountHardLimit

int

1

yes

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

cpuCountSoftLimit

int

1

yes

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

hdHardLimitInMb

long

1

yes

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

hdSoftLimitInMb

long

1

yes

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

id

Integer

1

no

Identifier of the Entity

idPricingTemplate

Integer

1

no

Identifier for the pricing template associated to this enterprise

isReservationRestricted

boolean

1

no

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

name

String

1

yes

The name of the Enterprise

publicIpsHard

long

1

yes

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

publicIpsSoft

long

1

yes

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

ramHardLimitInMb

int

1

yes

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

ramSoftLimitInMb

int

1

yes

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

repositoryHard

long

1

yes

Hard limit established for repository size

repositorySoft

long

1

yes

Soft limit stablished for repository size

storageHard

long

1

yes

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

storageSoft

long

1

yes

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

theme

String

1

no

Custom theme's name

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

UsersWithRoles Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of UserWithRole Media Type

1..n

optional

The collection of List of UserWithRole Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Enterprise Media Type

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

Field

Type

Occurs

Input Required

Description

chefClient

String

1

no

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

chefClientCertificate

String

1

no

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

chefURL

String

1

no

URL of the Chef Server containing recipes

chefValidator

String

1

no

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

chefValidatorCertificate

String

1

no

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

cpuCountHardLimit

int

1

yes

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

cpuCountSoftLimit

int

1

yes

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

hdHardLimitInMb

long

1

yes

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

hdSoftLimitInMb

long

1

yes

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

id

Integer

1

no

Identifier of the Entity

idPricingTemplate

Integer

1

no

Identifier for the pricing template associated to this enterprise

isReservationRestricted

boolean

1

no

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

name

String

1

yes

The name of the Enterprise

publicIpsHard

long

1

yes

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

publicIpsSoft

long

1

yes

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

ramHardLimitInMb

int

1

yes

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

ramSoftLimitInMb

int

1

yes

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

repositoryHard

long

1

yes

Hard limit established for repository size

repositorySoft

long

1

yes

Soft limit stablished for repository size

storageHard

long

1

yes

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

storageSoft

long

1

yes

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

vlansHard

long

1

yes

Total amount of VLANs that may be defined. Hard limit

vlansSoft

long

1

yes

Total amount of VLANs that may be defined. Soft limit

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Roles Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Role Media Type

1..n

optional

The collection of List of Role Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Session Media Type

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

Field

Type

Occurs

Input Required

Description

authType

AuthType

1

no

The authentication type of the session

expirationDate

Date

1

no

The expiration date of the session

id

Integer

1

no

The identifier of the entity

idUser

Integer

1

no

The id of the user associated with the session

key

String

1

no

The session key

nick

String

1

no

The username of the user associated with the session

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Users Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of User Media Type

1..n

optional

The collection of List of User Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

RoleLdap Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier for LDAP Group

roleLdap

String

1

yes

The LDAP group that the user belongs to. Required in LDAP mode

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

EnterprisesIdName Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of EnterpriseIdName Media Type

1..n

optional

The collection of List of EnterpriseIdName Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Credentials Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the credentials

access

String

1

yes

Access identifier of the credentials

key

String

1

yes

Key for the credentials

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Applications Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Application Media Type

1..n

optional

The collection of List of Application Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Application Media Type

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

Field

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

apiKeyString1noOAuth consumer key for the application
apiSecretString1noOAuth consumer secret for the application

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Event Entities

Events Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Event Media Type

1..n

no

The collection of List of Event Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Event Media Type

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

Field

Type

Occurs

Input Required

Description

actionPerformed

String

1

no

The action performed.

component

String

1

no

The component.

  • API
  • APPLIANCE_MANAGER
  • COSTCODE
  • COSTCODE_CURRENCY
  • DATACENTER
  • ENTERPRISE
  • HIGH_AVAILABILITY
  • IMAGE_CONVERTER
  • INSTANCE_CONVERTER
  • LICENSE_MANAGER
  • MACHINE
  • NETWORK
  • PERSISTENT_CONVERTER
  • PLATFORM
  • PRICING_TEMPLATE
  • RACK
  • ROLE
  • ROLE_LDAP
  • SCOPE
  • STORAGE_DEVICE
  • STORAGE_POOL
  • UNKNOWN
  • USER
  • VIRTUAL_APPLIANCE
  • VIRTUAL_DATACENTER
  • VIRTUAL_MACHINE
  • VIRTUAL_STORAGE
  • VOLUME
  • WORKLOAD

datacenter

String

1

no

The datacenter where the event was triggered.

enterprise

String

1

no

The enterprise.

id

Integer

1

no

The id of the event.

idDatacenter

Integer

1

no

The id datacenter where the event took place.

idEnterprise

Integer

1

no

The id enterprise of the user's enterprise.

idNetwork

Integer

1

no

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

idPhysicalMachine

Integer

1

no

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

idRack

Integer

1

no

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

idStoragePool

String

1

no

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

idStorageSystem

Integer

1

no

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

idSubnet

Integer

1

no

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

idUser

Integer

1

no

The id user that triggered the event.

idVirtualApp

Integer

1

no

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

idVirtualDatacenter

Integer

1

no

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

idVirtualMachine

Integer

1

no

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

idVolume

String

1

no

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

network

String

1

no

The network if the action performed was over a network.

performedBy

String

1

no

The performed by, who performed the action.

physicalMachine

String

1

no

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

rack

String

1

no

The rack if the action performed was over a rack.

severity

SeverityType

1

no

The severity:

  • INFO
  • WARN
  • ERROR

stacktrace

String

1

no

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

storagePool

String

1

no

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

storageSystem

String

1

no

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

subnet

String

1

no

The subnet if the action performed was over a subnet.

timestamp

Date

1

no

The timestamp. Time when the event took place.

user

String

1

no

The user whose performed the action.

virtualApp

String

1

no

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

virtualDatacenter

String

1

no

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

virtualMachine

String

1

no

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

volume

String

1

no

The volume if the action performed was over a volume.

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Infrastructure Entities

PublicIp Media Type

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

Field

Type

Occurs

Input Required

Description

available

boolean

1

optional

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

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

mac

String

1

no

MAC address associated to the IP address

name

String

1

no

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

networkName

String

1

no

Name of the network which the IP belongs to

quarantine

boolean

1

optional

IP in quarantine

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Nics Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Nic Media Type

1..n

optional

The collection of List of Nic Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

UnmanagedIps Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of UnmanagedIp Media Type

1..n

optional

The collection of List of UnmanagedIp Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

PrivateIps Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of PrivateIp Media Type

1..n

optional

The collection of List of PrivateIp Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VMNetworkConfiguration Media Type

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

Field

Type

Occurs

Input Required

Description

gateway

String

1

no

Gateway of the network configuration

id

Integer

1

no

Identifier of the entity

primaryDNS

String

1

no

Primary DNS of the network configuration

secondaryDNS

String

1

no

Secondary DNS of the network configuration

suffixDNS

String

1

no

Suffix DNS of the network configuration

used

Boolean

1

optional

Check if this network configuration actually used by the virtual machine

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

UnmanagedIp Media Type

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

Field

Type

Occurs

Input Required

Description

available

boolean

1

optional

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

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

mac

String

1

no

MAC address associated to the IP address

name

String

1

no

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

networkName

String

1

no

Name of the network which the IP belongs to

quarantine

boolean

1

optional

IP in quarantine

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

PrivateIp Media Type

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

Field

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 to the IP address

name

String

1

no

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

networkName

String

1

no

Name of the network which the IP belongs to

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

NetworkServiceTypes Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of NetworkServiceType Media Type

1..n

optional

The collection of List of NetworkServiceType Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

NetworkInterface Media Type

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

Field

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

 

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

PublicIps Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of PublicIp Media Type

1..n

optional

The collection of List of PublicIp Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VlanTagAvailability Media Type

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

Field

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

NetworkInterfaces Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of NetworkInterface Media Type

1..n

optional

The collection of List of NetworkInterface Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

ExternalIp Media Type

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

Field

Type

Occurs

Input Required

Description

available

boolean

1

optional

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

id

Integer

1

no

Identifier of the entity

ip

String

1

no

String that represents the IP address

mac

String

1

no

MAC address associated to the IP address

name

String

1

no

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

networkName

String

1

no

Name of the network which the IP belongs to

quarantine

boolean

1

optional

IP in quarantine

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Nic Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

ip

String

1

no

Ip address asociated to a NIC

mac

String

1

no

MAC address of the NIC

sequence

Integer

1

no

Sequence of the NIC inside its Virtual Machine

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

ExternalIps Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of ExternalIp Media Type

1..n

optional

The collection of List of ExternalIp Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

DhcpOptions Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of DhcpOption Media Type

1..n

optional

The collection of List of DhcpOption Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VMNetworkConfigurations Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VMNetworkConfiguration Media Type

1..n

optional

The collection of List of VMNetworkConfiguration Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

NetworkServiceType Media Type

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

Field

Type

Occurs

Input Required

Description

defaultNST

boolean

1

no

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

id

Integer

1

no

Identifier of the entity

name

String

1

yes

Name that defines the Network Service Type.

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

DhcpOption Media Type

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

Field

Type

Occurs

Input Required

Description

gateway

String

1

yes

Gateway of the static route

id

Integer

1

no

Identifier of the entity

mask

Integer

1

yes

Mask of the network of the static route in integer mode

netmask

String

1

yes

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

networkAddress

String

1

yes

Network address of the static route

option

int

1

yes

The integer value that defines the option

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VLANNetwork Media Type

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

Field

Type

Occurs

Input Required

Description

address

String

1

yes

Network Address of the VLAN

defaultNetwork

Boolean

1

no

Return if it is used as Default Network.

dhcpOptions

DhcpOptions Media Type

1

optional

 

gateway

String

1

yes

Gateway of the VLAN

id

Integer

1

optional

Identifier of the entity

mask

Integer

1

yes

Numerical value of the VLAN mask

name

String

1

yes

Name of the VLAN

primaryDNS

String

1

optional

Primary DNS address

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

type

NetworkType

1

optional

Kind of network: PUBLIC, INTERNAL, EXTERNAL and UNMANAGED

unmanaged

Boolean

1

optional

Return if the VLAN is unmanaged

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VLANNetworks Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VLANNetwork Media Type

1..n

optional

The collection of List of VLANNetwork Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

MachineState Media Type

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

Field

Type

Occurs

Input Required

Description

state

MachineState

1

optional

State of the machine.

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

RemoteServices Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of RemoteService Media Type

1..n

optional

The collection of List of RemoteService Media Type elements

configErrors

Errors Media Type

1

optional

List of configuration errors

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Datacenters Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Datacenter Media Type

1..n

optional

The collection of List of Datacenter Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

MachinesToCreate Media Type

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

Field

Type

Occurs

Input Required

Description

hypervisor

String

1

yes

Value of the hypervisor type supported by abiquo.

ipFrom

String

1

yes

Start of the IP interval of the machines to discover.

ipTo

String

1

yes

End of the IP interval of the machines to discover.

password

String

1

yes

Password of the user for loggon into the hypervisor service.

port

Integer

1

yes

Connection port of the machines to discover.

user

String

1

yes

Name of the user for loggon into the hypervisor service.

vSwitch

String

1

yes

Virtual switch of the machines to discover

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Datacenter Media Type

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

Field

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

remoteServices

RemoteServices Media Type

1

optional

List of remote services transfer objects of the datacenter

uuid

String

1

optional

Unique identifier of the datacenter shared with the remote services

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Public Datacenter Media Type

Deprecated Functionality

This functionality was deprecated in version 3.0. See #PublicCloudRegionMediaType

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

Field

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

remoteServices

RemoteServices Media Type

1

optional

List of remote services transfer objects of the datacenter

uuid

String

1

optional

Unique identifier of the datacenter shared with the remote services

endPointString1yesEndpoint of the public cloud provider api
providerString1yesName of the cloud provider
regionString1yesRegion of public cloud

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VolumesManagementWithVirtualMachine Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VolumeManagementWithVirtualMachine Media Type

1..n

optional

The collection of List of VolumeManagementWithVirtualMachine Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

StoragePools Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of StoragePool Media Type

1..n

optional

The collection of List of StoragePool Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

DisksManagement Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of DiskManagement Media Type

1..n

optional

The collection of List of DiskManagement Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Tiers Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Tier Media Type

1..n

optional

The collection of List of Tier Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

StorageDeviceMetadata Media Type

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

Field

Type

Occurs

Input Required

Description

defaultIscsiPort

int

1

no

The default iscsi port of where the device listens

defaultManagementPort

int

1

no

The default port of the management API of the device

requiresAuthentication

boolean

1

no

Boolean indicating if the storage device requires authentication

type

String

1

no

The storage technology type of the storage device

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

DiskManagement Media Type

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

Field

Type

Occurs

Input Required

Description

sequence

Integer

1

optional

Sequence number of the disk into a virtual machine

sizeInMb

Long

1

yes

Disk size in MegaBytes

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

StoragePool Media Type

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

Field

Type

Occurs

Input Required

Description

availableSizeInMb

long

1

yes

Available size in MB of the storage pool.

enabled

boolean

1

no

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

idStorage

String

1

optional

Identifier of the entity.

name

String

1

yes

Name of the storage pool.

totalSizeInMb

long

1

yes

Total size in MB of the storage pool.

usedSizeInMb

long

1

yes

Used size in MB of the storage pool.

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

StoragePoolsWithDevice Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of StoragePoolWithDevice Media Type

1..n

optional

The collection of List of StoragePoolWithDevice Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Tier Media Type

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

Field

Type

Occurs

Input Required

Description

defaultAllowed

boolean

1

yes

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

description

String

1

optional

Description of the tier

enabled

boolean

1

yes

True if the tier is enabled, false otherwise

id

Integer

1

optional

Identifier of the tier

name

String

1

yes

Name of the tier

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

StoragePoolsWithTier Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of StoragePoolWithTier Media Type

1..n

optional

The collection of List of StoragePoolWithTier Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

DvdManagement Media Type

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

Field

Type

Occurs

Input Required

Description

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

StoragePoolWithTier Media Type

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

Field

Type

Occurs

Input Required

Description

availableSizeInMb

long

1

yes

Available size in MB of the storage pool.

enabled

boolean

1

no

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

idStorage

String

1

optional

Identifier of the entity.

name

String

1

yes

Name of the storage pool.

tier

Tier Media Type

1

yes

Tier where the storage pool belongs to.

totalSizeInMb

long

1

yes

Total size in MB of the storage pool.

usedSizeInMb

long

1

yes

Used size in MB of the storage pool.

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

InitiatorMapping Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

initiatorIqn

String

1

yes

IQN of the iSCSI initiator

targetIqn

String

1

yes

IQN of iSCSI the target

targetLun

Integer

1

yes

LUN in the iSCSI the target accessible by the initiator

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

StorageDevice Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

iscsiIp

String

1

yes

iSCSI IP of the storage device, used by the hypervisors to connect to the device

iscsiPort

int

1

yes

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

StorageDevices Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of StorageDevice Media Type

1..n

optional

The collection of List of StorageDevice Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

StorageDevicesMetadata Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of StorageDeviceMetadata Media Type

1..n

optional

The collection of List of StorageDeviceMetadata Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VolumesManagement Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VolumeManagement Media Type

1..n

optional

The collection of List of VolumeManagement Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

StoragePoolWithDevice Media Type

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

Field

Type

Occurs

Input Required

Description

availableSizeInMb

long

1

yes

Available size in MB of the storage pool.

device

StorageDevice Media Type

1

optional

Device where the storage pool belongs to.

enabled

boolean

1

no

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

idStorage

String

1

optional

Identifier of the entity.

name

String

1

yes

Name of the storage pool.

totalSizeInMb

long

1

yes

Total size in MB of the storage pool.

usedSizeInMb

long

1

yes

Used size in MB of the storage pool.

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

InitiatorMappings Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of InitiatorMapping Media Type

1..n

optional

The collection of List of InitiatorMapping Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VolumeManagementWithVirtualMachine Media Type

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

Field

Type

Occurs

Input Required

Description

description

String

1

optional

Description of the volume

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 field is required when creating
generic iSCSI volumes

name

String

1

yes

Name of the volume

sequence

Integer

1

optional

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

sizeInMB

long

1

yes

Size in MB of the volume

state

String

1

no

State of the volume (attached/detached)

storagePoolWithDevice

StoragePoolWithDevice Media Type

1

no

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

uuid

String

1

no

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

virtualAppliance

VirtualAppliance Media Type

1

no

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

virtualDatacenterWithDatacenter

VirtualDatacenterWithDatacenter Media Type

1

no

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

virtualMachine

VirtualMachine Media Type

1

no

Virtual machine where the volume is attached to

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VolumeManagement Media Type

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

Field

Type

Occurs

Input Required

Description

description

String

1

optional

Description of the volume

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 field is required when creating
generic iSCSI volumes

name

String

1

yes

Name of the volume

sequence

Integer

1

optional

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

sizeInMB

long

1

yes

Size in MB of the volume

state

String

1

no

State of the volume (attached/detached)

uuid

String

1

no

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

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Mail Media Type

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

Field

Type

Occurs

Input Required

Description

body

String

1

optional

body of the mail

subject

String

1

optional

subject of the mail

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

RemoteService Media Type

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

Field

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Machine Media Type

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

Field

Type

Occurs

Input Required

Description

datastores

Datastores Media Type

1

yes

List of datastore of the machine

description

String

1

optional

Description of the machine

id

Integer

1

optional

Identifier of the machine

initiatorIQN

String

1

optional

Initiator IQN of the machine used to use storage devices

ip

String

1

yes

IP of the machine

ipService

String

1

yes

IP of the hypervisor service of machine

ipmiIP

String

1

optional

IP of the impi service of the machine

ipmiPassword

String

1

optional

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

ipmiPort

Integer

1

optional

Connection port of the impi service of the machine

ipmiUser

String

1

optional

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

name

String

1

yes

Name of the machine

networkInterfaces

NetworkInterfaces Media Type

1

optional

The networkInterfaces

password

String

1

yes

Password of the user for loggon into the hypervisor service

port

Integer

1

yes

Connection port of the machine

state

MachineState

1

no

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

type

HypervisorType

1

yes

Value of the hypervisor type supported by abiquo

user

String

1

yes

Name of the user for loggon into the hypervisor service

virtualCpuCores

Integer

1

yes

Numbre of cpus of the machine

virtualCpusUsed

Integer

1

yes

Numbre of used cpus of the machine

virtualRamInMb

Integer

1

yes

RAM in MB of the machine

virtualRamUsedInMb

Integer

1

yes

Used RAM in MB of the machine

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

ReservedMachine Media Type

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

Field

Type

Occurs

Input Required

Description

datacenter

Datacenter Media Type

1

optional

Datacenter of the physical machine

datastores

Datastores Media Type

1

yes

List of datastore of the machine

description

String

1

optional

Description of the machine

id

Integer

1

optional

Identifier of the machine

initiatorIQN

String

1

optional

Initiator IQN of the machine used to use storage devices

ip

String

1

yes

IP of the machine

ipService

String

1

yes

IP of the hypervisor service of machine

ipmiIP

String

1

optional

IP of the impi service of the machine

ipmiPassword

String

1

optional

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

ipmiPort

Integer

1

optional

Connection port of the impi service of the machine

ipmiUser

String

1

optional

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

name

String

1

yes

Name of the machine

networkInterfaces

NetworkInterfaces Media Type

1

optional

The networkInterfaces

password

String

1

yes

Password of the user for loggon into 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}

type

HypervisorType

1

yes

Value of the hypervisor type supported by abiquo

user

String

1

yes

Name of the user for loggon into the hypervisor service

virtualCpuCores

Integer

1

yes

Numbre of cpus of the machine

virtualCpusUsed

Integer

1

yes

Numbre of used cpus of the machine

virtualRamInMb

Integer

1

yes

RAM in MB of the machine

virtualRamUsedInMb

Integer

1

yes

Used RAM in MB of the machine

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Racks Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Rack Media Type

1..n

no

The collection of List of Rack Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Rack Media Type

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

Field

Type

Occurs

Input Required

Description

haEnabled

boolean

1

optional

HA enabled in the rack.

id

Integer

1

no

Identifier of the entity.

longDescription

String

1

optional

Long description of the rack.

name

String

1

yes

Name of the rack.

nrsq

Integer

1

optional

Specify the percentatge of new virtual datacenters tolerance in allocation.

shortDescription

String

1

optional

Short description of the rack.

vlanIdMax

Integer

1

optional

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

vlanIdMin

Integer

1

optional

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

vlanPerVdcReserved

Integer

1

no

Deprecated field.

vlansIdAvoided

String

1

optional

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

DatacentersLight Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of DatacenterLight Media Type

1..n

optional

The collection of List of DatacenterLight Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Datastores Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Datastore Media Type

1..n

optional

The collection of List of Datastore Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')


DatacenterLight Media Type

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

Field

Type

Occurs

Input Required

Description

idDatacenter

int

1

optional

Identifier of the datacenter

name

String

1

optional

Name of the datacenter

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Machines Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Machine Media Type

1..n

optional

The collection of List of Machine Media Type elements

errors

Errors Media Type

1

optional

 

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

MachineIpmiState Media Type

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

Field

Type

Occurs

Input Required

Description

state

MachineIpmiState

1

optional

State of the ipmi configuration of the machine.

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

ReservedMachines Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of ReservedMachine Media Type

1..n

optional

The collection of List of ReservedMachine Media Type elements

errors

Errors Media Type

1

optional

 

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Datastore Media Type

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

Field

Type

Occurs

Input Required

Description

datastoreUUID

String

1

yes

Unique identifier of the physical datastore

directory

String

1

optional

Direcotry of the datastore

enabled

boolean

1

yes

Indicates if the datastore is enabled to be used or not

id

Integer

1

no

Identifier of the datastore

name

String

1

yes

Name of the datastore

rootPath

String

1

yes

Path to the root of the datastore

size

long

1

yes

Size of the datastore

usedSize

long

1

yes

Used size of the datastore

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')


PublicCloudRegion  Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

name

String

 

1

yes

The name of a public cloud region

uuidString1optionalUnique identifier of the public cloud region shared with the remote services

remoteServices

RemoteServices Media Type

1

optional 

List of remote services transfer objects

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Pricing Entities

CostCodeCurrency Media Type

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

Field

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Currency Media Type

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

Field

Type

Occurs

Input Required

Description

digits

int

1

yes

Number of digits after the decimal point

id

Integer

1

no

Identifier of the entity

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

PricingTier Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the entity

price

BigDecimal

1

yes

The price set for this storage tier in this pricing model

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

PricingTiers Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of PricingTier Media Type

1..n

optional

The collection of List of PricingTier Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

PricingCostCodes Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of PricingCostCode Media Type

1..n

optional

The collection of List of PricingCostCode Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

CostCodes Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of CostCode Media Type

1..n

optional

The collection of List of CostCode Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

PricingCostCode Media Type

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

Field

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

CostCodeCurrencies Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of CostCodeCurrency Media Type

1..n

optional

The collection of List of CostCodeCurrency Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

PricingTemplates Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of PricingTemplate Media Type

1..n

optional

The collection of List of PricingTemplate Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

PricingTemplate Media Type

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

Field

Type

Occurs

Input Required

Description

chargingPeriod

Integer

1

yes

Indicates the period of time to charge the user

defaultTemplate

boolean

1

optional

 

description

String

1

yes

The pricing estimate message

hdGB

BigDecimal

1

yes

Price of hypervisor datastores per gigabyte

id

Integer

1

no

Identifier of the entity

lastUpdate

Date

1

yes

Indicates the last modification

layer

BigDecimal

1

yes

Price of using antiaffinity capacity

memoryGB

BigDecimal

1

yes

Price of memory per megabyte

minimumCharge

Integer

1

yes

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

minimumChargePeriod

BigDecimal

1

yes

Minimum charge per Minimum Period

name

String

1

yes

The name of the pricing model

publicIp

BigDecimal

1

yes

Price per public IP address

showChangesBefore

boolean

1

yes

Indicates if show the charges before deployment

showMinimumCharge

boolean

1

optional

 

standingChargePeriod

BigDecimal

1

yes

Standing charge per charging period

vcpu

BigDecimal

1

yes

Price of CPU cores

vlan

BigDecimal

1

yes

Price per VLAN

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

CostCode Media Type

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

Field

Type

Occurs

Input Required

Description

description

String

1

yes

Description of the cost code

id

Integer

1

no

Identifier of the entity

name

String

1

yes

The name of the cost code

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Currencies Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Currency Media Type

1..n

optional

The collection of List of Currency Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Scheduler Entities

FitPolicyRules Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of FitPolicyRule Media Type

1..n

optional

The collection of List of FitPolicyRule Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Rules Media Type

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

Field

Type

Occurs

Input Required

Description

enterpriseExclusionRules

EnterpriseExclusionsRules Media Type

1

optional

 

fitPolicyRules

FitPolicyRules Media Type

1

optional

 

machineLoadRules

MachineLoadRules Media Type

1

optional

 

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

EnterpriseExclusionRule Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

optional

Identifier of the entity

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

EnterpriseExclusionsRules Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of EnterpriseExclusionRule Media Type

1..n

optional

The collection of List of EnterpriseExclusionRule Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

FitPolicyRule Media Type

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

Field

Type

Occurs

Input Required

Description

fitPolicy

FitPolicy

1

yes

Fit Policy possible values : PERFORMANCE or PROGRESSIVE"

id

Integer

1

optional

Identifier of the entity

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

MachineLoadRules Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of MachineLoadRule Media Type

1..n

optional

The collection of List of MachineLoadRule Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

MachineLoadRule Media Type

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

Field

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Statistics Entities

EnterprisesResources Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of EnterpriseResources Media Type

1..n

optional

The collection of List of EnterpriseResources Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

CloudUsages Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of CloudUsage Media Type

1..n

optional

The collection of List of CloudUsage Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualAppResources Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the virtual machine template definition.

idEnterprise

int

1

no

The id enterprise.

idVirtualDataCenter

int

1

no

The id virtual data center.

vappName

String

1

no

Name for this virtual appliance.

vdcName

String

1

no

Name for the virtualdatacenter.

vmActive

int

1

no

Number of virtual machines currently running in this virtual appliance.

vmCreated

int

1

no

Number of virtual machines created in this virtual appliance.

volAttached

int

1

no

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualDatacentersResources Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VirtualDatacenterResources Media Type

1..n

optional

The collection of List of VirtualDatacenterResources Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

CloudUsage Media Type

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

Field

Type

Occurs

Input Required

Description

id

Integer

1

no

Identifier of the Entity

numEnterprisesCreated

long

1

no

Total number of enterprises in system

numUsersCreated

long

1

no

Total number of users in system

numVdcCreated

long

1

no

Total number of Virtual DataCenters in system

publicIPsReserved

long

1

no

Total number of IPs assigned to a VirtualDatacenter (Reserved)

publicIPsTotal

long

1

no

Total number of IPs defined (managed)

publicIPsUsed

long

1

no

Total number of IPs used by virtual machines

serversRunning

long

1

no

Total number of Physical Machines running currently

serversTotal

long

1

no

Total number of Physical machines managed

storageReserved

long

1

no

External storage reserved by Enterprises in Datacenters (in Megabytes)

storageTotal

long

1

no

External storage managed by Abiquo (in Megabytes)

storageUsed

long

1

no

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

virtualCpuReserved

long

1

no

Maximum number of Virtual CPUs reserved by all enterprises

virtualCpuTotal

long

1

no

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

virtualCpuUsed

long

1

no

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

virtualMachinesRunning

long

1

no

Total number of Virtual Machines currently in a running state

virtualMachinesTotal

long

1

no

Total number of Virtual Machines managed

virtualMemoryReserved

long

1

no

Maximum amount of RAM reserved by all enterprises in Megabytes

virtualMemoryTotal

long

1

no

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

virtualMemoryUsed

long

1

no

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

virtualStorageReserved

long

1

no

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

virtualStorageTotal

long

1

no

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

virtualStorageUsed

long

1

no

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

vlanUsed

long

1

no

Total number of VLANs in use by any datacenter managed

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualAppsResources Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of VirtualAppResources Media Type

1..n

no

The collection of List of VirtualAppResources Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

EnterpriseResources Media Type

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

Field

Type

Occurs

Input Required

Description

extStorageReserved

long

1

no

Maximum external storage size reserved for this enterprise in Megabytes

extStorageUsed

long

1

no

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

id

Integer

1

no

Identifier of the Entity

localStorageReserved

long

1

no

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

localStorageUsed

long

1

no

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

memoryReserved

long

1

no

Maximum amount of RAM reserved for this enterprise in Megabytes

memoryUsed

long

1

no

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

publicIPsLimit

long

1

optional

 

publicIPsReserved

long

1

no

Total number of IPs assigned to a VirtualDatacenter (Reserved)

publicIPsUsed

long

1

no

Total number of IPs used by virtual machines

repositoryReserved

long

1

no

Maximum repository size reserved for this enterprise in Megabytes

repositoryUsed

long

1

no

Total repository size currently used for this enterprise in Megabytes

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

VirtualDatacenterResources Media Type

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

Field

Type

Occurs

Input Required

Description

extStorageReserved

long

1

no

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

extStorageUsed

long

1

no

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

id

Integer

1

no

Identifier of the virtual machine template definition.

idEnterprise

int

1

no

The id enterprise.

localStorageReserved

long

1

no

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

localStorageUsed

long

1

no

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

memoryReserved

long

1

no

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

memoryUsed

long

1

no

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

publicIPsReserved

long

1

no

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

publicIPsUsed

long

1

no

Total number of IPs used by virtual machines.

vdcName

String

1

no

virtual datacenter's name.

virtualCpuReserved

long

1

no

The virtual cpu reserved.

virtualCpuUsed

long

1

no

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

vlanReserved

long

1

no

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

vlanUsed

long

1

no

Total number of VLANs in use by this virtual datacenter.

vmActive

int

1

no

Number of virtual machines currently running in this virtual datacenter.

vmCreated

int

1

no

Number of virtual machines created in this virtual datacenter.

volAttached

int

1

no

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

volCreated

int

1

no

Number of volumes created in this virtual datacenter.

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Task Entities

Job Media Type

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

Field

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

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

TaskExtended Media Type

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

Field

Type

Occurs

Input Required

Description

creationTimestamp

Long

1

yes

Creation timestamp in standard UNIX timestamp

jobs

Jobs Media Type

1

no

Jobs collection of the task

jobsExtended

JobsExtended Media Type

1

no

Extended jobs collection of the task

ownerId

String

1

yes

Identifier of the task owner

state

TaskState

1

yes

Current state of the task

taskId

String

1

yes

Identifier of the task

timestamp

long

1

yes

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

type

TaskType

1

yes

Type of the task

userId

String

1

no

Identifier of the user who created the task

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

JobsExtended Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of JobExtended Media Type

1..n

no

The collection of List of JobExtended Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Task Media Type

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

Field

Type

Occurs

Input Required

Description

creationTimestamp

Long

1

yes

Creation timestamp in standard UNIX timestamp

jobs

Jobs Media Type

1

no

Jobs collection of the task

ownerId

String

1

yes

Identifier of the task owner

state

TaskState

1

yes

Current state of the task

taskId

String

1

yes

Identifier of the task

timestamp

long

1

yes

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

type

TaskType

1

yes

Type of the task

userId

String

1

no

Identifier of the user who created the task

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Tasks Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Task Media Type

1..n

no

The collection of List of Task Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Jobs Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Job Media Type

1..n

no

The collection of List of Job Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

JobExtended Media Type

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

Field

Type

Occurs

Input Required

Description

creationTimestamp

Long

1

yes

Creation timestamp in standard UNIX timestamp

description

String

1

no

Description of the job

errorCause

String

1

optional

 

id

String

1

yes

Identifier of the job

parentTaskId

String

1

no

Identifier of the parent task

progress

Integer

1

optional

 

rollbackState

JobState

1

no

Current rollback state of the job

state

JobState

1

no

Current state of the job

timestamp

Long

1

yes

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

type

JobType

1

yes

Type of the job

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

 

Metric Entities

Metric Media Type

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

Field

Type

Occurs

Input Required

Description

name

String

1

no

Metric name

namespaceString1noMetric namespace

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Metrics Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of Metric Media Type

1..n

no

The collection of List of Metric Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

MetricMetadata Media Type

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

Field

Type

Occurs

Input Required

Description

name

String

1

no

Metric name

namespaceString1noMetric namespace
descriptionString0..1noMetric description
unitString0..1noMetric unit

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

MetricsMetadata Media Type

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

Field

Type

Occurs

Input Required

Description

collection

List of MetricMetadata Media Type

1..n

no

The collection of List of MetricMetadata Media Type elements

totalSize

Integer

1

optional

Number of elements of the 'collection' field

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

 

 

  • No labels