QVD API
The QVD API lets you administrate the different components that make up QVD.
1. Paths
The following table shows the different URIs of the API to which you can access:
| PROTOCOL | URI | VERBS | DESCRIPTION |
|---|---|---|---|
HTTPS |
/api/info |
POST GET |
Returns public information about the API and does not require authentication. Said information is:
|
HTTPS |
/api |
POST GET |
This is the main route to access the functions of the API. The information returned depends on the action introduced. These actions are described in the section [api] |
HTTPS |
/api/login |
POST |
With this path some credentials for a temporary session can be generated |
HTTPS |
/api/logout |
POST |
Path to delete the credentials of the temporary session that is currently being used |
WSS |
/api/staging |
Any change in the system is reported through this web socket. |
|
HTTPS |
/api/di/upload |
POST OPTIONS |
Upload a disk image from your local machine |
WSS |
/api/di/download |
With this web socket you can know the status when asking for the download of an image from a URL. |
2. Types
The types for the different parameters of the API are the following:
| TYPE | DEFINITION | EXAMPLE |
|---|---|---|
string |
"string" |
|
integer |
10 |
|
token |
string defined in a concrete action |
"id" |
regex |
string with a chain to do the matching. If % is used at the beginning and at the end the matching will be applied to the results that contain the string |
"%vm%" |
op |
"~" "=" "<" ">" "⇐" ">=" "!=" "<>" |
|
cond |
"-or" "-and" |
|
order |
"-asc" "-desc" |
|
var |
string integer |
|
hash |
{string : var, … } |
{"key1":10,"key2":"value"} |
array |
[var, …] |
["string", 10] |
token_hash |
{token : var, … } |
{"id":10,"name":"admin"} |
token_array |
[token, …] |
["id", "name"] |
filter_list |
{filter, … } |
{"-or":["id",10,"name","admin"],"id":10} |
filter |
token : var cond : filter_array token : array token : {op : regex} |
"id":10 "-or":["id",10,"name","admin"] "id" : ["1000","2000","3000"] "name" : {"~" : "%vm%"} |
filter_array |
[token, var, token, var, …] |
["id",10,"name","admin"] |
order_list |
{"field" : token, "order" : order} {"field" : token_array, "order" : order} |
{"field":"id","order":"-desc"} {"field":["id","name"],"order":"-asc"} |
3. /api
Firstly, to access the API it is necessary to authenticate the user and to do so, there are two possibilities: * Implicit authentication. Use the login path to generate some credentials that are managed using cookies. After a satisfactory authentication, any request that is made to the API will be processed. And finally the logout path will be called to eliminate the credentials. * Explicit authentication. Specifying the authentication credentials in any of the calls of the API.
In both methods, it is necessary to specify the parameters "login" and "password" (and "tenant" if the multitenant mode is activated) or to provide the session id generated in a previous consultation using in this case the parameter "sid".
|
It is strongly recommended to use the first method of authentication so as not to store the credentials in the history and that such credentials are being sent in each request. |
Moreover all the calls to this API path require at the veryleast the parameter "action" in the URI and the list of possible values that this field can take are specified in this section. A call to the API could be, for example:
GET https://myqvd.theqvd.com/api?action=current_admin_setup&sid=ffc6097dc66a0ba748384bab4b3f18764c950106
GET https://myqvd.theqvd.com/api?action=current_admin_setup&login=myadmin&password=mypwd&tenant=mytenant
All the actions return the status code HTTP 200 with a message JSON. If everything has gone well, the JSON generated will contain a field "status" with value 0 and the desired fields in the request. Alternatively, the field "status"will contain a value different from 0 with a message about the error and additional information.
-
OK
{
"sid":"29f91648cd2ecc9cb5a138dbb42d9f6804e0cdad",
"status":0,
"total":0,
"rows":[],
"message":"Successful completion"
}
-
ERROR
{
"additional_info":"No additional information",
"status":3100,
"message":"No credentials provided for authentication"
}
Below is the complete list of accepted parameters for each action of the API. For each parameter, we specify its type, defined above, and each of the accepted tokens for each parameter with the necessary ACLs to be able to use it.If the token is compulsory it will be shown underlined
|
|
The token "tenant_id" is always compulsory if requests are made to the Api as superadministrator and the multitenant mode is active. In any other case it is not necessary. |
3.2. ACLs
3.2.1. acl_get_list
Description
Returns the parameters of a list of ACLs
ACLs
-
role.see.acl-list
-
administrator.see.acl-list
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
description |
||
acl_name |
||
admin_id |
||
operative |
||
fields <token_array> |
id |
|
name |
||
description |
||
roles |
||
operative |
||
order_by <order_list> |
id |
|
name |
||
description |
Examples
-
Input:
action=acl_get_list&filters={"id":1}
-
Output:
{
"total" : 1,
"message" : "Successful completion",
"status" : 0,
"rows" : [
{
"roles" : {
"43" : "Root"
},
"description" : "Create administrators",
"name" : "administrator.create.",
"id" : 1,
"operative" : 1
}
]
}
3.2.2. get_acls_in_roles
Description
Returns the parameters of a list of ACLs
ACLs
-
administrator.see.acl-list
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
description |
||
acl_name |
||
role_id |
||
operative |
||
fields <token_array> |
id |
|
name |
||
description |
||
roles |
||
operative |
||
order_by <order_list> |
id |
|
name |
||
description |
Examples
-
Input:
action=get_acls_in_roles
-
Output:
{}
3.2.3. get_acls_in_admins
Description
Returns the parameters of a list of ACLs
ACLs
-
administrator.see.acl-list
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
description |
||
acl_name |
||
admin_id |
||
operative |
||
fields <token_array> |
id |
|
name |
||
description |
||
roles |
||
operative |
||
order_by <order_list> |
id |
|
name |
||
description |
Examples
-
Input:
action=get_acls_in_admins
-
Output:
{}
3.2.4. acl_tiny_list
Description
Returns a subset of parameters of a list of ACLs
ACLs
-
role.see.acl-list
-
administrator.see.acl-list
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
name |
|
fields <token_array> |
id |
|
name |
||
order_by <order_list> |
id |
|
name |
||
description |
Examples
-
Input:
action=acl_tiny_list
-
Output:
{
"total" : 3,
"status" : 0,
"message" : "Successful completion",
"rows" : [
{
"id" : 1,
"name" : "administrator.create."
},
{
"name" : "administrator.create.language",
"id" : 2
},
{
"name" : "administrator.delete.",
"id" : 3
}
]
}
3.2.5. number_of_acls_in_role
Description
Returns the number of acls in a role
ACLs
-
administrator.see.acl-list
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
role_id |
Examples
-
Input:
action=number_of_acls_in_role&filters={"role_id":1}
-
Output:
{
"%" : {
"total" : 309,
"effective" : 2
},
"status" : 0,
"message" : "Successful completion"
}
3.2.6. number_of_acls_in_admin
Description
Returns the number of acls in an administrator
ACLs
-
administrator.see.acl-list
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
admin_id |
Examples
-
Input:
action=number_of_acls_in_admin&filters={"admin_id":1}
-
Output:
{
"%" : {
"effective" : 309,
"total" : 309
},
"status" : 0,
"message" : "Successful completion"
}
3.3. Roles
3.3.1. role_get_list
Description
Returns the parameters of a list of roles
ACLs
-
role.see-main.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
||
fixed |
||
internal |
||
creation_date |
role.filter.creation-date |
|
creation_admin_id |
role.filter.created-by |
|
creation_admin_name |
role.filter.created-by |
|
fields <token_array> |
id |
|
name |
||
description |
role.see.description |
|
acls |
role.see.acls |
|
roles |
role.see.roles |
|
fixed |
||
internal |
||
creation_date |
role.filter.creation-date |
|
creation_admin_id |
role.filter.created-by |
|
creation_admin_name |
role.filter.created-by |
|
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
role.see.description |
|
fixed |
||
internal |
||
creation_date |
role.filter.creation-date |
|
creation_admin_id |
role.filter.created-by |
|
creation_admin_name |
role.filter.created-by |
Examples
-
Input:
action=role_get_list&filters={"id":1}
-
Output:
{
"message" : "Successful completion",
"total" : 1,
"rows" : [
{
"internal" : 1,
"name" : "Administrators Creator",
"id" : 1,
"tenant_name" : "-",
"acls" : {
"positive" : [
"administrator.create.",
"administrator.create.language"
],
"negative" : []
},
"description" : null,
"creation_admin_name" : null,
"tenant_id" : -1,
"creation_date" : null,
"creation_admin_id" : null,
"fixed" : 1,
"roles" : {}
}
],
"status" : 0
}
3.3.2. role_get_details
Description
Returns all the parameters of a role
ACLs
-
role.see-details
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
||
fields <token_array> |
id |
|
name |
||
description |
role.see.description |
|
acls |
role.see.acls |
|
roles |
role.see.roles |
|
fixed |
||
internal |
||
creation_date |
role.filter.creation-date |
|
creation_admin_id |
role.filter.created-by |
|
creation_admin_name |
role.filter.created-by |
|
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
role.see.description |
|
fixed |
||
internal |
||
creation_date |
role.filter.creation-date |
|
creation_admin_id |
role.filter.created-by |
|
creation_admin_name |
role.filter.created-by |
Examples
-
Input:
action=role_get_details&filters={"id":1}
-
Output:
{
"message" : "Successful completion",
"rows" : [
{
"tenant_name" : "-",
"id" : 1,
"name" : "Administrators Creator",
"internal" : 1,
"roles" : {},
"fixed" : 1,
"creation_date" : null,
"creation_admin_id" : null,
"tenant_id" : -1,
"creation_admin_name" : null,
"acls" : {
"negative" : [],
"positive" : [
"administrator.create.",
"administrator.create.language"
]
},
"description" : null
}
],
"total" : 1,
"status" : 0
}
3.3.3. role_tiny_list
Description
Returns a subset of the parameters of a list of roles
ACLs
-
administrator.see.roles
-
role.see.inherited-roles
-
tenant.purge.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
fields <token_array> |
id |
|
name |
||
tenant_name |
||
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
role.see.description |
|
fixed |
||
internal |
||
creation_date |
role.filter.creation-date |
|
creation_admin_id |
role.filter.created-by |
|
creation_admin_name |
role.filter.created-by |
Examples
-
Input:
action=role_tiny_list
-
Output:
{
"rows" : [
{
"tenant_name" : "-",
"id" : 1,
"name" : "Administrators Creator"
}
],
"total" : 1,
"message" : "Successful completion",
"status" : 0
}
3.3.4. role_all_ids
Description
Returns the ids of the roles
ACLs
-
role.see-main.
-
role.-massive.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
||
fixed |
||
internal |
||
creation_date |
role.filter.creation-date |
|
creation_admin_id |
role.filter.created-by |
|
creation_admin_name |
role.filter.created-by |
|
fields <token_array> |
id |
|
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
role.see.description |
|
fixed |
||
internal |
||
creation_date |
role.filter.creation-date |
|
creation_admin_id |
role.filter.created-by |
|
creation_admin_name |
role.filter.created-by |
Examples
-
Input:
action=role_all_ids
-
Output:
{
"status" : 0,
"rows" : [
1,
2
],
"total" : 2,
"message" : "Successful completion"
}
3.3.5. role_create
Description
Creates a role
ACLs
-
role.create.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
name |
|
description |
||
tenant_id |
||
fixed |
||
internal |
||
__acls__ |
role.update.assign-acl |
|
__roles__ |
role.update.assign-role |
Examples
-
Input:
action=create_role&arguments={"name":"Rol"}
-
Output:
{
"status" : 0,
"total" : 1,
"rows" : [
{
"id" : 10004
}
],
"message" : "Successful completion"
}
3.3.6. role_update
Description
Updates a role
ACLs
-
role.update.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
arguments <token_hash> |
name |
role.update.name |
description |
role.update.description |
|
__acls_changes__ : assign_acls |
role.update.assign_acl |
|
__acls_changes__ : unassign_acls |
role.update.assign_acl |
|
__roles_changes__ : assign_acls |
role.update.assign_role |
|
__roles_changes__ : unassign_acls |
role.update.assign_role |
Examples
-
Input:
action=role_update&filters={"id":10000}&arguments={"description":"myrole"}
-
Output:
{
"status" : 0,
"message" : "Successful completion",
"rows" : [],
"total" : 1
}
3.3.7. role_delete
Description
Deletes a role
ACLs
-
role.delete.
-
tenant.purge.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
Examples
-
Input:
action=role_delete&filters={"id":10000}
-
Output:
{
"status" : 0,
"rows" : [],
"total" : 1,
"message" : "Successful completion"
}
3.4. Tenants
3.4.1. tenant_get_list
Description
Returns the parameters of a list of tenants
ACLs
-
tenant.see-main.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
description |
||
block |
||
language |
||
blocked |
tenant.filter.block |
|
creation_date |
tenant.filter.creation-date |
|
creation_admin_id |
tenant.filter.created-by |
|
creation_admin_name |
tenant.filter.created-by |
|
fields <token_array> |
id |
|
name |
||
description |
tenant.see.description |
|
block |
tenant.see.blocksize |
|
language |
tenant.see.language |
|
blocked |
tenant.see.block |
|
creation_date |
tenant.see.creation-date |
|
creation_admin_id |
tenant.see.created-by |
|
creation_admin_name |
tenant.see.created-by |
|
order_by <order_list> |
id |
|
name |
||
description |
tenant.see.description |
|
block |
tenant.see.blocksize |
|
language |
tenant.see.language |
|
blocked |
tenant.see.block |
|
creation_date |
tenant.see.creation-date |
|
creation_admin_id |
tenant.see.created-by |
|
creation_admin_name |
tenant.see.created-by |
Examples
-
Input:
action=tenant_get_list
-
Output:
{
"rows" : [
{
"creation_admin_id" : 1,
"block" : 10,
"language" : "auto",
"creation_date" : "2016-02-17T16:14:54",
"id" : 1,
"creation_admin_name" : "superadmin",
"name" : "default",
"blocked" : 0,
"description" : "tenant1"
},
{
"block" : 10,
"language" : "auto",
"creation_date" : "2016-03-04T09:49:42",
"id" : 10005,
"creation_admin_name" : "superadmin",
"creation_admin_id" : 1,
"description" : null,
"blocked" : 0,
"name" : "demo"
},
{
"creation_admin_name" : "superadmin",
"block" : 10,
"language" : "auto",
"creation_date" : "2016-03-08T14:48:31",
"id" : 10006,
"creation_admin_id" : 1,
"blocked" : 0,
"description" : null,
"name" : "tenantdoc"
}
],
"message" : "Successful completion",
"status" : 0,
"total" : 3
}
3.4.2. tenant_get_details
Description
Returns all the parameters of a list of tenants
ACLs
-
tenant.see-details.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
description |
||
block |
||
language |
||
blocked |
tenant.filter.block |
|
creation_date |
tenant.filter.creation-date |
|
creation_admin_id |
tenant.filter.created-by |
|
creation_admin_name |
tenant.filter.created-by |
|
fields <token_array> |
id |
|
name |
||
description |
tenant.see.description |
|
block |
tenant.see.blocksize |
|
language |
tenant.see.language |
|
blocked |
tenant.see.block |
|
creation_date |
tenant.see.creation-date |
|
creation_admin_id |
tenant.see.created-by |
|
creation_admin_name |
tenant.see.created-by |
|
order_by <order_list> |
id |
|
name |
||
description |
tenant.see.description |
|
block |
tenant.see.blocksize |
|
language |
tenant.see.language |
|
blocked |
tenant.see.block |
|
creation_date |
tenant.see.creation-date |
|
creation_admin_id |
tenant.see.created-by |
|
creation_admin_name |
tenant.see.created-by |
Examples
-
Input:
action=tenant_get_details&filters={"id":10006}
-
Output:
{
"status" : 0,
"total" : 1,
"message" : "Successful completion",
"rows" : [
{
"blocked" : 0,
"description" : null,
"name" : "tenantdoc",
"id" : 10006,
"creation_date" : "2016-03-08T14:48:31",
"language" : "auto",
"block" : 10,
"creation_admin_name" : "superadmin",
"creation_admin_id" : 1
}
]
}
3.4.3. tenant_tiny_list
Description
Returns a small subset of parameters of the tenants
ACLs
-
tenant.see-main.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
description |
||
block |
||
language |
||
blocked |
tenant.filter.block |
|
creation_date |
tenant.filter.creation-date |
|
creation_admin_id |
tenant.filter.created-by |
|
creation_admin_name |
tenant.filter.created-by |
|
fields <token_array> |
id |
|
name |
||
order_by <order_list> |
id |
|
name |
||
description |
tenant.see.description |
|
block |
tenant.see.blocksize |
|
language |
tenant.see.language |
|
blocked |
tenant.see.block |
|
creation_date |
tenant.see.creation-date |
|
creation_admin_id |
tenant.see.created-by |
|
creation_admin_name |
tenant.see.created-by |
Examples
-
Input:
action=tenant_tiny_list&order_by={"field":"id","order":"-asc"}
-
Output:
{
"rows" : [
{
"id" : 0,
"name" : "*"
},
{
"id" : 1,
"name" : "default"
},
{
"id" : 10005,
"name" : "demo"
},
{
"id" : 10006,
"name" : "tenantdoc"
}
],
"message" : "Successful completion",
"total" : 4,
"status" : 0
}
3.4.4. tenant_all_ids
Description
Returns all tenant ids
ACLs
-
tenant.-massive.
-
tenant.see-main.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
description |
||
block |
||
language |
||
blocked |
tenant.filter.block |
|
creation_date |
tenant.filter.creation-date |
|
creation_admin_id |
tenant.filter.created-by |
|
creation_admin_name |
tenant.filter.created-by |
|
fields <token_array> |
id |
|
order_by <order_list> |
id |
|
name |
||
description |
tenant.see.description |
|
block |
tenant.see.blocksize |
|
language |
tenant.see.language |
|
blocked |
tenant.see.block |
|
creation_date |
tenant.see.creation-date |
|
creation_admin_id |
tenant.see.created-by |
|
creation_admin_name |
tenant.see.created-by |
Examples
-
Input:
action=tenant_all_ids
-
Output:
{
"status" : 0,
"total" : 4,
"message" : "Successful completion",
"rows" : [
0,
1,
10005,
10006
]
}
3.4.5. tenant_create
Description
Creates a new tenant
ACLs
-
tenant.create.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
name |
|
description |
||
block |
||
language |
||
blocked |
Examples
-
Input:
action=tenant_create&arguments={"name":"new_tenant","block":"10","language":"es"}
-
Output:
{
"total" : 1,
"status" : 0,
"rows" : [
{
"id" : 10007
}
],
"message" : "Successful completion"
}
3.4.6. tenant_update
Description
Updates the parameters of a tenant
ACLs
-
tenant.update.*
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <token_hash> |
id |
|
arguments <token_hash> |
name |
|
description |
tenant.update.description |
|
block |
tenant.update.blockesize |
|
language |
tenant.update.language |
|
blocked |
tenant.update.block |
Examples
-
Input:
action=tenant_update&filters={"id":"1"}&arguments={"description":"Main tenant"}
-
Output:
{
"status" : 0,
"total" : 1,
"rows" : [],
"message" : "Successful completion"
}
3.4.7. tenant_delete
Description
Deletes one tenant
ACLs
-
tenant.delete.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <token_hash> |
id |
Examples
-
Input:
action=tenant_delete&filters={"id":"10007"}
-
Output:
{
"status" : 0,
"total" : 1,
"rows" : [],
"message" : "Successful completion"
}
3.4.8. mytenant_update
Description
Updates the current tenant
ACLs
-
config.wat.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
name |
|
description |
||
block |
||
language |
Examples
-
Input:
action=mytenant_update&arguments={"description":"Main tenant"}
-
Output:
{
"total" : 1,
"status" : 0,
"rows" : [],
"message" : "Successful completion"
}
3.5. Administrators
3.5.1. current_admin_setup
Description
Returns the setup for the logged administrator
ACLs
Parameters
| Parameter | Token | ACL |
|---|
Examples
-
Input:
action=current_admin_setup
-
Output:
{
"admin_language" : "en",
"acls" : [
"administrator.create."
],
"tenant_id" : 0,
"admin_block" : 10,
"tenant_name" : "*",
"server_datetime" : "Tue Mar 15 15:12:19 2016",
"tenant_language" : "auto",
"message" : "Successful completion",
"views" : [],
"status" : 0,
"tenant_block" : 10,
"admin_name" : "myadmin",
"admin_id" : 1,
"multitenant" : "1"
}
3.5.2. administrator_get_list
Description
Returns the parameters of a list of administrators
ACLs
-
administrator.see-main.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
||
block |
||
language |
||
creation_date |
administrator.filter.creation-date |
|
creation_admin_id |
administrator.filter.created-by |
|
creation_admin_name |
administrator.filter.created-by |
|
fields <token_array> |
id |
|
tenant_id |
||
tenant_name |
||
name |
||
description |
administrator.see.description |
|
roles |
administrator.see.roles |
|
block |
||
language |
administrator.see.language |
|
creation_date |
administrator.see.creation-date |
|
creation_admin_id |
administrator.see.created-by |
|
creation_admin_name |
administrator.see.created-by |
|
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
administrator.see.description |
|
block |
||
language |
administrator.see.language |
|
creation_date |
administrator.see.creation-date |
|
creation_admin_id |
administrator.see.created-by |
|
creation_admin_name |
administrator.see.created-by |
Examples
-
Input:
action=administrator_get_list
-
Output:
{
"rows" : [
{
"creation_admin_name" : "superadmin",
"roles" : {
"43" : "Root"
},
"description" : null,
"language" : "en",
"creation_admin_id" : 1,
"creation_date" : "2016-02-17T16:14:54",
"tenant_name" : "*",
"id" : 1,
"name" : "superadmin",
"block" : 10,
"tenant_id" : 0
},
{
"block" : 10,
"tenant_id" : 1,
"tenant_name" : "default",
"id" : 2,
"name" : "admin",
"creation_date" : "2016-02-17T16:14:54",
"creation_admin_id" : 1,
"language" : "auto",
"description" : null,
"roles" : {
"43" : "Root"
},
"creation_admin_name" : "superadmin"
},
{
"description" : null,
"language" : "auto",
"roles" : {
"43" : "Root"
},
"creation_admin_name" : "superadmin",
"creation_date" : "2016-03-04T09:49:45",
"creation_admin_id" : 1,
"block" : 10,
"tenant_id" : 10005,
"id" : 10004,
"tenant_name" : "demo",
"name" : "admin"
}
],
"status" : 0,
"total" : 3,
"message" : "Successful completion"
}
3.5.3. administrator_get_details
Description
Returns all the parameters of an administrator
ACLs
-
administrator.see-details.*
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
fields <token_array> |
id |
|
tenant_id |
||
tenant_name |
||
name |
||
description |
administrator.see.description |
|
roles |
administrator.see.roles |
|
block |
||
language |
administrator.see.language |
|
creation_date |
administrator.see.creation-date |
|
creation_admin_id |
administrator.see.created-by |
|
creation_admin_name |
administrator.see.created-by |
|
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
administrator.see.description |
|
block |
||
language |
administrator.see.language |
|
creation_date |
administrator.see.creation-date |
|
creation_admin_id |
administrator.see.created-by |
|
creation_admin_name |
administrator.see.created-by |
Examples
-
Input:
action=administrator_get_details&filters={"id":1}
-
Output:
{
"rows" : [
{
"roles" : {
"43" : "Root"
},
"creation_admin_name" : "superadmin",
"description" : null,
"language" : "en",
"creation_admin_id" : 1,
"creation_date" : "2016-02-17T16:14:54",
"id" : 1,
"name" : "superadmin",
"tenant_name" : "*",
"block" : 10,
"tenant_id" : 0
}
],
"total" : 1,
"message" : "Successful completion",
"status" : 0
}
3.5.4. administrator_tiny_list
Description
Returns a small subset of parameters of the administrators
ACLs
-
log.filter.administrator
-
*.filter.created-by
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
fields <token_array> |
tenant_id |
|
id |
||
name |
||
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
administrator.see.description |
|
block |
||
language |
administrator.see.language |
|
creation_date |
administrator.see.creation-date |
|
creation_admin_id |
administrator.see.created-by |
|
creation_admin_name |
administrator.see.created-by |
Examples
-
Input:
action=administrator_tiny_list
-
Output:
{
"rows" : [
{
"id" : 2,
"tenant_name" : "default",
"name" : "admin"
},
{
"id" : 10004,
"tenant_name" : "demo",
"name" : "admin"
},
{
"tenant_name" : "*",
"id" : 1,
"name" : "superadmin"
}
],
"message" : "Successful completion",
"total" : 3,
"status" : 0
}
3.5.5. administrator_all_ids
Description
Returns all administrator IDs
ACLs
-
administrator.-massive.
-
administrator.see-main.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
||
block |
||
language |
||
creation_date |
administrator.filter.creation-date |
|
creation_admin_id |
administrator.filter.created-by |
|
creation_admin_name |
administrator.filter.created-by |
|
fields <token_array> |
id |
|
order_by <order_list> |
id |
|
tenant_id |
||
tenant_name |
||
name |
||
description |
administrator.see.description |
|
block |
||
language |
administrator.see.language |
|
creation_date |
administrator.see.creation-date |
|
creation_admin_id |
administrator.see.created-by |
|
creation_admin_name |
administrator.see.created-by |
Examples
-
Input:
action=administrator_all_ids
-
Output:
{
"status" : 0,
"message" : "Successful completion",
"total" : 3,
"rows" : [
2,
1,
10004
]
}
3.5.6. administrator_create
Description
Creates administrator
ACLs
-
administrator.create.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
tenant_id |
|
name |
||
password |
||
description |
||
block |
||
language |
||
__roles__ |
administrator.update.assign-role |
Examples
-
Input:
action=administrator_create&arguments={"name":"myadmin","password":"123123"}
-
Output:
{
"rows" : [
{
"id" : 10006
}
],
"total" : 1,
"message" : "Successful completion",
"status" : 0
}
3.5.7. administrator_update
Description
Updates administrator
ACLs
-
administrator.update.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
||
arguments <token_hash> |
name |
|
password |
administrator.update.password |
|
description |
administrator.update.description |
|
block |
||
language |
administrator.update.language |
|
__roles_changes__ : assign_roles |
administrator.update.assign-role |
|
__roles_changes__ : unassign_roles |
administrator.update.assign-role |
Examples
-
Input:
action=administrator_update&filters={"id":10006}&arguments={"description":"myadmin"}
-
Output:
{
"total" : 1,
"message" : "Successful completion",
"status" : 0,
"rows" : []
}
3.5.8. administrator_delete
Description
Deletes administrator
ACLs
-
administrator.delete.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
Examples
-
Input:
action=administrator_delete&filters={"id":10006}
-
Output:
{
"message" : "Successful completion",
"total" : 1,
"status" : 0,
"rows" : []
}
3.5.9. myadmin_update
Description
Updates current administrator
ACLs
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
name |
|
password |
||
description |
||
block |
||
language |
Examples
-
Input:
action=myadmin_update&arguments={"description":"myadmin"}
-
Output:
{
"rows" : [],
"message" : "Successful completion",
"total" : 1,
"status" : 0
}
3.6. Users
3.6.1. user_get_list
Description
Returns the parameters of a list of users
ACLs
-
user.see-main.
-
*.see.user-list
Channels
-
user_created
-
user_deleted
-
user_changed
-
vm_created
-
vm_deleted
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
user.filter.description |
|
blocked |
user.filter.block |
|
creation_date |
user.filter.creation-date |
|
creation_admin_id |
user.filter.created-by |
|
creation_admin_name |
user.filter.created-by |
|
fields <token_array> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
user.see.description |
|
blocked |
user.see.block |
|
number_of_vms |
user.see.vms-info |
|
number_of_vms_connected |
user.see.vm-list-state |
|
properties |
user.see.properties |
|
creation_date |
user.see.creation_date |
|
creation_admin_id |
user.see.created_by |
|
creation_admin_name |
user.see.created_by |
|
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
user.see.description |
|
blocked |
user.see.block |
|
creation_date |
user.see.creation_date |
|
creation_admin_id |
user.see.created_by |
|
creation_admin_name |
user.see.created_by |
Examples
-
Input:
action=user_get_list
-
Output:
{
"total" : 2,
"message" : "Successful completion",
"rows" : [
{
"number_of_vms_connected" : "0",
"id" : 10005,
"tenant_name" : "demo",
"creation_admin_id" : 1,
"description" : null,
"creation_admin_name" : "superadmin",
"creation_date" : "2016-03-04T09:49:47",
"name" : "user",
"tenant_id" : 10005,
"properties" : {},
"number_of_vms" : "1",
"blocked" : 0
},
{
"creation_admin_name" : "superadmin",
"number_of_vms_connected" : "0",
"id" : 10001,
"tenant_name" : "default",
"creation_admin_id" : 1,
"description" : null,
"properties" : {},
"blocked" : 0,
"number_of_vms" : "2",
"name" : "zarzuelo",
"creation_date" : "2016-03-03T15:18:38",
"tenant_id" : 1
}
],
"status" : 0
}
3.6.2. user_get_details
Description
Returns all the parameters of an user
ACLs
-
user.see-details.
Channels
-
user_created
-
user_deleted
-
user_changed
-
vm_created
-
vm_deleted
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
fields <token_array> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
user.see.description |
|
blocked |
user.see.block |
|
number_of_vms |
user.see.vms-info |
|
number_of_vms_connected |
user.see.vm-list-state |
|
properties |
user.see.properties |
|
creation_date |
user.see.creation_date |
|
creation_admin_id |
user.see.created_by |
|
creation_admin_name |
user.see.created_by |
|
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
user.see.description |
|
blocked |
user.see.block |
|
creation_date |
user.see.creation_date |
|
creation_admin_id |
user.see.created_by |
|
creation_admin_name |
user.see.created_by |
Examples
-
Input:
action=user_get_details&filters={"id":10005}
-
Output:
{
"message" : "Successful completion",
"total" : 1,
"rows" : [
{
"creation_admin_name" : "superadmin",
"description" : null,
"id" : 10005,
"creation_admin_id" : 1,
"tenant_name" : "demo",
"number_of_vms_connected" : "0",
"number_of_vms" : "1",
"blocked" : 0,
"properties" : {},
"tenant_id" : 10005,
"name" : "user",
"creation_date" : "2016-03-04T09:49:47"
}
],
"status" : 0
}
3.6.3. user_tiny_list
Description
Returns a small subset of parameters of the list of users
ACLs
-
vm.create.
-
vm.filter.user
-
tenant.purge
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
fields <token_array> |
tenant_name |
|
id |
||
name |
||
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
user.see.description |
|
blocked |
user.see.block |
|
creation_date |
user.see.creation_date |
|
creation_admin_id |
user.see.created_by |
|
creation_admin_name |
user.see.created_by |
Examples
-
Input:
action=user_tiny_list
-
Output:
{
"total" : 2,
"message" : "Successful completion",
"rows" : [
{
"name" : "user",
"id" : 10005,
"tenant_name" : "demo"
},
{
"tenant_name" : "default",
"id" : 10001,
"name" : "zarzuelo"
}
],
"status" : 0
}
3.6.4. user_all_ids
Description
Returns all users IDs
ACLs
-
host.-massive.
-
host.see-main.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
user.filter.name |
|
description |
||
tenant_id |
||
tenant_name |
||
blocked |
||
creation_date |
||
creation_admin_id |
||
creation_admin_name |
||
fields <token_array> |
id |
|
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
user.see.description |
|
blocked |
user.see.block |
|
creation_date |
user.see.creation_date |
|
creation_admin_id |
user.see.created_by |
|
creation_admin_name |
user.see.created_by |
Examples
-
Input:
action=user_all_ids
-
Output:
{
"status" : 0,
"rows" : [
10005,
10001
],
"message" : "Successful completion",
"total" : 2
}
3.6.5. user_get_state
Description
Returns user state
ACLs
-
user.see.vm-list-state
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
fields <token_array> |
number_of_vms_connected |
user.see.vms-info |
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
user.see.description |
|
blocked |
user.see.block |
|
creation_date |
user.see.creation_date |
|
creation_admin_id |
user.see.created_by |
|
creation_admin_name |
user.see.created_by |
Examples
-
Input:
action=host_get_state&filters={"id":10000}
-
Output:
{
"rows" : [
{
"number_of_vms_connected" : null
}
],
"status" : 0,
"total" : 1,
"message" : "Successful completion"
}
3.6.6. user_create
Description
Creates an user
ACLs
-
user.create.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
tenant_id |
|
name |
||
password |
||
description |
||
blocked |
||
__properties__ |
user.create.properties |
Examples
-
Input:
action=host_create&arguments={"name":"localhost","address":"10.3.15.1"}
-
Output:
{
"message" : "Successful completion",
"total" : 1,
"rows" : [
{
"id" : 10000
}
],
"status" : 0
}
3.6.7. user_update
Description
Updates an user
ACLs
-
user.update.*
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
name |
|
password |
user.update.password |
|
description |
user.update.description |
|
address |
user.update.address |
|
blocked |
user.update.blocked |
|
__properties_changes__ : set |
user.update.properties |
|
__properties_changes__ : delete |
user.update.properties |
|
filters <filter_list> |
id |
Examples
-
Input:
action=user_update&arguments={"description":"User description"}&filters={"id":10000}
-
Output:
{
"status" : 0,
"rows" : [],
"total" : 1,
"message" : "Successful completion"
}
3.6.8. user_delete
Description
Deletes an user
ACLs
-
user.delete.
-
tenant.purge.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
Examples
-
Input:
action=user_delete&filters={"id":10000}
-
Output:
{
"status" : 0,
"rows" : [],
"total" : 1,
"message" : "Successful completion"
}
3.7. Hosts
3.7.1. host_get_list
Description
Returns the parameters of a list of hosts
ACLs
-
host.see-main.
Channels
-
host_created
-
host_deleted
-
host_changed
-
vm_created
-
vm_deleted
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
description |
||
address |
||
frontend |
||
backend |
||
vm_id |
host.filter.vm |
|
state |
host.filter.state |
|
blocked |
host.filter.block |
|
creation_date |
host.filter.creation-date |
|
creation_admin_id |
host.filter.created-by |
|
creation_admin_name |
host.filter.created-by |
|
fields <token_array> |
id |
|
name |
||
description |
host.see.description |
|
address |
host.see.address |
|
frontend |
||
backend |
||
state |
host.see.state |
|
load |
||
blocked |
host.see.block |
|
number_of_vms_connected |
host.see.vms-info |
|
properties |
host.see.properties |
|
creation_date |
host.see.creation-date |
|
creation_admin_id |
host.see.created-by |
|
creation_admin_name |
host.see.created-by |
|
order_by <order_list> |
id |
|
name |
||
description |
host.see.description |
|
address |
host.see.address |
|
state |
host.see.state |
|
blocked |
host.see.block |
|
creation_date |
host.see.creation-date |
|
creation_admin_id |
host.see.created-by |
|
creation_admin_name |
host.see.created-by |
Examples
-
Input:
action=host_get_list
-
Output:
{
"rows" : [
{
"frontend" : 1,
"blocked" : 0,
"name" : "localhost",
"id" : 10000,
"description" : null,
"creation_admin_id" : 1,
"backend" : 1,
"address" : "10.3.15.1",
"creation_date" : "2016-03-03T14:06:14",
"number_of_vms_connected" : "0",
"creation_admin_name" : "superadmin",
"state" : "running",
"load" : null,
"properties" : {}
}
],
"message" : "Successful completion",
"status" : 0,
"total" : 1
}
3.7.2. host_get_details
Description
Returns all the parameters of a list of hosts
ACLs
-
host.see-details.
-
host.see-main.
Channels
-
host_created
-
host_deleted
-
host_changed
-
vm_created
-
vm_deleted
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
fields <token_array> |
id |
|
name |
||
description |
host.see.description |
|
address |
host.see.address |
|
frontend |
||
backend |
||
state |
host.see.state |
|
load |
||
blocked |
host.see.block |
|
number_of_vms_connected |
host.see.vms-info |
|
properties |
host.see.properties |
|
creation_date |
host.see.creation-date |
|
creation_admin_id |
host.see.created-by |
|
creation_admin_name |
host.see.created-by |
|
order_by <order_list> |
id |
|
name |
||
description |
host.see.description |
|
address |
host.see.address |
|
state |
host.see.state |
|
blocked |
host.see.block |
|
creation_date |
host.see.creation-date |
|
creation_admin_id |
host.see.created-by |
|
creation_admin_name |
host.see.created-by |
Examples
-
Input:
action=host_get_details&filters={"id":10000}
-
Output:
{
"rows" : [
{
"creation_date" : "2016-03-03T14:06:14",
"number_of_vms_connected" : "0",
"creation_admin_id" : 1,
"description" : null,
"backend" : 1,
"address" : "10.3.15.1",
"id" : 10000,
"frontend" : 1,
"blocked" : 0,
"name" : "localhost",
"properties" : {},
"load" : null,
"creation_admin_name" : "superadmin",
"state" : "running"
}
],
"message" : "Successful completion",
"total" : 1,
"status" : 0
}
3.7.3. host_tiny_list
Description
Returns a small subset of parameters of the list of hosts
ACLs
-
vm.filter.host
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
||
fields <token_array> |
id |
|
name |
||
order_by <order_list> |
id |
|
name |
||
description |
host.see.description |
|
address |
host.see.address |
|
state |
host.see.state |
|
blocked |
host.see.block |
|
creation_date |
host.see.creation-date |
|
creation_admin_id |
host.see.created-by |
|
creation_admin_name |
host.see.created-by |
Examples
-
Input:
action=host_tiny_list
-
Output:
{
"total" : 1,
"status" : 0,
"rows" : [
{
"name" : "localhost",
"id" : 10000
}
],
"message" : "Successful completion"
}
3.7.4. host_all_ids
Description
Returns all host IDs
ACLs
-
host.-massive.
-
host.see-main.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
description |
||
address |
||
frontend |
||
backend |
||
vm_id |
host.filter.vm |
|
state |
host.filter.state |
|
blocked |
host.filter.block |
|
creation_date |
host.filter.creation-date |
|
creation_admin_id |
host.filter.created-by |
|
creation_admin_name |
host.filter.created-by |
|
fields <token_array> |
id |
|
order_by <order_list> |
id |
|
name |
||
description |
host.see.description |
|
address |
host.see.address |
|
state |
host.see.state |
|
blocked |
host.see.block |
|
creation_date |
host.see.creation-date |
|
creation_admin_id |
host.see.created-by |
|
creation_admin_name |
host.see.created-by |
Examples
-
Input:
action=host_all_ids
-
Output:
{
"status" : 0,
"total" : 1,
"message" : "Successful completion",
"rows" : [
10000
]
}
3.7.5. host_get_state
Description
Returns host state
ACLs
-
host.see.vm-list-state
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
fields <token_array> |
number_of_vms_connected |
host.see.vms-info |
order_by <order_list> |
id |
|
name |
||
description |
host.see.description |
|
address |
host.see.address |
|
state |
host.see.state |
|
blocked |
host.see.block |
|
creation_date |
host.see.creation-date |
|
creation_admin_id |
host.see.created-by |
|
creation_admin_name |
host.see.created-by |
Examples
-
Input:
action=host_get_state&filters={"id":10000}
-
Output:
{
"total" : 1,
"status" : 0,
"message" : "Successful completion",
"rows" : [
{
"number_of_vms_connected" : 1
}
]
}
3.7.6. host_create
Description
Creates a host
ACLs
-
host.create.*
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
name |
|
description |
||
address |
||
frontend |
||
backend |
||
state |
||
blocked |
||
__properties__ |
host.create.properties |
Examples
-
Input:
action=host_create&arguments={"name":"localhost","address":"10.3.15.1"}
-
Output:
{
"message" : "Successful completion",
"rows" : [
{
"id" : 10000
}
],
"total" : 1,
"status" : 0
}
3.7.7. host_update
Description
Updates a host
ACLs
-
host.update.*
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
name |
host.update.name |
description |
host.update.description |
|
address |
host.update.address |
|
blocked |
host.update.blocked |
|
__properties_changes__ : set |
host.update.properties |
|
__properties_changes__ : delete |
host.update.properties |
|
filters <filter_list> |
id |
Examples
-
Input:
action=host_update&arguments={"description":"Host description"}&filters={"id":10000}
-
Output:
{
"total" : 1,
"status" : 0,
"rows" : [],
"message" : "Successful completion"
}
3.7.8. host_delete
Description
Deletes a host
ACLs
-
host.delete.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
Examples
-
Input:
action=host_delete&filters={"id":10000}
-
Output:
{
"total" : 1,
"status" : 0,
"message" : "Successful completion",
"rows" : []
}
3.8. OSFs
3.8.1. osf_get_list
Description
Returns the parameters of a list of OSFs
ACLs
-
osf.see-main.
Channels
-
vm_created
-
vm_deleted
-
di_created
-
di_deleted
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
||
overlay |
||
user_storage |
||
memory |
||
vm_id |
osf.filter.vm |
|
di_id |
osf.filter.di |
|
creation_date |
osf.filter.creation-date |
|
creation_admin_id |
osf.filter.created-by |
|
creation_admin_name |
osf.filter.created-by |
|
fields <token_array> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
osf.see.description |
|
overlay |
osf.see.overlay |
|
user_storage |
osf.see.user-storage |
|
memory |
osf.see.memory |
|
number_of_vms |
osf.see.vms-info |
|
number_of_dis |
osf.see.dis-info |
|
properties |
osf.see.properties |
|
creation_date |
osf.see.creation-date |
|
creation_admin_id |
osf.see.created-by |
|
creation_admin_name |
osf.see.created-by |
|
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
osf.see.description |
|
overlay |
osf.see.overlay |
|
user_storage |
osf.see.user-storage |
|
memory |
osf.see.memory |
|
creation_date |
osf.see.creation-date |
|
creation_admin_id |
osf.see.created-by |
|
creation_admin_name |
osf.see.created-by |
Examples
-
Input:
action=osf_get_list
-
Output:
{
"rows" : [
{
"creation_date" : "2016-03-04T09:49:48",
"tenant_id" : 10005,
"name" : "OSF_Standard",
"creation_admin_name" : "superadmin",
"memory" : 256,
"user_storage" : 0,
"description" : null,
"number_of_vms" : "1",
"id" : 10003,
"tenant_name" : "demo",
"creation_admin_id" : 1,
"properties" : {},
"number_of_dis" : "1",
"overlay" : 1
},
{
"name" : "zOSF",
"tenant_id" : 1,
"creation_date" : "2016-03-03T15:19:03",
"number_of_vms" : "2",
"description" : null,
"user_storage" : 0,
"memory" : 256,
"creation_admin_name" : "superadmin",
"properties" : {},
"creation_admin_id" : 1,
"tenant_name" : "default",
"id" : 10000,
"overlay" : 1,
"number_of_dis" : "1"
}
],
"message" : "Successful completion",
"total" : 2,
"status" : 0
}
3.8.2. osf_get_details
Description
Returns all the parameters of an OSF
ACLs
-
osf.see-details.
Channels
-
vm_created
-
vm_deleted
-
vm_changed
-
di_created
-
di_deleted
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
||
fields <token_array> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
osf.see.description |
|
overlay |
osf.see.overlay |
|
user_storage |
osf.see.user-storage |
|
memory |
osf.see.memory |
|
number_of_vms |
osf.see.vms-info |
|
number_of_dis |
osf.see.dis-info |
|
properties |
osf.see.properties |
|
creation_date |
osf.see.creation-date |
|
creation_admin_id |
osf.see.created-by |
|
creation_admin_name |
osf.see.created-by |
|
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
osf.see.description |
|
overlay |
osf.see.overlay |
|
user_storage |
osf.see.user-storage |
|
memory |
osf.see.memory |
|
creation_date |
osf.see.creation-date |
|
creation_admin_id |
osf.see.created-by |
|
creation_admin_name |
osf.see.created-by |
Examples
-
Input:
action=osf_get_details&filters={"id":10000}
-
Output:
{}
3.8.3. osf_tiny_list
Description
Returns a subset of parameters of the OSFs
ACLs
-
di.create.osf
-
vm.create.osf
-
di.filter.osf
-
vm.filter.osf
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
fields <token_array> |
id |
|
name |
||
tenant_name |
||
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
osf.see.description |
|
overlay |
osf.see.overlay |
|
user_storage |
osf.see.user-storage |
|
memory |
osf.see.memory |
|
creation_date |
osf.see.creation-date |
|
creation_admin_id |
osf.see.created-by |
|
creation_admin_name |
osf.see.created-by |
Examples
-
Input:
action=osf_tiny_list&filters={"id":10000}
-
Output:
{}
3.8.4. osf_all_ids
Description
Returns all the ids of the OSFs
ACLs
-
osf.see-main.
-
osf.-massive.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
||
overlay |
||
user_storage |
||
memory |
||
vm_id |
osf.filter.vm |
|
di_id |
osf.filter.di |
|
creation_date |
osf.filter.creation-date |
|
creation_admin_id |
osf.filter.created-by |
|
creation_admin_name |
osf.filter.created-by |
|
fields <token_array> |
id |
|
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
description |
osf.see.description |
|
overlay |
osf.see.overlay |
|
user_storage |
osf.see.user-storage |
|
memory |
osf.see.memory |
|
creation_date |
osf.see.creation-date |
|
creation_admin_id |
osf.see.created-by |
|
creation_admin_name |
osf.see.created-by |
Examples
-
Input:
action=osf_all_ids
-
Output:
{}
3.8.5. osf_create
Description
Creates a OSF
ACLs
-
osf.create.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
name |
|
description |
||
overlay |
||
user_storage |
osf.create.user-storage |
|
memory |
osf.create.memory |
|
tenant_id |
||
__properties__ |
osf.create.properties |
Examples
-
Input:
action=osf_create&arguments={"name":"osf"}
-
Output:
{
"status" : 0,
"total" : 1,
"message" : "Successful completion",
"rows" : [
{
"id" : 10005
}
]
}
3.8.6. osf_update
Description
Updates the parameters of a OSF
ACLs
-
osf.update.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
||
arguments <token_hash> |
name |
osf.update.name |
description |
osf.update.description |
|
overlay |
||
user_storage |
osf.update.user-storage |
|
memory |
osf.update.memory |
|
tenant_id |
||
__properties_changes__ : set |
osf.update.properties |
|
__properties_changes__ : delete |
osf.update.properties |
Examples
-
Input:
action=osf_update&filters={"id":10000}&arguments={"memory":100}
-
Output:
{
"message" : "Successful completion",
"rows" : [],
"status" : 0,
"total" : 1
}
3.8.7. osf_delete
Description
Deletes a OSF
ACLs
-
osf.delete.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
Examples
-
Input:
action=osf_delete&filters={"id":10000}
-
Output:
{
"rows" : [],
"message" : "Successful completion",
"total" : 1,
"status" : 0
}
3.9. Disk Images
3.9.1. di_get_list
Description
Returns the parameters of a list of Disk Images
ACLs
-
di.see-main.
-
*.see.di-list
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
disk_image |
||
tenant_id |
||
tenant_name |
||
description |
||
version |
||
osf_id |
di.filter.osf |
|
osf.see.di-list |
||
osf_name |
di.filter.osf |
|
blocked |
||
tag |
||
creation_date |
||
creation_admin_id |
||
creation_admin_name |
||
fields <token_array> |
id |
|
disk_image |
||
tenant_id |
||
tenant_name |
||
description |
di.see.description |
|
version |
di.see.version |
|
osf_id |
di.see.osf |
|
osf_name |
di.see.osf |
|
blocked |
di.see.block |
|
tags |
di.see.tags |
|
di.see.head |
||
di.see.default |
||
*.see.di-list-tags |
||
*.see.di-list-head |
||
*.see.di-list-default |
||
properties |
di.see.properties |
|
creation_date |
di.see.created-by |
|
creation_admin_id |
di.see.created-by |
|
creation_admin_name |
di.see.created-date |
|
order_by <order_list> |
id |
|
disk_image |
||
tenant_id |
||
tenant_name |
||
description |
di.see.description |
|
version |
di.see.version |
|
osf_id |
di.see.osf |
|
osf_name |
di.see.osf |
|
blocked |
di.see.block |
|
creation_date |
di.see.created-by |
|
creation_admin_id |
di.see.created-by |
|
creation_admin_name |
di.see.created-date |
Examples
-
Input:
action=di_get_list
-
Output:
{
"rows" : [
{
"creation_date" : "2016-03-04T09:50:42",
"disk_image" : "10003-Desktop_Standard.tar.gz",
"id" : 10003,
"tenant_id" : 10005,
"tenant_name" : "demo",
"creation_admin_id" : 1,
"osf_name" : "OSF_Standard",
"version" : "2016-03-04-000",
"description" : null,
"osf_id" : 10003,
"properties" : {},
"creation_admin_name" : "superadmin",
"blocked" : 0,
"tags" : [
{
"fixed" : true,
"id" : 10010,
"tag" : "2016-03-04-000"
},
{
"fixed" : false,
"tag" : "default",
"id" : 10012
},
{
"fixed" : false,
"tag" : "head",
"id" : 10011
}
]
}
],
"status" : 0,
"message" : "Successful completion",
"total" : 1
}
3.9.2. di_get_details
Description
Returns all the parameters of a Disk Image
ACLs
-
di.see-details.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
||
fields <token_array> |
id |
|
tenant_id |
||
tenant_name |
||
disk_image |
||
description |
di.see.description |
|
version |
di.see.version |
|
osf_id |
di.see.osf |
|
osf_name |
di.see.osf |
|
blocked |
di.see.block |
|
tags |
di.see.tags |
|
di.see.head |
||
di.see.default |
||
*.see.di-list-tags |
||
*.see.di-list-head |
||
*.see.di-list-default |
||
properties |
di.see.properties |
|
creation_date |
di.see.created-by |
|
creation_admin_id |
di.see.created-by |
|
creation_admin_name |
di.see.created-date |
|
order_by <order_list> |
id |
|
disk_image |
||
tenant_id |
||
tenant_name |
||
description |
di.see.description |
|
version |
di.see.version |
|
osf_id |
di.see.osf |
|
osf_name |
di.see.osf |
|
blocked |
di.see.block |
|
creation_date |
di.see.created-by |
|
creation_admin_id |
di.see.created-by |
|
creation_admin_name |
di.see.created-date |
Examples
-
Input:
action=di_get_details&filters={"id":10003}
-
Output:
{
"status" : 0,
"rows" : [
{
"disk_image" : "10003-Desktop_Standard.tar.gz",
"creation_date" : "2016-03-04T09:50:42",
"properties" : {},
"osf_id" : 10003,
"osf_name" : "OSF_Standard",
"creation_admin_id" : 1,
"description" : null,
"version" : "2016-03-04-000",
"tenant_id" : 10005,
"id" : 10003,
"tenant_name" : "demo",
"tags" : [
{
"tag" : "2016-03-04-000",
"id" : 10010,
"fixed" : true
},
{
"fixed" : false,
"tag" : "default",
"id" : 10012
},
{
"tag" : "head",
"id" : 10011,
"fixed" : false
}
],
"blocked" : 0,
"creation_admin_name" : "superadmin"
}
],
"total" : 1,
"message" : "Successful completion"
}
3.9.3. di_all_ids
Description
Returns all the ids of the Disk Images
ACLs
-
di.-massive.
-
di.see-main.
-
*.see.di-list
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
disk_image |
di.filter.disk-image |
|
description |
||
version |
||
osf_id |
di.filter.osf |
|
osf.see.di-list |
||
osf_name |
di.filter.osf |
|
osf |
di.filter.osf |
|
tenant_id |
||
tenant_name |
||
blocked |
||
tag |
||
creation_date |
||
creation_admin_id |
||
creation_admin_name |
||
fields <token_array> |
id |
|
order_by <order_list> |
id |
|
tenant_id |
||
tenant_name |
||
disk_image |
||
description |
di.see.description |
|
version |
di.see.version |
|
osf_id |
di.see.osf |
|
osf_name |
di.see.osf |
|
blocked |
di.see.block |
|
creation_date |
di.see.created-by |
|
creation_admin_id |
di.see.created-by |
|
creation_admin_name |
di.see.created-date |
Examples
-
Input:
action=di_all_ids
-
Output:
{
"total" : 1,
"message" : "Successful completion",
"status" : 0,
"rows" : [
10003
]
}
3.9.4. di_tiny_list
Description
Returns a subset of parameters of a list of Disk Images
ACLs
-
osf.filter.di
-
tenant.purge.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
fields <token_array> |
id |
|
disk_image |
||
tenant_name |
||
order_by <order_list> |
id |
|
tenant_id |
||
tenant_name |
||
disk_image |
||
description |
di.see.description |
|
version |
di.see.version |
|
osf_id |
di.see.osf |
|
osf_name |
di.see.osf |
|
blocked |
di.see.block |
|
creation_date |
di.see.created-by |
|
creation_admin_id |
di.see.created-by |
|
creation_admin_name |
di.see.created-date |
Examples
-
Input:
action=di_tiny_list
-
Output:
{
"rows" : [
{
"tenant_name" : "demo",
"id" : 10003,
"disk_image" : "10003-Desktop_Standard.tar.gz"
}
],
"status" : 0,
"message" : "Successful completion",
"total" : 1
}
3.9.5. tag_get_list
Description
Returns the list of disk images tags
ACLs
-
vm.create.
-
vm.update.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
name |
||
osf_id |
||
di_id |
||
tenant_id |
||
tenant_name |
||
fields <token_array> |
id |
|
name |
||
osf_id |
||
di_id |
||
order_by <order_list> |
id |
|
name |
||
tenant_id |
||
tenant_name |
||
osf_id |
||
di_id |
Examples
-
Input:
action=tag_get_list
-
Output:
{
"status" : 0,
"rows" : [
{
"osf_id" : 10003,
"id" : 10012,
"tenant_id" : 10005,
"tenant_name" : "demo",
"di_id" : 10003,
"name" : "default"
},
{
"name" : "head",
"di_id" : 10003,
"tenant_name" : "demo",
"id" : 10011,
"tenant_id" : 10005,
"osf_id" : 10003
},
{
"di_id" : 10003,
"name" : "2016-03-04-000",
"osf_id" : 10003,
"tenant_id" : 10005,
"id" : 10010,
"tenant_name" : "demo"
}
],
"total" : 3,
"message" : "Successful completion"
}
3.9.6. tag_tiny_list
Description
Returns a subset of parameters of a list of disk images tags
ACLs
-
vm.create.
-
vm.update.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
osf_id |
||
fields <token_array> |
id |
|
name |
||
order_by <order_list> |
id |
|
name |
||
osf_id |
||
di_id |
Examples
-
Input:
action=tag_tiny_list
-
Output:
{
"status" : 0,
"rows" : [
{
"id" : 10010,
"name" : "2016-03-04-000"
},
{
"id" : 10012,
"name" : "default"
},
{
"name" : "head",
"id" : 10011
}
],
"total" : 3,
"message" : "Successful completion"
}
3.9.7. di_create
Description
Creates a Disk Image
ACLs
-
di.create.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
disk_image |
|
blocked |
||
description |
||
version |
||
osf_id |
||
__properties__ |
di.create.properties |
|
__tags__ |
di.create.tags |
|
di.create.default |
Examples
-
Input:
action=di_create
-
Output:
{}
3.9.8. di_update
Description
Updates a Disk Image
ACLs
-
di.update.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
||
arguments <token_hash> |
blocked |
di.update.block |
description |
di.update.description |
|
__properties_changes__ : set |
di.update.properties |
|
__properties_changes__ : delete |
di.update.properties |
|
__tags_changes__ : create |
di.update.tags |
|
di.update.defaults |
||
osf.see.di-list-default-update |
||
__tags_changes__ : delete |
di.update.tags |
|
di.update.defaults |
||
osf.see.di-list-default-update |
Examples
-
Input:
action=di_update
-
Output:
{
"rows" : [
{
"disk_image" : "10003-Desktop_Standard.tar.gz",
"creation_date" : "2016-03-04T09:50:42",
"osf_id" : 10003,
"properties" : {},
"creation_admin_id" : 1,
"osf_name" : "OSF_Standard",
"version" : "2016-03-04-000",
"description" : null,
"id" : 10003,
"tenant_id" : 10005,
"tenant_name" : "demo",
"tags" : [
{
"tag" : "2016-03-04-000",
"id" : 10010,
"fixed" : true
},
{
"id" : 10012,
"tag" : "default",
"fixed" : false
},
{
"id" : 10011,
"tag" : "head",
"fixed" : false
}
],
"blocked" : 0,
"creation_admin_name" : "superadmin"
}
],
"status" : 0,
"message" : "Successful completion",
"total" : 1
}
3.9.9. di_delete
Description
Deletes a Disk Image
ACLs
-
di.delete.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
Examples
-
Input:
action=di_delete
-
Output:
{}
3.9.10. dis_in_staging
Description
Returns the whole list of disk images in staging directory
ACLs
-
di.create.
Parameters
| Parameter | Token | ACL |
|---|
Examples
-
Input:
action=dis_in_staging
-
Output:
{
"message" : "Successful completion",
"total" : 4,
"rows" : [
{
"name" : "image-empty.tar.gz"
},
{
"name" : "Desktop_Empty.tar.gz"
},
{
"name" : "ubuntu-13.04-i386-qvd.tar.gz"
},
{
"name" : "Desktop_Standard.tar.gz"
}
],
"status" : 0
}
3.10. Configuration
3.10.1. config_get
Description
Returns all the configuration values
ACLs
-
config.qvd.
-
tenant.purge.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
key |
|
tenant_id |
||
operative_value |
||
default_value |
||
is_default |
||
order_by <order_list> |
key |
|
fields <token_array> |
key |
|
tenant_id |
||
operative_value |
||
default_value |
||
is_default |
Examples
-
Input:
action=config_get&filters={"key":"wat"}&order_by={"order":"-desc"}
-
Output:
{
"total" : 7,
"status" : 0,
"rows" : [
{
"default_value" : null,
"is_default" : 0,
"key" : "wat.wat.public.fail",
"operative_value" : "fail"
},
{
"default_value" : null,
"is_default" : 0,
"operative_value" : "https://myqvd.theqvd.com",
"key" : "wat.public.link"
},
{
"is_default" : 0,
"operative_value" : "1",
"key" : "wat.multitenant",
"default_value" : "0"
},
{
"is_default" : 1,
"key" : "wat.log.filename",
"operative_value" : "/var/log/qvd/qvd-wat.log",
"default_value" : "${path.log}/qvd-wat.log"
},
{
"default_value" : "admin",
"is_default" : 1,
"key" : "wat.admin.password",
"operative_value" : "admin"
},
{
"default_value" : "admin",
"is_default" : 1,
"key" : "wat.admin.login",
"operative_value" : "admin"
},
{
"default_value" : "/usr/lib/qvd/wat",
"is_default" : 1,
"operative_value" : "/usr/lib/qvd/wat",
"key" : "path.wat"
}
],
"message" : "Successful completion"
}
3.10.2. config_ssl
Description
Store SSL certificates into the configuration
ACLs
-
config.qvd.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
cert |
|
key |
||
crl |
||
ca |
Examples
-
Input:
action=config_ssl&arguments={"cert":"/path/to/cert.pem","key":"/path/to/key.pem"}
-
Output:
{
"total" : 1,
"status" : 0,
"rows" : [],
"message" : "Successful completion"
}
3.10.3. config_set
Description
Create or update a configuration token
ACLs
-
config.qvd.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
tenant_id |
|
key |
||
value |
Examples
-
Input:
action=config_set&arguments={"key":"admin.token","value":"token"}
-
Output:
{
"message" : "Successful completion",
"rows" : [
{
"tenant_id" : 10000,
"key" : "admin.token"
}
],
"status" : 0,
"total" : 1
}
3.10.4. config_delete
Description
Deletes a configuration token
ACLs
-
config.qvd.
-
tenant.purge.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <token_hash> |
tenant_id |
|
key |
Examples
-
Input:
action=config_delete&arguments={"key":"admin.token"}
-
Output:
{
"rows" : [],
"status" : 0,
"message" : "Successful completion",
"total" : 1
}
3.10.5. config_wat_get_details
Description
Returns the configuration of the WAT
ACLs
-
config.wat.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <token_hash> |
tenant_id |
|
block |
||
language |
Examples
-
Input:
action=config_wat_get_details
-
Output:
{
"status" : 0,
"rows" : [
{
"language" : "auto",
"block" : 10,
"tenant_id" : 1
}
],
"message" : "Successful completion",
"total" : 1
}
3.10.6. config_wat_update
Description
Updates the configuration of the WAT
ACLs
-
config.wat.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
tenant_id |
|
block |
||
language |
Examples
-
Input:
action=config_wat_update&arguments={"block":"20"}
-
Output:
{
"status" : 0,
"rows" : [],
"message" : "Successful completion"
}
3.11. Properties
3.11.1. property_get_list
Description
Returns the parameters of a list of properties
ACLs
-
property.see-main
-
tenant.purge.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
fields <token_array> |
id |
|
key |
||
description |
||
tenant_id |
||
property_id |
||
in_user |
||
in_vm |
||
in_host |
||
in_di |
||
in_osf |
||
order_by <order_list> |
id |
|
key |
||
description |
||
property_id |
||
tenant_id |
Examples
-
Input:
action=role_get_list&filters={"id":1}
-
Output:
{
"status" : 0,
"message" : "Successful completion",
"rows" : [
{
"creation_admin_id" : null,
"acls" : {
"positive" : [
"administrator.create.",
"administrator.create.language"
],
"negative" : []
},
"tenant_id" : -1,
"internal" : 1,
"roles" : {},
"name" : "Administrators Creator",
"description" : null,
"id" : 1,
"creation_admin_name" : null,
"tenant_name" : "-",
"fixed" : 1,
"creation_date" : null
}
],
"total" : 1
}
3.11.2. property_create
Description
Creates a property
ACLs
-
property.see-main
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
key |
|
tenant_id |
||
description |
||
__property_assign__ |
property.manage. |
Examples
-
Input:
action=property_create&arguments={"key":"email"}
-
Output:
{
"total" : 1,
"rows" : [
{
"id" : 1
}
],
"message" : "Successful completion",
"status" : 0
}
3.11.3. property_update
Description
Updates a property
ACLs
-
property.see-main
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
||
arguments <token_hash> |
key |
|
description |
Examples
-
Input:
action=property_delete&filters={"id":1}&arguments={"key":"Email"}
-
Output:
{
"status" : 0,
"total" : 1,
"message" : "Successful completion",
"rows" : []
}
3.11.4. property_delete
Description
Deletes a property
ACLs
-
property.see-main
-
tenant.purge.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
Examples
-
Input:
action=property_delete&filters={"id":1}
-
Output:
{
"status" : 0,
"rows" : [],
"message" : "Successful completion",
"total" : 1
}
3.11.5. host_get_property_list
Description
Returns the properties of a tenant hosts
ACLs
-
host.see.properties
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
fields <token_array> |
id |
|
property_id |
||
key |
||
description |
||
tenant_id |
||
tenant_name |
||
order_by <order_list> |
id |
|
key |
||
property_id |
Examples
-
Input:
action=host_get_property_list
-
Output:
{
"message" : "Successful completion",
"rows" : [
{
"property_id" : 10000,
"tenant_name" : "demo",
"description" : null,
"key" : "Location",
"id" : 10002,
"tenant_id" : 10005
}
],
"total" : 1,
"status" : 0
}
3.11.6. host_create_property_list
Description
Assign a property to the hosts of a tenant
ACLs
-
property.manage.host
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
property_id |
Examples
-
Input:
action=host_create_property_list&arguments={"property_id":10000}
-
Output:
{
"status" : 0,
"total" : 1,
"message" : "Successful completion",
"rows" : [
{
"id" : 10006
}
]
}
3.11.7. host_delete_property_list
Description
Unassign a property from the hosts of a tenant
ACLs
-
property.manage.host
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
Examples
-
Input:
action=host_delete_property_list&filters={"id":10000}
-
Output:
{
"status" : 0,
"rows" : [],
"message" : "Successful completion",
"total" : 1
}
3.11.8. user_get_property_list
Description
Returns the properties of a tenant users
ACLs
-
user.see.properties
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
fields <token_array> |
id |
|
property_id |
||
key |
||
description |
||
tenant_id |
||
tenant_name |
||
order_by <order_list> |
id |
|
key |
||
property_id |
Examples
-
Input:
action=user_get_property_list
-
Output:
{
"rows" : [
{
"id" : 10002,
"key" : "Location",
"tenant_id" : 10005,
"property_id" : 10000,
"tenant_name" : "demo",
"description" : null
}
],
"message" : "Successful completion",
"total" : 1,
"status" : 0
}
3.11.9. user_create_property_list
Description
Assign a property to the users of a tenant
ACLs
-
property.manage.user
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
property_id |
Examples
-
Input:
action=user_create_property_list&arguments={"property_id":10001}
-
Output:
{
"status" : 0,
"total" : 1,
"message" : "Successful completion",
"rows" : [
{
"id" : 10006
}
]
}
3.11.10. user_delete_property_list
Description
Unassign a property from the users of a tenant
ACLs
-
property.manage.user
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
Examples
-
Input:
action=user_delete_property_list&filters={"id":10000}
-
Output:
{
"total" : 1,
"message" : "Successful completion",
"rows" : [],
"status" : 0
}
3.11.11. vm_get_property_list
Description
Returns the properties of a tenant virtual machines
ACLs
-
vm.see.properties
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
fields <token_array> |
id |
|
property_id |
||
key |
||
description |
||
tenant_id |
||
tenant_name |
||
order_by <order_list> |
id |
|
key |
||
property_id |
Examples
-
Input:
action=vm_get_property_list
-
Output:
{
"message" : "Successful completion",
"rows" : [
{
"description" : null,
"tenant_name" : "demo",
"property_id" : 10000,
"tenant_id" : 10005,
"id" : 10002,
"key" : "Location"
}
],
"total" : 1,
"status" : 0
}
3.11.12. vm_create_property_list
Description
Assign a property to the virtual machines of a tenant
ACLs
-
property.manage.vm
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
property_id |
Examples
-
Input:
action=vm_create_property_list&arguments={"property_id":10001}
-
Output:
{
"status" : 0,
"rows" : [
{
"id" : 10006
}
],
"message" : "Successful completion",
"total" : 1
}
3.11.13. vm_delete_property_list
Description
Unassign a property from the virtual machines of a tenant
ACLs
-
property.manage.vm
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
Examples
-
Input:
action=vm_delete_property_list&filters={"id":10000}
-
Output:
{
"status" : 0,
"total" : 1,
"rows" : [],
"message" : "Successful completion"
}
3.11.14. osf_get_property_list
Description
Returns the properties of a tenant OSFs
ACLs
-
osf.see.properties
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
fields <token_array> |
id |
|
property_id |
||
key |
||
description |
||
tenant_id |
||
tenant_name |
||
order_by <order_list> |
id |
|
key |
||
property_id |
Examples
-
Input:
action=osf_get_property_list
-
Output:
{
"message" : "Successful completion",
"rows" : [
{
"description" : null,
"property_id" : 10000,
"tenant_name" : "demo",
"tenant_id" : 10005,
"key" : "Location",
"id" : 10002
}
],
"total" : 1,
"status" : 0
}
3.11.15. osf_create_property_list
Description
Assign a property to the OSFs of a tenant
ACLs
-
property.manage.osf
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
property_id |
Examples
-
Input:
action=osf_create_property_list&arguments={"property_id":10001}
-
Output:
{
"message" : "Successful completion",
"rows" : [
{
"id" : 10006
}
],
"total" : 1,
"status" : 0
}
3.11.16. osf_delete_property_list
Description
Unassign a property from the OSFs of a tenant
ACLs
-
property.manage.osf
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
Examples
-
Input:
action=osf_delete_property_list&filters={"id":10000}
-
Output:
{
"message" : "Successful completion",
"rows" : [],
"total" : 1,
"status" : 0
}
3.11.17. di_get_property_list
Description
Returns the properties of a tenant Disk Images
ACLs
-
di.see.properties
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
fields <token_array> |
id |
|
property_id |
||
key |
||
description |
||
tenant_id |
||
tenant_name |
||
order_by <order_list> |
id |
|
key |
||
property_id |
Examples
-
Input:
action=di_get_property_list
-
Output:
{
"message" : "Successful completion",
"rows" : [
{
"tenant_id" : 10005,
"id" : 10002,
"key" : "Location",
"description" : null,
"property_id" : 10000,
"tenant_name" : "demo"
}
],
"total" : 1,
"status" : 0
}
3.11.18. di_create_property_list
Description
Assign a property to the Disk Images of a tenant
ACLs
-
property.manage.di
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
property_id |
Examples
-
Input:
action=di_create_property_list&arguments={"property_id":10001}
-
Output:
{
"total" : 1,
"message" : "Successful completion",
"rows" : [
{
"id" : 10006
}
],
"status" : 0
}
3.11.19. di_delete_property_list
Description
Unassign a property from the Disk Images of a tenant
ACLs
-
property.manage.di
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
id |
|
tenant_id |
Examples
-
Input:
action=di_delete_property_list&filters={"id":10000}
-
Output:
{
"total" : 1,
"message" : "Successful completion",
"rows" : [],
"status" : 0
}
3.12. Views
3.12.1. tenant_view_get_list
Description
Get the list of properties and attributes to be displayed or not in each view of the WAT
ACLs
-
views.update.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
field |
||
visible |
||
view_type |
||
device_type |
||
qvd_object |
||
property |
||
fields <token_array> |
tenant_id |
|
field |
||
visible |
||
view_type |
||
device_type |
||
qvd_object |
||
property |
||
order_by <order_list> |
tenant_id |
|
field |
||
visible |
||
view_type |
||
device_type |
||
qvd_object |
||
property |
Examples
-
Input:
action=tenant_view_get_list
-
Output:
{
"total" : 1,
"rows" : [
{
"property" : 0,
"visible" : 1,
"field" : "creation_date",
"view_type" : "list_column",
"qvd_object" : "user",
"device_type" : "desktop",
"tenant_id" : 0
}
],
"message" : "Successful completion",
"status" : 0
}
3.12.2. tenant_property_view_set
Description
Set a property to be displayed or not in a view of the WAT for a tenant
ACLs
-
views.update.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
qvd_obj_prop_id |
|
visible |
||
view_type |
||
device_type |
Examples
-
Input:
action=tenant_property_view_set&arguments={"view_type":"list_column","device_type":"desktop","visible":true,"qvd_obj_prop_id":"10008"}
-
Output:
{
"status" : 0,
"message" : "Successful completion",
"rows" : [
{
"id" : 10000
}
],
"total" : 1
}
3.12.3. tenant_attribute_view_set
Description
Set a attribute to be displayed or not in a view of the WAT for a tenant
ACLs
-
views.update.
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
tenant_id |
|
field |
||
qvd_object |
||
visible |
||
view_type |
||
device_type |
Examples
-
Input:
action=tenant_attribute_view_set&arguments={"view_type":"list_column","device_type":"desktop","visible":true,"qvd_object":"user","field":"id","tenant_id":"0"}
-
Output:
{
"message" : "Successful completion",
"status" : 0,
"total" : 1,
"rows" : [
{
"id" : 10000
}
]
}
3.12.4. tenant_view_reset
Description
Resets the columns to be displayed in view of the WAT for a tenant to default
ACLs
-
config.wat.
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
qvd_object |
Examples
-
Input:
action=tenant_attribute_view_set&arguments={"view_type":"list_column","device_type":"desktop","visible":true,"qvd_object":"user","field":"id","tenant_id":"0"}
-
Output:
{
"rows" : [],
"status" : 0,
"message" : "Successful completion"
}
3.12.5. admin_property_view_set
Description
Set a property to be displayed or not in a view of the WAT for the current administrator
ACLs
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
qvd_obj_prop_id |
|
visible |
||
view_type |
||
device_type |
Examples
-
Input:
action=admin_property_view_set&arguments={"view_type":"list_column","device_type":"desktop","visible":true,"qvd_obj_prop_id":"10008"}
-
Output:
{
"total" : 1,
"rows" : [
{
"id" : 10000
}
],
"message" : "Successful completion",
"status" : 0
}
3.12.6. admin_attribute_view_set
Description
Set a attribute to be displayed or not in a view of the WAT for the current administrator
ACLs
Parameters
| Parameter | Token | ACL |
|---|---|---|
arguments <token_hash> |
field |
|
qvd_object |
||
visible |
||
view_type |
||
device_type |
Examples
-
Input:
action=admin_attribute_view_set&arguments={"view_type":"list_column","device_type":"desktop","visible":true,"qvd_object":"user","field":"id","tenant_id":"0"}
-
Output:
{
"message" : "Successful completion",
"status" : 0,
"total" : 1,
"rows" : [
{
"id" : 10000
}
]
}
3.12.7. admin_view_reset
Description
Resets the columns to be displayed in view of the WAT for the current administrator to default
ACLs
Parameters
| Parameter | Token | ACL |
|---|---|---|
filters <filter_list> |
tenant_id |
|
qvd_object |
Examples
-
Input:
action=admin_attribute_view_set&arguments={"view_type":"list_column","device_type":"desktop","visible":true,"qvd_object":"user","field":"id","tenant_id":"0"}
-
Output:
{
"rows" : [],
"message" : "Successful completion",
"status" : 0
}
3.13. Statístics
3.13.1. qvd_objects_statistics
Description
Returns statistics about the use of QVD
ACLs
-
.stats.
Channels
-
vm_created
-
vm_removed
-
vm_blocked_or_unblocked
-
vm_changed
-
vm_expiration_date_changed
-
host_created
-
host_deleted
-
host_blocked_or_unblocked
-
host_changed
-
user_created
-
user_deleted
-
user_blocked_or_unblocked
-
user_changed
-
osf_created
-
osf_deleted
-
osf_changed
-
di_created
-
di_removed
-
di_blocked_or_unblocked
Parameters
| Parameter | Token | ACL |
|---|
Examples
-
Input:
action=qvd_objects_statistics
-
Output:
{
"blocked_vms_count" : 0,
"blocked_users_count" : 0,
"osfs_count" : 1,
"status" : 0,
"running_vms_count" : 0,
"top_populated_hosts" : [
{
"id" : 10000,
"number_of_vms" : 0,
"name" : "localhost"
}
],
"connected_users_count" : 0,
"blocked_hosts_count" : 0,
"blocked_dis_count" : 0,
"hosts_count" : 1,
"dis_count" : 1,
"vms_count" : 1,
"running_hosts_count" : 1,
"vms_with_expiration_date" : [],
"message" : "Successful completion",
"users_count" : 1
}
3.14. Error Codes
A call to the API can return an error code if it has not been properly executed. The following table shows the error code and a message giving details of the reason for the same:
0 |
QVD_CODE_SUCCESS |
Successful completion |
1000 |
QVD_CODE_IN_PROGRESS |
In progress |
1100 |
QVD_CODE_INTERNAL_ERROR |
Internal server error |
1200 |
QVD_CODE_ACTION_INCOMPLETE |
Action not accomplished for all elements |
1300 |
QVD_CODE_ZERO_ITEMS |
Zero items selected, no item has been changed |
2100 |
QVD_CODE_DB_CONNECTION_ERROR |
No connection to database |
2210 |
QVD_CODE_STAGING_COPY_ERROR |
Unable to copy disk image from staging |
2211 |
QVD_CODE_IMAGE_COPY_ERROR |
Unable to copy whole disk image (lack of space?) |
2220 |
QVD_CODE_IMAGE_DIR_MISSING |
Unable to find images directory in filesystem |
2230 |
QVD_CODE_STAGING_DIR_MISSING |
Unable to find staging directory in filesystem |
2240 |
QVD_CODE_STAGING_FILE_MISSING |
Unable to find disk image in staging directory |
2250 |
QVD_CODE_UPLOAD_IMAGE_ERROR |
Unable to upload disk image |
2251 |
QVD_CODE_MOVE_UPLOADED_IMAGE_ERROR |
Unable to move uploaded disk image |
2260 |
QVD_CODE_DOWNLOAD_IMAGE_ERROR |
Unable to download disk image |
2261 |
QVD_CODE_MOVE_DOWNLOADED_IMAGE_ERROR |
Unable to move downloaded disk image |
2270 |
QVD_CODE_FILE_READ_ERROR |
Unable to read file from disk |
3100 |
QVD_CODE_NO_CREDENTIALS |
No credentials provided for authentication |
3200 |
QVD_CODE_WRONG_CREDENTIALS |
Wrong credentials - Login again |
3300 |
QVD_CODE_SESSION_EXPIRED |
Session expired - Login again |
3400 |
QVD_CODE_SESSION_UPDATE_ERROR |
Problems to update expiration time in session |
3500 |
QVD_CODE_TENANT_BLOCKED |
Access to tenant is restricted |
4100 |
QVD_CODE_UNAVAILABLE_ACTION |
Unavailable action |
4110 |
QVD_CODE_INVALID_ACTION |
Invalid or null action name provided |
4210 |
QVD_CODE_FORBIDDEN_ACTION |
Forbidden action for this administrator |
4220 |
QVD_CODE_FORBIDDEN_FILTER_KEY |
Forbidden filter for this administrator |
4221 |
QVD_CODE_FORBIDDEN_FILTER_VALUE |
Forbidden filter value for this administrator |
4230 |
QVD_CODE_FORBIDDEN_ARGUMENT_KEY |
Forbidden argument for this administrator |
4240 |
QVD_CODE_FORBIDDEN_MASSIVE_KEY |
Forbidden massive action for this administrator |
4250 |
QVD_CODE_FORBIDDEN_FIELD |
Forbidden field for this administrator |
4260 |
QVD_CODE_FORBIDDEN_SORT_FIELD |
Forbidden sorted by field for this administrator |
5110 |
QVD_CODE_DISCONNECT_USER_ERROR |
Unable to disconnect user in current state |
5120 |
QVD_CODE_STOP_VM_ERROR |
Unable to stop VM in current state |
5130 |
QVD_CODE_START_VM_ERROR |
Unable to start VM in current state |
5140 |
QVD_CODE_ASSIGN_HOST_ERROR |
Unable to assign host, no host available |
6100 |
QVD_CODE_SYNTAX_ERROR |
Syntax errors in input json |
6210 |
QVD_CODE_INVALID_FILTER_KEY |
Inappropiate filter for this action |
6220 |
QVD_CODE_MISSING_FILTER_KEY |
No mandatory filter for this action |
6230 |
QVD_CODE_INVALID_ARGUMENT |
Inappropiate argument for this action |
6231 |
QVD_CODE_INVALID_NESTED_QUERY |
Inappropiate argument for the nested query action |
6240 |
QVD_CODE_MISSING_ARGUMENT |
No mandatory argument for this action |
6250 |
QVD_CODE_INVALID_FIELD |
Inappropiate field for this action |
6310 |
QVD_CODE_INVALID_VALUE |
Invalid value |
6320 |
QVD_CODE_INVALID_FILTER_VALUE |
Invalid filter value |
6321 |
QVD_CODE_AMBIGUOUS_FILTER |
Unambiguous filter value needed |
6322 |
QVD_CODE_NON_UNIQUE_FILTER |
Unique filter value needed |
6330 |
QVD_CODE_INVALID_ARGUMENT_VALUE |
Invalid argument value |
6340 |
QVD_CODE_INVALID_PROPERTY |
Invalid property value |
6350 |
QVD_CODE_INVALID_TAG |
Invalid tag value |
6360 |
QVD_CODE_INVALID_ACL |
Invalid acl value |
6370 |
QVD_CODE_INVALID_ROLE |
Invalid role value |
6380 |
QVD_CODE_INVALID_CONFIG_TOKEN |
Invalid config token |
6410 |
QVD_CODE_NON_NULLABLE_FIELD |
Lack of value for a not nullable field |
6420 |
QVD_CODE_MISSING_PROPERTY_VALUE |
No property value provided |
6430 |
QVD_CODE_MISSING_TAG |
No tag provided |
6440 |
QVD_CODE_MISSING_ACL |
No acl provided |
6450 |
QVD_CODE_MISSING_ROLE |
No role provided |
6600 |
QVD_CODE_INVALID_SORT_ORDER |
Invalid order direction |
6610 |
QVD_CODE_INVALID_SORT_FIELD |
Invalid order by field |
7100 |
QVD_CODE_SELECT_MISSING_ITEM |
Refered related items don"t exist |
7110 |
QVD_CODE_UPDATE_MISSING_ITEM |
Unable to accomplish, refered related items don"t exist |
7120 |
QVD_CODE_DELETE_MISSING_ITEM |
Unable to remove, other items depend on it |
7200 |
QVD_CODE_DUPLICATED_ELEMENT |
This element already exists |
7210 |
QVD_CODE_DUPLICATED_PROPERTY |
This property already exists |
7220 |
QVD_CODE_DUPLICATED_ACL |
This acl has already been assigned |
7230 |
QVD_CODE_DUPLICATED_ROLE |
This role has already been assigned |
7310 |
QVD_CODE_DELETE_VM_ERROR |
Unable to remove VM - This VM is running |
7320 |
QVD_CODE_DELETE_DI_ERROR |
Unable to remove DI - There are VMs running with it |
7330 |
QVD_CODE_UPDATE_DI_TAG_ERROR |
Unable to reassign a Tag fixed to another DI |
7340 |
QVD_CODE_DELETE_DI_TAG_ERROR |
Fixed, Head and Default Tags cannot be deleted |
7350 |
QVD_CODE_CYCLIC_ROLE |
Forbidden role assignment, inherited role inherits from inheritor |
7360 |
QVD_CODE_INVALID_EXPIRATION_DATE |
Incompatible expiration dates - Soft date must precede the hard one |
7370 |
QVD_CODE_DELETE_CORE_CONFIG_ERROR |
Unable to remove a core config item |
7373 |
QVD_CODE_SWITCH_MONOTENANT_ERROR |
Unable to switch to monotenant mode - More than one tenant in the system |
7382 |
QVD_CODE_CREATE_CONFIG_ERROR |
Cannot create new configuration token |
7390 |
QVD_CODE_SET_DEFAULT_CONFIG_ERROR |
Configuration token value is already set to the default one |