Getting full information from a certain TerminalPolicy
Format
Method | GET |
---|---|
URL | /vdi/terminalpolicies/$TERMINAL_POLICY_ID |
Request contents | Empty |
Successful answer | TerminalPolicyInfo Object |
Non-successful answer | ErrorMessage Object |
Unexpected answer | HTTP 500 |
TerminalPolicyInfo Object
Schema
terminal_policy_id | String | TerminalPolicy's unique identifier |
---|---|---|
state | String | TerminalPolicy's current status. Either "active" or "inactive" |
desktop_proto | String | Authentication mode. Either "vdi" or "kiosk_spice" |
auth_mode | String | Legacy |
rdp_server_ip | String | Legacy |
ad_server_ip | String | LDAP/AD server's IP address |
ad_server_port | String | LDAP/AD server's port |
ad_proxy_user | String | LDAP/AD proxy user (a user with search permissions on the directory) |
ad_proxy_pass | String | LDAP/AD proxy password |
ad_realm | String | LDAP/AD realm |
ad_rdn_attr | String | Attribute to be used as RDN for the LDAP/AD |
desktop_policy_attr | String | LDAP/AD's attribute which holds the DesktopPolicy's definition for each entry. Can be empty |
desktop_policy_default | String | Default DesktopPolicy definition to be used when desktop_policy_attr is empty or doesn't exists. Can be empty |
terminals | TerminalInfo Array | List of Terminals registered on this TerminalPolicy. |
JSON example
{ "ad_rdn_attr" : "cn" , "state" : "active" , "auth_mode" : "active_directory" , "terminal_policy_id" : "default" , "terminals" : [{ "terminal_id" : "h5-92fc15f6-dc24-7582-466c-eabc5827cb56" , "last_access" : "2015-12-15 16:12:29 (accepted)" }], "desktop_proto" : "vdi" , "ad_proxy_pass" : "password" , "ad_server_ip" : "10.111.8.12" , "desktop_policy_attr" : "description" , "desktop_policy_default" : "windows7_public=Windows 7,opensuse421_public=OpenSUSE 42.1" , "ad_server_port" : "389" , "ad_proxy_user" : "cn=Administrator,cn=Users,dc=flexvdi,dc=demo" , "rdp_server_ip" : "" , "ad_realm" : "cn=Users,dc=flexvdi,dc=demo" } |
TerminalInfo Object
Schema
terminal_id | String | Terminal's unique identifier |
---|---|---|
last_access | String | Last access date, and if was or not accepted |
JSON example
{ "terminal_id" : "h5-92fc15f6-dc24-7582-466c-eabc5827cb56" , "last_access" : "2015-12-15 16:12:29 (accepted)" } |