Getting basic information from every Guest

Format

Method	GET
URL	/guests
Request contents	Empty
Successful answer	BasicGuestInfo Object Array
Non-successful answer	ErrorMessage Object
Unexpected error	HTTP 500

BasicGuestInfo Object

Schema

guest_id	String	Guest's unique identifier
guest_type	String	Guest type. One of "normal", "template" or "clone"
pool_id	String	Pool's unique identifier, to where this Guest has been assigned.
desired_state	String	Guest's desired state. Either "running", "running_once", "stopped", "paused" or "suspended"
current_state	String	Guest's current state. Either "unknown", "running", "stopped", "paused", "suspended" or "migrating"
current_host	String	Host's unique identifier, where this Guest is currently running. Only is guaranteed to hace a value for flexVDI_Manager.

JSON example

{
    "desired_state": "running",
    "current_state": "running",
    "current_host": "",
    "guest_type": "clone",
    "guest_id": "opensuse421_public-volatile-e30ca1bb",
    "pool_id": "demo_public"
}

flexVDI Documentation 3.0

Getting basic information from every Guest

Analytics

Format

BasicGuestInfo Object

Schema

JSON example

Related content