Abiquo 2.6


Skip to end of metadata
Go to start of metadata

System property resource

The System Property resource provides access to Abiquo internal configuration parameters. This page describes the methods exposed to view and manage the System Properties.

Main URI of the Resource

This class operates mainly over the Resource URI: /config/properties

Exposed Methods

Retrieve all system properties

Returns all Abiquo system properties. Use the name query parameter to obtain only a single property in the list. Use the component query parameter to obtain a list of properties of this component.

Synopsis: GET http://example.com/api/config/properties
Roles Required: ROLE_AUTHENTICATED,ROLE_SYSCONFIG_VIEW
Request Headers: Accept: application/vnd.abiquo.systemproperties+xml; version=2.4; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

name

false

 

name of the property

component

false

 

component of the property

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: SystemProperties Media Type
Request Example:

 Click here to show or hide the request example
Retrieve all system properties example
$ curl -X GET http://10.60.20.60/api/config/properties?name=client.dashboard.showStartUpAlert\
	 -H 'Accept: application/vnd.abiquo.systemproperties+xml; version=2.4'	\
	 -u user:password --verbose


GET http://10.60.20.60/api/config/properties?name=client.dashboard.showStartUpAlert HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.systemproperties+xml;version=2.4


HTTP/1.1 200 OK
Date: Wed, 16 Jan 2013 14:10:28 GMT
Set-Cookie: JSESSIONID=B93EDE633D073D7E67444521B02E7AB7; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0NzIyOTc2MzozYTQ3MjMxZTg3MDU3Y2Y1ODVhYTJiOTNmYjI3OGM3NjpBQklRVU8; Expires=Wed, 16-Jan-2013 14:40:29 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.systemproperties+xml;version=2.4
Content-Length: 391

<?xml version="1.0" encoding="UTF-8"?>
<properties>
  <property>
    <link href="http://10.60.20.60:80/api/config/properties/5"
      rel="edit" type="application/vnd.abiquo.systemproperty+xml"/>
    <id>5</id>
    <name>client.dashboard.showStartUpAlert</name>
    <value>0</value>
    <description>Set to 1 to show an Alert with the text found in
      Startup_Alert.txt file</description>
  </property>
</properties>


Create a system property

Create a system property.

Synopsis: POST http://example.com/api/config/properties
Roles Required: ROLE_SYSCONFIG_ALLOW_MODIFY
Request Headers: Accept: application/vnd.abiquo.systemproperty+xml; version=2.4; Content-type: application/vnd.abiquo.systemproperty+xml; version=2.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: SystemProperty Media Type
Response Message Body Entity: SystemProperty Media Type
Request Example:

 Click here to show or hide the request example
Create a system property example
curl -X POST http://example.com/api/config/properties  \
        -H 'Content-type: application/vnd.abiquo.systemproperty+xml;version=2.4' \
        -H 'Accept: application/vnd.abiquo.systemproperty+xml;version=2.4' \
        -d'<property><description/><name>newproperty</name><value>extra</value></property>'
        -u user:pass --verbose 
 
POST /api/config/properties HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18
Content-type: application/vnd.abiquo.systemproperty+xml;version=2.4
Accept: application/vnd.abiquo.systemproperty+xml;version=2.4
Content-Length: 79
 
 
HTTP/1.1 201 Creado
Server: Apache-Coyote/1.1
Set-Cookie: auth=YWRtaW46MTM0NDMzMjg3NjQxNTplYjRmZGMxZjNhYzdiNjQ3NjZhYzM5NmU1Yjc4OTM5NzpBQklRVU8; Expires=Tue, 07-Aug-2012 09:47:56 GMT; Path=/api
Location: http://example.com:80/api/config/properties/87
Set-Cookie: JSESSIONID=87DA55306D1B20EFE15D13CF4197AB78; Path=/api
Content-Type: application/vnd.abiquo.systemproperty+xml;version=2.4
Content-Length: 277
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<property>
    <link rel="edit" type="application/vnd.abiquo.systemproperty+xml" href="http://example.com/api/config/properties/87"/>
    <description></description>
    <id>87</id>
    <name>newproperty</name>
    <value>extra</value>
</property>



Download a template

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

Modify multiple system properties

Modify multiple system properties.

Synopsis: PUT http://example.com/api/config/properties
Roles Required: ROLE_SYSCONFIG_ALLOW_MODIFY
Request Headers: Accept: application/vnd.abiquo.systemproperties+xml; version=2.4; Content-type: application/vnd.abiquo.systemproperties+xml; version=2.4;
Request Parameters:

Parameter

Required

Default Value

Description

component

false

 

component name

 

 

 

 

Request Message Body Entity: SystemProperties Media Type
Response Message Body Entity: SystemProperties Media Type
Request Example:

 Click here to show or hide the request example
Modify multiple system properties example
curl -X PUT http://example.com/api/config/properties  \
        -H 'Content-type: application/vnd.abiquo.systemproperties+xml;version=2.4' \
        -H 'Accept: application/vnd.abiquo.systemproperties+xml;version=2.4' \
        -d'<properties><property><description/><id>87</id><name>newName</name><value>newValue</value></property><property><description/><id>1</id><name>client.applibrary.ovfpackagesDownloadingProgressUpdateInterval</name><value>11</value></property></properties>' \
        -u user:pass --verbose
 
