Abiquo Documentation Cookies Policy

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


Abiquo 2.3


Skip to end of metadata
Go to start of metadata

RemoteServicesResource

Exposed Resources Hierarchy
RemoteServicesResource

Contents:

The Remote Service resource offers the functionality of managing the remote services of a
datacenter in a logical way.

Main URI of the Resource

This class operates mainly over the Resource URI: /admin/datacenters/{datacenter}/remoteservices

Exposed Methods.

Retrive a list of Remote Services

Synopsis: GET http://example.com/api/admin/datacenters/{datacenter}/remoteservices
Roles Needed: ROLE_PHYS_DC_ENUMERATE
Request Headers: Accept:application/vnd.abiquo.remoteservices+xml; version=2.2;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

Retrive a list of Remote Services example
$ curl -X GET http://10.60.21.181:80/api/admin/datacenters/1/remoteservices\
	 -H 'Accept: application/vnd.abiquo.remoteservices+xml;version=2.2'	\
	 -u user:password --verbose


GET http://10.60.21.181:80/api/admin/datacenters/1/remoteservices HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.remoteservices+xml;version=2.2


HTTP/1.1 200 OK
Date: Mon, 23 Jul 2012 14:08:24 GMT
Set-Cookie: JSESSIONID=385D842C36CF91EADF91374A3DD403B7; Path=/api
Set-Cookie: auth=YWRtaW46MTM0MzA1NDMwNDk5MTpmNzIzM2MwZTU5MTIwMDQwYzcyZDM1YjAzYzYwNGRjMTpBQklRVU8; Expires=Mon, 23-Jul-2012 14:38:24 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.remoteservices+xml;version=2.2
Content-Length: 3616

<?xml version="1.0" encoding="UTF-8"?>
<remoteServices>
  <remoteService>
    <link href="http://10.60.21.181:80/api/admin/datacenters/1"
      rel="datacenter" type="application/vnd.abiquo.datacenter+xml"/>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/dhcpservice"
      rel="edit" type="application/vnd.abiquo.remoteservice+xml"/>
    <id>2</id>
    <status>1</status>
    <type>DHCP_SERVICE</type>
    <uri>omapi://10.60.21.181:7911/dhcp</uri>
  </remoteService>
  <remoteService>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/storagesystemmonitor/action/check" rel="check"/>
    <link href="http://10.60.21.181:80/api/admin/datacenters/1"
      rel="datacenter" type="application/vnd.abiquo.datacenter+xml"/>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/storagesystemmonitor"
      rel="edit" type="application/vnd.abiquo.remoteservice+xml"/>
    <id>3</id>
    <status>1</status>
    <type>STORAGE_SYSTEM_MONITOR</type>
    <uri>http://10.60.21.181:80/ssm</uri>
  </remoteService>
  <remoteService>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/appliancemanager/action/check" rel="check"/>
    <link href="http://10.60.21.181:80/api/admin/datacenters/1"
      rel="datacenter" type="application/vnd.abiquo.datacenter+xml"/>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/appliancemanager"
      rel="edit" type="application/vnd.abiquo.remoteservice+xml"/>
    <id>4</id>
    <status>1</status>
    <type>APPLIANCE_MANAGER</type>
    <uri>http://10.60.21.181:80/am</uri>
  </remoteService>
  <remoteService>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/virtualsystemmonitor/action/check" rel="check"/>
    <link href="http://10.60.21.181:80/api/admin/datacenters/1"
      rel="datacenter" type="application/vnd.abiquo.datacenter+xml"/>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/virtualsystemmonitor"
      rel="edit" type="application/vnd.abiquo.remoteservice+xml"/>
    <id>5</id>
    <status>1</status>
    <type>VIRTUAL_SYSTEM_MONITOR</type>
    <uri>http://10.60.21.181:80/vsm</uri>
  </remoteService>
  <remoteService>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/nodecollector/action/check" rel="check"/>
    <link href="http://10.60.21.181:80/api/admin/datacenters/1"
      rel="datacenter" type="application/vnd.abiquo.datacenter+xml"/>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/nodecollector"
      rel="edit" type="application/vnd.abiquo.remoteservice+xml"/>
    <id>6</id>
    <status>1</status>
    <type>NODE_COLLECTOR</type>
    <uri>http://10.60.21.181:80/nodecollector</uri>
  </remoteService>
  <remoteService>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/virtualfactory/action/check" rel="check"/>
    <link href="http://10.60.21.181:80/api/admin/datacenters/1"
      rel="datacenter" type="application/vnd.abiquo.datacenter+xml"/>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/virtualfactory"
      rel="edit" type="application/vnd.abiquo.remoteservice+xml"/>
    <id>7</id>
    <status>1</status>
    <type>VIRTUAL_FACTORY</type>
    <uri>http://10.60.21.181:80/virtualfactory</uri>
  </remoteService>
  <remoteService>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/bpmservice/action/check" rel="check"/>
    <link href="http://10.60.21.181:80/api/admin/datacenters/1"
      rel="datacenter" type="application/vnd.abiquo.datacenter+xml"/>
    <link
      href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/bpmservice"
      rel="edit" type="application/vnd.abiquo.remoteservice+xml"/>
    <id>8</id>
    <status>1</status>
    <type>BPM_SERVICE</type>
    <uri>http://10.60.21.181:80/bpm-async</uri>
  </remoteService>
