 | Enterprise Edition Functionality This feature is available in Abiquo Enterprise Edition |
| Cloud Admin | Enterprise Admin | User |
|---|---|---|
 |
 |
|
Contents:
Node Collector remote service provides physical infrastructure discovering functionallity. This resource can be used to discover the physical capabilities of a target host, and use the information retrieved to create Machine Resources. It can be used also to query the status of a target host, and to get a list of all the virtual systems that are running on that host.
As this resource is a specialization of the Remote Service Resource, this document will only cover the specific actions of the Node Collector remote service.
Actions related to the Node Collector remote service
Retrieve the Node Collector service
Synopsis: GET http://example.com/api/admin/datacenters/{$datacenterId}/remoteServices/{$type}
Request Headers: Accept, Content-Type.
Request Parameters: N/A.
Request Message Body: N/A.
Example Request: Retrieve the Node Collector RemoteService
Response Headers: Content-Length, Content-Type.
Response Message Body: RemoteService
Response Status: 200, 401, 403.
Example Response: Response of the GET over a RemoteService
Get the Hypervisor type of a target host
Synopsis: POST http://example.com/api/datacenters/{$datacenterId}/remoteServices/{$type}/actions/hypervisor
Request Headers: Accept, Content-Type.
Request Parameters:
| Field Name | Type | Occurs | Required | Description |
|---|---|---|---|---|
| ip | String | 1 | true | IP of the target host to check |
Request Message Body: N/A
Example Request: Get the the Hypervisor type of a target host that has the IP: 10.60.1.77
Response Headers: Content-Length, Content-Type, Location.
Response Message Body: N/A.
Response Status: 201, 400, 401, 403, 404
Example Response: Response of the deletion
Get physical machine information of a target host
Synopsis: POST http://example.com/api/datacenters/{$datacenterId}/remoteServices/{$type}/actions/host
Request Headers: Accept, Content-Type.
Request Parameters:
| Field Name | Type | Occurs | Required | Description |
|---|---|---|---|---|
| ip | String | 1 | true | IP of the target host to check |
| hypervisor | String | 1 | true | The hypervisor type as returned by the previous API call (valid values: esxi, vbox, hyperv, kvm, xen, xenserver) |
| user | String | 1 | true | The username used to log in to the hypervisor |
| password | String | 1 | true | The password used to log in to the hypervisor |
| aimport | Integer | 1 | Only for KVM and XEN | The AIM port where the hypervisor listens |
| repository | String | 1 | false | The location of the Appliance Library Repository |
Request Message Body: N/A
Example Request: Get the physical machine information of a target host that has the IP: 10.60.1.77
Response Headers: Content-Length, Content-Type, Location.
Response Message Body: N/A.
Response Status: 201, 400, 401, 403, 404
Example Response: Response of the deletion
Get the list of the virtual systems of a target host
Synopsis: POST http://example.com/api/datacenters/{$datacenterId}/remoteServices/{$type}/actions/virtualSystems
Request Headers: Accept, Content-Type.
Request Parameters:
| Field Name | Type | Occurs | Required | Description |
|---|---|---|---|---|
| ip | String | 1 | true | IP of the target host to check |
| hypervisor | String | 1 | true | The hypervisor type as returned by the previous API call (valid values: esxi, vbox, hyperv, kvm, xen, xenserver)) |
| user | String | 1 | true | The username used to log in to the hypervisor |
| password | String | 1 | true | The password used to log in to the hypervisor |
| aimport | Integer | 1 | Only for KVM and XEN | The AIM port where the hypervisor listens |
Request Message Body: N/A
Example Request: Get the list of the virtual systems of a target host that has the IP: 10.60.1.77
Response Headers: Content-Length, Content-Type, Location.
Response Message Body: N/A.
Response Status: 201, 400, 401, 403, 404
Example Response: Response of the deletion