PUT /api/config/properties HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18
Content-type: application/vnd.abiquo.systemproperties+xml;version=2.4
Accept: application/vnd.abiquo.systemproperties+xml;version=2.4
Content-Length: 251
  
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: auth=YWRtaW46MTM0NDMzNDA0MDA2MjoxMmI5MDcxM2QyM2Y2MjU2MzEzOGQwODkzYjk4OGViZDpBQklRVU8; Expires=Tue, 07-Aug-2012 10:07:20 GMT; Path=/api
Set-Cookie: JSESSIONID=CD55F8870BA754B17AC6A77E84EC0251; Path=/api
Content-Type: application/vnd.abiquo.systemproperties+xml;version=2.4
Content-Length: 571
Date: Tue, 07 Aug 2012 09:37:20 GMT
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<properties>
    <property>
        <link rel="edit" type="application/vnd.abiquo.systemproperty+xml" href="http://example.com/api/config/properties/90"/>
        <description></description>
        <id>90</id>
        <name>newName</name>
        <value>newValue</value>
    </property>
    <property>
        <link rel="edit" type="application/vnd.abiquo.systemproperty+xml" href="http://example.com/api/config/properties/91"/>
        <description></description>
        <id>91</id>
        <name>client.applibrary.ovfpackagesDownloadingProgressUpdateInterval</name>
        <value>11</value>
    </property>
</properties>


Download a template

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

Retrieve a system property

Returns a system property given its identifier.

Synopsis: GET http://example.com/api/config/properties/{property}
Roles Required: ROLE_SYSCONFIG_VIEW
Request Headers: Accept: application/vnd.abiquo.systemproperty+xml; version=2.4; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: SystemProperty Media Type
Request Example:

 Click here to show or hide the request example
Retrieve a system property example
curl -X GET http://example.com/api/config/properties/1 \
     -H 'Accept: application/vnd.abiquo.systemproperties+xml;version=2.4'   \
     -u user:pass --verbose
 
GET /api/config/properties/1 HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18
Accept: application/vnd.abiquo.systemproperty+xml;version=2.4
 
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: auth=YWRtaW46MTM0NDMzMjAwOTc4MTo1ODRjYjZiMTQ0NGY5NjA5OTE2MDAyZjZiMjc3MzNlNTpBQklRVU8; Expires=Tue, 07-Aug-2012 09:33:29 GMT; Path=/api
Set-Cookie: JSESSIONID=40582D6D2EBAC65D3864842D54562417; Path=/api
Content-Type: application/vnd.abiquo.systemproperty+xml;version=2.4
Content-Length: 347
Date: Tue, 07 Aug 2012 09:03:29 GMT
 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<property>
    <link rel="edit" type="application/vnd.abiquo.systemproperty+xml" href="http://example.com/api/config/properties/1"/>
    <description>Time interval in seconds</description>
    <id>1</id>
    <name>client.applibrary.ovfpackagesDownloadingProgressUpdateInterval</name>
    <value>10</value>
</property>



Modify a system property

Modify a system property.

Synopsis: PUT http://example.com/api/config/properties/{property}
Roles Required: ROLE_SYSCONFIG_ALLOW_MODIFY
Request Headers: Accept: application/vnd.abiquo.systemproperty+xml; version=2.4; Content-type: application/vnd.abiquo.systemproperty+xml; version=2.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: SystemProperty Media Type
Response Message Body Entity: SystemProperty Media Type
Request Example:

 Click here to show or hide the request example
Modify a system property example
$ curl -X PUT http://10.60.20.60:80/api/config/properties/5\
	 -H 'Accept: application/vnd.abiquo.systemproperty+xml; version=2.4'	\
	 -H 'Content-Type: application/vnd.abiquo.systemproperty+xml; version=2.4'	\
	 -d @entity.xml	\
	 -u user:password --verbose


PUT http://10.60.20.60:80/api/config/properties/5 HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.systemproperty+xml;version=2.4
Content-Type: application/vnd.abiquo.systemproperty+xml;version=2.4
Content-Length: 394


HTTP/1.1 200 OK
Date: Wed, 16 Jan 2013 14:10:28 GMT
Set-Cookie: JSESSIONID=EE91342FA60C2ADE3D7A88BBCF483B64; Path=/api
Set-Cookie: auth=YWRtaW46MTM1ODM0NzIyOTc4MzpkMWFjNDNkMTRmY2MyZWVhMjlhYWE3OWVkNTZjYjZjMTpBQklRVU8; Expires=Wed, 16-Jan-2013 14:40:29 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.systemproperty+xml;version=2.4
Content-Length: 366

<?xml version="1.0" encoding="UTF-8"?>
<property>
  <link href="http://10.60.20.60:80/api/config/properties/5" rel="edit" type="application/vnd.abiquo.systemproperty+xml"/>
  <id>5</id>
  <name>client.dashboard.showStartUpAlert</name>
  <value>1</value>
  <description>Set to 1 to show an Alert with the text found in
    Startup_Alert.txt file</description>
</property>


Download a template

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

Remove a system property

Delete a system property.

Synopsis: DELETE http://example.com/api/config/properties/{property}
Roles Required: ROLE_SYSCONFIG_ALLOW_MODIFY
Request Headers: Accept: ; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity:
Request Example:

 Click here to show or hide the request example
Remove a system property example
curl -X DELETE http://example.com/api/config/properties/90  \
        -u user:pass --verbose 
 
DELETE /api/config/properties/90 HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18
Accept: */*
 
HTTP/1.1 204 Sin Contenido
Server: Apache-Coyote/1.1
Set-Cookie: auth=YWRtaW46MTM0NDMzNDIxNjA1MzowMzNlMzI2NGI4ODZmYThkNzNlYTY4Y2E1YzE2ODcxZjpBQklRVU8; Expires=Tue, 07-Aug-2012 10:10:16 GMT; Path=/api
Set-Cookie: JSESSIONID=F49AC4F7F78DE71D73FD5E395A5A5D5D; Path=/api
Date: Tue, 07 Aug 2012 09:40:16 GMT