</remoteServices>


Create a Remote Service

Create a remote service to be used in a datacenter. Is important to know that the uri field
cannot be null and must follow the pattern <protocol><host>:<port>/<context>.

Synopsis: POST http://example.com/api/admin/datacenters/{datacenter}/remoteservices
Roles Needed: ROLE_PHYS_DC_MANAGE
Request Headers: Accept:application/vnd.abiquo.remoteservice+xml; version=2.2;Content-type:application/vnd.abiquo.remoteservice+xml; version=2.2;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

Create a Remote Service example
$ curl -X POST http://10.60.21.181:80/api/admin/datacenters/1/remoteservices\
	 -H 'Accept: application/vnd.abiquo.remoteservice+xml;version=2.2'	\
	 -H 'Content-Type: application/vnd.abiquo.remoteservice+xml;version=2.2'	\
	 -d @entity.xml	\
	 -u user:password --verbose


POST http://10.60.21.181:80/api/admin/datacenters/1/remoteservices HTTP/1.1
Authorization: Basic YWRtaW46eGFiaXF1bw==
Accept: application/vnd.abiquo.remoteservice+xml;version=2.2
Content-Type: application/vnd.abiquo.remoteservice+xml;version=2.2
Content-Length: 196


HTTP/1.1 201 Created
Date: Mon, 23 Jul 2012 14:08:24 GMT
Location: http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/nodecollector
Set-Cookie: JSESSIONID=C6EDA87F309F999AF6B95060E40B64BF; Path=/api
Set-Cookie: auth=YWRtaW46MTM0MzA1NDMwNTIyNTo5MzgyMGJkZDkyMWRhZmM4NmRjOGZkYzk3ZWYwYzMxMjpBQklRVU8; Expires=Mon, 23-Jul-2012 14:38:25 GMT; Path=/api
Server: Apache-Coyote/1.1
Content-Type: application/vnd.abiquo.remoteservice+xml;version=2.2
Content-Length: 575

<?xml version="1.0" encoding="UTF-8"?>
<remoteService>
  <link href="http://10.60.21.181:80/api/admin/datacenters/1"
    rel="datacenter" type="application/vnd.abiquo.datacenter+xml"/>
  <link
    href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/nodecollector/action/check" rel="check"/>
  <link
    href="http://10.60.21.181:80/api/admin/datacenters/1/remoteservices/nodecollector"
    rel="edit" type="application/vnd.abiquo.remoteservice+xml"/>
  <id>9</id>
  <status>1</status>
  <type>NODE_COLLECTOR</type>
  <uri>http://10.60.21.181:80/nodecollector</uri>
</remoteService>


Download a template

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

------------------------------------------------------------------------------------------------------------------------------

RemoteServiceResource

Exposed Resources Hierarchy
RemoteServiceResource

Contents:

Main URI of the Resource

This class operates mainly over the Resource URI: /admin/datacenters/{datacenter}/remoteservices/{remoteservice}

Exposed Methods.

Retrieve a Remote Service

Synopsis: GET http://example.com/api/admin/datacenters/{datacenter}/remoteservices/{remoteservice}
Roles Needed: ROLE_PHYS_DC_ENUMERATE
Request Headers: Accept:application/vnd.abiquo.remoteservice+xml; version=2.2;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

Retrieve a Remote Service example
TODO

Check the status of a Remote Service

Returns the status of a remoter service in a HTTP response code

Synopsis: GET http://example.com/api/admin/datacenters/{datacenter}/remoteservices/{remoteservice}/action/check
Roles Needed: ROLE_PHYS_DC_MANAGE
Request Headers:
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

Check the status of a Remote Service example
TODO

Update an existing Remote Service

Synopsis: PUT http://example.com/api/admin/datacenters/{datacenter}/remoteservices/{remoteservice}
Roles Needed: ROLE_PHYS_DC_MANAGE
Request Headers: Accept:application/vnd.abiquo.remoteservice+xml; version=2.2;Content-type:application/vnd.abiquo.remoteservice+xml; version=2.2;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

Update an existing Remote Service example
TODO

Download a template

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

Delete a Remote Service

Synopsis: DELETE http://example.com/api/admin/datacenters/{datacenter}/remoteservices/{remoteservice}
Roles Needed: ROLE_PHYS_DC_MANAGE
Request Headers:
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

Delete a Remote Service example
TODO

------------------------------------------------------------------------------------------------------------------------------

  • No labels