Format

Method	GET
URL	/vdi/desktoppolicies/$DESKTOP_POLICY_ID
Request contents	Empty
Successful answer	DesktopPolicyInfo Object
Non-successful answer	ErrorMessage Object
Unexpected error	HTTP 500

DesktopPolicyInfo Object

Schema

desktop_policy_id	String	DesktopPolicy's unique identifier
pool_id	String	Unique identifier of the Pool where Guests for this DesktopPolicy are going to be created
template_id	String	Unique identifier of the Guest being used as Template
desktop_protocol	String	Legacy. Leave as "vdi"
disable_legacy_sso	String	Flag which indicates if legacy credential injection (using a floppy disk) should be disabled. Either "true" or "false"
sysprep_name	String	Name of sysprep's response file. Optional, can be empty
windows_domain	String	Windows Domain to be injected in sysprep's response file and Single-Sign On credentials
image_storage_id	String	Unique identifier of the ImageStorage which contains volume_id Volume
volume_id	String	Unique identifier of the Volume to be used as storage for differential images
precreation_guest_number	Integer	Number of precreated Guests
precreation_disable_at	Integer	Number of Guests that, when reached, disables Guest precreation
enable_usb_redir	String	Flag which indicates if desktops will be created with USB redirection. Either "true" or "false"
enable_copy_paste_h2g	String	Flag which indicates if desktops will be created with Copy&Paste from Host to Guest permission. Either "true" or "false"
enable_copy_paste_g2h	String	Flag which indicates if desktops will be created with Copy&Paste from Guest to Host permission. Either "true" or "false"
enable_power_actions	String	Flag which indicates if desktops will be created with permission to be rebooted, shutdown or reset by the user. Either "true" or "false"
enable_printing	String	Flag which indicates if desktops will be created with permission to use FollowMe printing. Either "true" or "false"
enable_audio_playback	String	Flag which indicates if desktops will be created with permission to play audio. Either "true" or "false"
enable_audio_record	String	Flag which indicates if desktops will be created with permission to record audio. Either "true" or "false"
enable_video_streaming	String	Flag which indicates if desktops will be created with permission to stream video. Either "true" or "false"
enable_multiple_clients	String	Flag which indicates if desktops will be created with permission to be simultaneously accessed from multiple clients. Either "true" or "false"
inactivity_timeout	Integer	Time in seconds, for automatic user disconnection
first_operation_what	String	Operation to be executed after first_operation_when minutes from last user disconnection. Either "none", "stop", "shutdown", "pause", "suspend" or "destroy"
first_operation_when	Integer	Time (minutes) from last user disconnection, when operation first_operation_what will be executed
second_operation_what	String	Operation to be executed after second_operation_when minutes from last user disconnection. Either "none", "stop", "shutdown", "pause", "suspend" or "destroy"
second_operation_when	Integer	Time (minutes) from last user disconnection, when operation second_operation_what will be executed
third_operation_what	String	Operation to be executed after third_operation_when minutes from last user disconnection. Either "none", "stop", "shutdown", "pause", "suspend" or "destroy"
third_operation_when	Integer	Time (minutes) from last user disconnection, when operation third_operation_what will be executed
copy_uuid	String	Legacy. Leave as "false"
rdp_server_ip	String	Legacy. Leave as "empty"
sessions	SessionInfo Array	List of Sessions registered on this DesktopPolicy

JSON example

{
    "desktop_protocol": "vdi",
    "precreation_disable_at": 6,
    "first_operation_when": 10,
    "volume_id": "samsung_ssd",
    "third_operation_what": "none",
    "sessions": [{
        "username": "precreated-47bdcb09",
        "guest_id": "windows7_020216-volatile-47bdcb09",
        "last_exit": "2016-02-05 06:13:39",
        "guest_state": "running",
        "last_access": "2016-02-05 06:13:39"
    }, {
        "username": "precreated-d8416432",
        "guest_id": "windows7_020216-volatile-d8416432",
        "last_exit": "2016-02-03 22:06:37",
        "guest_state": "running",
        "last_access": "2016-02-03 22:06:37"
    }, {
        "username": "precreated-687d354a",
        "guest_id": "windows7_020216-volatile-687d354a",
        "last_exit": "2016-02-03 14:23:37",
        "guest_state": "running",
        "last_access": "2016-02-03 14:23:37"
    }],
    "second_operation_what": "destroy",
    "disable_legacy_sso": "false",
    "image_storage_id": "internal",
    "sysprep_name": "legacy",
    "desktop_policy_id": "windows7_public",
    "copy_uuid": "false",
    "second_operation_when": 11,
    "windows_domain": "",
    "rdp_server_ip": "",
    "precreation_guest_number": 3,
    "third_operation_when": 0,
    "first_operation_what": "stop",
    "pool_id": "demo_public",
    "template_id": "windows7_020216",
    "enable_usb_redir":"false",
    "enable_copy_paste_h2g":"false",
    "enable_copy_paste_g2h":"false",
    "enable_power_actions":"false",
    "enable_printing":"false",
    "enable_audio_playback":"false",
    "enable_audio_record":"false",
    "enable_video_streaming":"false",
    "enable_multiple_clients":"false",
    "inactivity_timeout": 0
}

SessionInfo Object

Schema

username	String	Identifier of user connected to this Session. Can be an special construction, like precreated-$RANDID for precreated desktops, or guest-$TERMINAL_ID for Kiosk sessions
guest_id	String	Unique identifier of Guest assigned to this Session
guest_state	String	Current status for Guest indicated in guest_id. Either "unknown", "running", "stopped", "paused" or "suspended"
last_access	String	Date of last connection to this Session
last_exit	String	Date of last disconnection from this Session. Can be "connected", if user is still connected to the Session

JSON example

{
    "username": "precreated-687d354a",
    "guest_id": "windows7_020216-volatile-687d354a",
    "last_exit": "2016-02-03 14:23:37",
    "guest_state": "running",
    "last_access": "2016-02-03 14:23:37"
}