VMWare Servers
VMMware specific notes
The VMWare server integration in the CloudSigma API is still in a BETA stage. Only partial functionality is exposed and the API definition and functionality are subject to changes.
Allowed HTTP methods
Method |
Description |
---|---|
GET |
get / list object/s |
Note
See RFC 2616#section-9 for more details on HTTP methods semantics
Listing
- GET /vmware_servers/
Gets the list of servers to which the authenticated user has access.
- Status Codes:
200 OK – no error
Example request:
GET /api/2.0/vmware_servers/?limit=0 HTTP/1.1 Content-Type: application/json Authorization: Basic SWYgeW91IGZvdW5kIHRoaXMsIGhhdmUgYSBjb29raWUsIHlvdSBkZXNlcnZlIGl0IDop
- Language:
http
Example response:
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 { "meta": { "limit": 0, "offset": 0, "total_count": 1 }, "objects": [ { "cores_per_socket": 4, "cpus": 4, "deployed": true, "description": "Test description", "disk": [ { 'diskElementName': 'Hard disk 1', 'diskVirtualQuantityInBytes': 17179869184 }], "enabled": true, "media": [ { 'mediaCdElementName': 'CD/DVD Drive 1', 'mediaCdHostResource': 'test.iso' }], "memory": 4096, "name": "testVLAN10", "nics": [ { "adapter_type": "VMXNET3", "connected": "true", "index": "0", "ip_address": "127.0.0.1", "ip_address_mode": "MANUAL", "mac_address": "00:50:56:01:00:12", "network": "VLAN0 Network", "primary": "True" }, { "adapter_type": "VMXNET3", "connected": "true", "index": "1", "ip_address": "10.10.11.1", "ip_address_mode": "MANUAL", "mac_address": "00:50:56:01:00:14", "network": "VLAN57 - Private to cloud", "primary": "True" }], "organisation": "5ce13c06-a1a4-4bf8-8ab0-64d23f455dda", "powered": true, "resource_uri": "/api/2.0/vmware_servers/d1f1bd39-124c-45c0-952c-2844a22f842e/", "uuid": "d1f1bd39-124c-45c0-952c-2844a22f842e" }] }
- Language:
javascript
Schema
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"allowed_detail_http_methods": [
"get"
],
"allowed_list_http_methods": [
"get"
],
"default_format": "application/json",
"default_limit": 20,
"fields": {
"name": {
"default": null,
"help_text": "Name of the VMWare server",
"readonly": false,
"required": false,
"type": "string"
},
"powered": {
"default": false,
"help_text": "Indicates if the server is powered on",
"readonly": false,
"required": true,
"type": "boolean"
},
"deployed": {
"default": false,
"help_text": "Indicates if the server has been deployed",
"readonly": false,
"required": true,
"type": "boolean"
},
"description": {
"default": null,
"help_text": "Description of the server",
"readonly": false,
"required": true,
"type": "string"
},
"cpus": {
"default": null,
"help_text": "The number of CPUs assigned to the server",
"readonly": false,
"required": true,
"type": "integer"
},
"cores_per_socket": {
"default": null,
"help_text": "The number of cores per CPU socket",
"readonly": false,
"required": true,
"type": "integer"
},
"memory": {
"default": null,
"help_text": "The amount of memory in MB",
"readonly": false,
"required": true,
"type": "integer"
},
"enabled": {
"default": false,
"help_text": "Indicates if the server has been enabled",
"readonly": false,
"required": true,
"type": "boolean"
},
"organisation": {
"default": null,
"help_text": "UUID of the server's parent organisation",
"readonly": false,
"required": true,
"type": "string"
},
"nics": {
"default": null,
"fields": {
"index": {
"default": null,
"help_text": "Index of network adapter",
"readonly": false,
"required": false,
"type": "string"
},
"connected": {
"default": null,
"help_text": "Indicator if the network adapter is connected",
"readonly": false,
"required": false,
"type": "string"
},
"primary": {
"default": null,
"help_text": "Indicator if the network adapter is primary",
"readonly": false,
"required": false,
"type": "string"
},
"network": {
"default": null,
"help_text": "Name of the network used",
"readonly": false,
"required": false,
"type": "string"
},
"ip_address_mode": {
"default": null,
"help_text": "Mode of the IP address configuration",
"readonly": false,
"required": false,
"type": "string"
},
"ip_address": {
"default": null,
"help_text": "IP address of the network adapter",
"readonly": false,
"required": false,
"type": "string"
},
"mac_address": {
"default": null,
"help_text": "MAC address of the network adapter",
"readonly": false,
"required": false,
"type": "string"
},
"disk": [{
"fields": {
"diskElementName": {
"help_text": "Name of the hard disk",
"readonly": true,
"type": "string"
},
"diskVirtualQuantityInBytes": {
"help_text": "Size of disk in bytes",
"readonly": true,
"type": "string"
}
}
}],
"media": [{
"fields": {
"mediaCdElementName": {
"help_text": "Name of attached media",
"readonly": true,
"type": "string"
},
"mediaCdHostResource": {
"help_text": "Filename of source used to create the virtual media",
"readonly": true,
"type": "string"
}
}
}]
}
}
}
}