REST API

simplestack.server.disk_create(hypervisor, host, guest_id)[source]

Create a disk for a given guest

POST /:hypervisor/:host/guests/:guest_id/disks
simplestack.server.disk_delete(hypervisor, host, guest_id, disk_id)[source]

Delete a disk from a given guest

DELETE /:hypervisor/:host/guests/:guest_id/disks/:disk_id
simplestack.server.disk_info(hypervisor, host, guest_id, disk_id)[source]

Get a disk in a given guest

GET /:hypervisor/:host/guests/:guest_id/disks/:disk_id
simplestack.server.disk_list(hypervisor, host, guest_id)[source]

Get all disks for a given guest

GET /:hypervisor/:host/guests/:guest_id/disks
simplestack.server.disk_update(hypervisor, host, guest_id, disk_id)[source]

Update a disk in a given guest

PUT /:hypervisor/:host/guests/:guest_id/disks/:disk_id
simplestack.server.guest_clone(hypervisor, host, guest_id)[source]

Clone a guest

POST /:hypervisor/:host/guests/:guest_id/clone
simplestack.server.guest_create(hypervisor, host)[source]

Create a new guest

POST /:hypervisor/:host/guests
simplestack.server.guest_delete(hypervisor, host, guest_id)[source]

Deletes guest

DELETE /:hypervisor/:host/guests/:guest_id
simplestack.server.guest_export(hypervisor, host, guest_id)[source]

Export guest file

GET /:hypervisor/:host/guests/:guest_id/export
simplestack.server.guest_import(hypervisor, host)[source]

Import a new guest

POST /:hypervisor/:host/guests
simplestack.server.guest_info(hypervisor, host, guest_id)[source]

Get guest informations

GET /:hypervisor/:host/guests/:guest_id
simplestack.server.guest_list(hypervisor, host)[source]

Get guests for a given pool

GET /:hypervisor/:host/guests
simplestack.server.guest_update(hypervisor, host, guest_id)[source]

Update guest informations

PUT /:hypervisor/:host
simplestack.server.host_info(hypervisor, host, host_id)[source]

Get host info

GET /:hypervisor/:host/hosts/:host_id
simplestack.server.host_list(hypervisor, host)[source]

Get hosts for a given pool

GET /:hypervisor/:host/hosts
simplestack.server.media_info(hypervisor, host, guest_id)[source]

Gets the mounted media device name

GET /:hypervisor/:host/guests/:guest_id/media_device
simplestack.server.media_mount(hypervisor, host, guest_id)[source]

Mounts an ISO to a CD/DVD drive

PUT /:hypervisor/:host/guests/:guest_id/media_device
simplestack.server.network_info(hypervisor, host, network)[source]

Get network info

GET /:hypervisor/:host/networks/:network
simplestack.server.network_interface_create(hypervisor, host, guest_id)[source]

Create a network interface for a given guest

POST /:hypervisor/:host/guests/:guest_id/network_interfaces

The body should contain a JSON object. The required keys should vary for each hypervisor.

Xen example: {“network”: “THE NETWORK NAME”}

simplestack.server.network_interface_delete(hypervisor, host, guest_id, interface_id)[source]

Delete a network interface from a given guest

DELETE /:hypervisor/:host/guests/:guest_id/network_interfaces/:if_id
simplestack.server.network_interface_info(hypervisor, host, guest_id, interface_id)[source]

Get a network interface in a given guest

GET /:hypervisor/:host/guests/:guest_id/network_interfaces/:interface_id
simplestack.server.network_interface_list(hypervisor, host, guest_id)[source]

Get all network interfaces for a given guest

GET /:hypervisor/:host/guests/:guest_id/network_interfaces
simplestack.server.network_interface_update(hypervisor, host, guest_id, interface_id)[source]

Update a network interface in a given guest

PUT /:hypervisor/:host/guests/:guest_id/network_interfaces/:interface_id
simplestack.server.network_list(hypervisor, host)[source]

Get networks for a given pool

GET /:hypervisor/:host/networks
simplestack.server.network_vlan_create(hypervisor, host)[source]

Create a Network with a tagged VLAN

POST /:hypervisor/:host/networks

The body should contain a JSON object. The required keys should vary for each hypervisor.

Xen example: {“name”: “VLAN2”,

“description”: “VLAN 2 storage”, “from_network”: “BOND1”, “vlan”: 2, “other_config”: {}}
simplestack.server.pool_info(hypervisor, host)[source]

Get pool information

GET /:hypervisor/:host
simplestack.server.power_guest(hypervisor, host, guest_id)[source]

Turn a guest on/off based on a given guest_id

PUT /:hypervisor/:host/guests/:guest_id/power
simplestack.server.reboot_guest(hypervisor, host, guest_id)[source]

Reboot a guest based on the given guest_id

PUT /:hypervisor/:host/guests/:guest_id/reboot
simplestack.server.snapshot_create(hypervisor, host, guest_id)[source]

Create a snapshot for a given guest

POST /:hypervisor/:host/guests/:guest_id/snapshots
simplestack.server.snapshot_delete(hypervisor, host, guest_id, snapshot_id)[source]

Remove a snapshot for a given guest_id and snapshot_id

DELETE /:hypervisor/:host/guests/:guest_id/snapshots/:snapshot_id
simplestack.server.snapshot_info(hypervisor, host, guest_id, snapshot_id)[source]

Get snapshot informations for a given guest_id and snapshot_id

GET /:hypervisor/:host/guests/:guest_id/snapshots/:snapshot_id
simplestack.server.snapshot_list(hypervisor, host, guest_id)[source]

Get all snapshots for a given guest

GET /:hypervisor/:host/guests/:guest_id/snapshots
simplestack.server.snapshot_revert(hypervisor, host, guest_id, snapshot_id)[source]

Remove a snapshot for a given guest_id and snapshot_id

PUT /:hypervisor/:host/guests/:guest_id/snapshots/:snapshot_id/revert
simplestack.server.storage_guest_import(hypervisor, host, storage_id)[source]

Import a new guest

POST /:hypervisor/:host/storages/:storage_id/guests
simplestack.server.storage_info(hypervisor, host, storage_id)[source]

Get storage info

GET /:hypervisor/:host/storages/:storage_id
simplestack.server.storage_list(hypervisor, host)[source]

Get storages for a given pool

GET /:hypervisor/:host/storages
simplestack.server.tag_create(hypervisor, host, guest_id)[source]

Create a new tag for a given guest

POST /:hypervisor/:host/guests/:guest_id/tags
simplestack.server.tag_delete(hypervisor, host, guest_id, tag_name)[source]

Delete a given tag for a given guest

DELETE /:hypervisor/:host/guests/:guest_id/tags
simplestack.server.tag_list(hypervisor, host, guest_id)[source]

Get all tags for a given guest

GET /:hypervisor/:host/guests/:guest_id/tags

This Page