Download

Session Manager Admin API

Introduction

This SOAP API provides you with a simple Web Services API for interacting with OVD Enterprise. This reference guide documents the operations and their parameters and responses.

SOAP Endpoint

The URL used for all operations is: https://{OVD_SESSIONMANAGER_HOST}/ovd/service/admin

Sample Usage

This is a sample python script demonstrating usage of an operation from this API. The operation users_list_partial is used to retrieve a list of all users based on a specified filter:

from SOAPpy import WSDL

import M2Crypto
M2Crypto.SSL.Connection.postConnectionCheck = None

import ssl
try:
    ssl._create_default_https_context = ssl._create_unverified_context
except AttributeError as err:
    pass

class Proxy(WSDL.Proxy):
    #/usr/lib/pymodules/python2.6/SOAPpy/
    def __getattr__(self, name):
        if not self.methods.has_key(name): raise AttributeError, name

        callinfo = self.methods[name]
        self.soapproxy.namespace = callinfo.namespace
        self.soapproxy.soapaction = callinfo.soapAction
        return self.soapproxy.__getattr__(name)

# http://pypi.python.org/pypi/SOAPpy/
#  888345: Python 2.3 boolean type serialized as int


if __name__ == "__main__":
    LOGIN = "admin"
    PASSWORD = "admin"
    SM_HOST = "127.0.0.1"
    WSDL_PATH = "https://%s/ovd/service/admin/wsdl"%SM_HOST

    SERVICE_URL = "https://%s:%s@%s/ovd/service/admin"%(LOGIN, PASSWORD, SM_HOST)

    proxy = Proxy(WSDL_PATH)
    proxy.soapproxy = WSDL.SOAPProxy(SERVICE_URL)

    r = proxy.users_list_partial('c', ['login'])

    print "NB result: ",len(r['data'].item)
    for k in r['data'].item:
        u = {}
        for attr in k.value.item:
            u[attr.key] = attr.value

        print " *",u['login'],"=>",u['displayname']

To run this sample on your system, please install the soappy and m2crypto Python libraries as described above:

pip install SOAPpy "wstools<0.4.4" m2crypto

Retrieving Object IDs

Many of the API operations require object IDs as input parameters. There are API operations to retrieve lists of most items and these lists will have the object ids as keys and the objects, which have the object id as an attribute, as values. You can process these lists to have whatever attribute you know as a key instead and use the new, processed list to retrieve object IDs (the IDs can also be found in the URLs of the objects' pages in the Administration Console).

This is a sample python script demonstrating how to retrieve a list, process it, and use it to get object ids. The operation users_groups_list_partial is used to retrieve a list of all user groups. It is then processed so the group names are keys and so we can use the names to find the ids:

def getUserGroupsData(userGroupNames):
"""Generate a list of key value pairs groupName=>groupID
for each group name provided in the input list.
"""
r = proxy.users_groups_list_partial()
userGroupsRaw = r['data'].item
if type(userGroupsRaw).__name__ != "list":
    userGroupsRaw = [userGroupsRaw]

userGroupsAll = {}
for k in userGroupsRaw:
    for j in k.value.item:
        if j.key == "name":
            userGroupsAll[j.value] = k.key


userGroups = {}
for k in userGroupNames:
    userGroups[k] = userGroupsAll[k]

return userGroups

Important

If your new key is not unique, you will not be able to retrieve all IDs like this. Ex: you have two user groups with the name Group1. Since list keys only have one value, then the new list will only have one object as a value for 'Group1' even though there are two valid IDs for that name.

Configuring OVD Settings

The API operation settings_set can be used to modify OVD settings. The input parameter will be a nested list based on the section containers a setting is within. Here is an example of how to format the input for settings_set:

<?php
$settings = [
    'AuthMethod'=> [
        'SAML2'=> [
            'idp_url'=>'https://www.inuvikaidp.com',
            'idp_fingerprint'=>'Finger Print value',
            'idp_cert'=>'Certificate value',
        ],
    ],
];

$res = $service->settings_set($settings);

In this example, we are updating the three fields required for SAML2 Authentication: idp_url, idp_fingerprint, and idp_cert. These settings are contained within the SAML2 container which is contained in the AuthMethod container, so the input array contains three levels to account for these containers ((AuthMethod) > (SAML2) > (idp_url, idp_fingerprint, idp_cert)).

Web Service OvdAdminService

  • Target Namespace: uri:ovd
  • Port: OvdAdminPort
  • Location: localhost
  • Protocol: SOAP
  • Default style: rpc
  • Transport protocol: SOAP over HTTP

Operations for OvdAdminPortType

admin_actions_list

Fetch a list of all admin actions.

  • Parameters:

    • offset (integer): The index at which to start returning results. Ex: 100 results, an offset of 10 means to return results starting at the 11th one. Set to 0 for no offset.
  • Response (list): Actions performed by administrators. Each action object contains the following attributes:

    • who (string)
    • what (string)
    • when (string)
    • where (string)
    • infos (list)

admin_add

Add an admin user.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • login (string): Login.
    • displayname (string): Display Name.
    • password (string): Password.
    • rootadmin (boolean): Boolean value indicating whether this admin will be a root admin with all rights.
  • Response (boolean): A success or failure.

admin_add_organization

Assign an admin to an organization.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • login (string): The admin login.
    • organization (string): The organization id.
  • Response (boolean): A success or failure.

admin_info

Fetch a list of the specified admin's attributes.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • login (string): The admin user's login. If null is used, the function returns the information for yourself.
  • Response (object): An admin object that contains the following attributes:

    • login (string)
    • displayname (string)
    • password (string)
    • rootadmin (boolean)

admin_modify

Modify an admin.

Note

This function is available in versions 2.7 and greater

  • Parameters: Set any attribute you are not modifying to null.

    • login (string): Login
    • displayname (string): Display Name
    • password (string): Password
    • rootadmin (boolean): Boolean value indicating whether this admin will be a root admin with all rights.
  • Response (boolean): A success or failure.

admin_remove

Remove an admin.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • login (string): The admin login.
  • Response (boolean): A success or failure.

admin_remove_organization

Remove a admin from an organization's admin list.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • login (string): The admin login.
    • organization (string): The organization id.
  • Response (boolean): A success or failure.

administrator_password_set

Change the administrator password for the session manager.

  • Parameters:

    • password (string): The new password.
  • Response (boolean): A success or failure.

admins_list

Fetch a list of all admins.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • search_item (string): The value of the attribute specified in the search field parameter. Leave blank to retrieve all results.
    • search_fields (list): The user attribute to search through. Possible values are:
      • login
      • displayname
  • Response (list): A list of two items:

    • partial (boolean) - refers to whether all results were returned or not. The number of results returned will not exceed the maximum value set in for max_results_per_page in general settings.
    • data (list) - a key-value list where the keys are the admin logins and the values are admin objects that contain the following attributes:
      • login (string)
      • displayname (string)

application_add_mime_type

Add a MIME type to an application.

  • Parameters:

    • application (string): The application id.
    • mime_type (string): MIME Type.
  • Response (boolean): A success or failure.

application_clone

Clone an application.

  • Parameters:

    • application (string): The application id.
  • Response (string or boolean): The id of the new application if successfully created. False otherwise.

application_icon_get

Get the specified application's desktop icon.

  • Parameters:

    • application (string): The application id.
  • Response (string): The icon file contents (base64 encoded).

application_icon_getFromServer

  • Parameters:

    • application (string): The application id.
    • server_id_or_fqdn (string): The internal server id or the server fqdn.
  • Response (string): The url of the icon if found. null otherwise.

application_icon_set

Set the specified application's desktop icon.

  • Parameters:

    • application (string): The application id.
    • icon (string): Icon. This is the icon file's contents (base64 encoded).
  • Response (boolean): A success or failure.

application_icon_setFromServer

  • Parameters:

    • application (string): The application id.
    • server_id_or_fqdn (string): The internal server id or the server fqdn.
  • Response (boolean): A success or failure.

application_info

Fetch a list of the specified application's attributes.

  • Parameters:

    • application (string): The application id.
  • Response (object): An application object that contains the following attributes:

    • id (string)
    • name (string)
    • description (string)
    • type (string)
    • executable_path (string)
    • published (boolean)
    • desktopfile (string)
    • static (integer)
    • license_threshold (integer)
    • servers (object): an object with server ids as the keys and server names as the values.
    • groups (object): an object with application group ids as the keys and group names as the values.
    • mimetypes (object): an object with mime type ids as the keys and mime type objects as the values.
    • licenses (boolean): a boolean value indicating whether the application has licenses or not.

application_publish

Indicate whether an application should be published (available for use) or not.

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • application (string): The application id.
    • publish (boolean): Published. Set this to 1 if the application should be published and 0 if not.
  • Response (boolean): A success or failure.

application_remove

Remove an application.

  • Parameters:

    • application (string): The application id.
  • Response (boolean): A success or failure.

application_static_add

Add a static application.

  • Parameters:

    • name (string): Application Name.
    • description (string): Description.
    • type (string): Type.
    • command (string): Command. This is the executable path.
  • Response (string): The id of the new application if successfully created. null otherwise.

application_static_modify

Modify a static application.

  • Parameters:

    • id (string): Application ID.
    • name (string): Name.
    • description (string): Description.
    • command (string): Command. This is the executable path.
  • Response (boolean): A success or failure.

application_static_remove

Remove a static application.

  • Parameters:

    • application (string): The application id.
  • Response (boolean): A success or failure.

application_static_removeIcon

Remove a static application's desktop icon.

  • Parameters:

    • application (string): The application id.
  • Response (boolean): A success or failure.

application_usage_for_usergroups_reports_list

Fetch a list of application usage data grouped by user group.

  • Parameters: Set parameters to null to retrieve all results.

    • filter (object): An object containing the attributes to filter on and their values. Possible attributes are:
      • start_date (string)
      • end_date (string)
      • user (string)
      • application (string)
      • license (string): This refers to license type.
        • Example: {"start_date":"2015-02-27", "user":"cholland", "license":"Concurrent User License"}
    • limit (integer): Search limit is the number of results to return. All possible results will be returned by default.
  • Response (list): Report objects containing usage information for each application run by each user group. Each report contains the following attributes:

    • usergroup (string)
    • application (string)
    • date (string)
    • server (string): id of the server.
    • duration (integer)

application_usage_reports_list

Fetch a list of application usage data.

  • Parameters:

    • filter (object): An object containing the attributes to filter on and their values. Possible attributes are:
      • start_date (string)
      • end_date (string)
      • user (string)
      • application (string)
      • license (string): This refers to license type.
        • Example: array('start_date'=>'2015-02-27', 'user'=>cholland, 'license'=>'Concurrent User License')
    • limit (integer): The number of results to return. All possible results will be returned by default.
  • Response (list): A list of report objects containing usage information for each instance of each application. Each report contains the following attributes:

    • usergroup (string)
    • user (string)
    • application (string)
    • date (string)
    • type (string): license type. Set to No Licenses by default.
    • start_stamp (integer)
    • stop_stamp (integer)
    • server (string)
    • duration (integer)

application_webapp_add

Add a web application.

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • name (string): Application Name.
    • description (string): Description.
    • url_prefix (string): URL Prefix.
    • configuration (list): Configuration.
  • Response (string): The id of the new application if successfully created. null otherwise.

application_webapp_clone

Clone a web application.

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • application (string): The application id.
  • Response (boolean): A success or failure.

application_webapp_info

Fetch a list of the specified web application's attributes.

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • application (integer): The application id.
  • Response (object): Web application object containing the following elements:

    • application_id (integer)
    • url_prefix (string)
    • raw_configuration (object)
    • values(list)

application_webapp_modify

Modify a web application.

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • application (integer): The application id.
    • configuration (object): Configuration.
  • Response (boolean): A success or failure.

application_webapp_remove

Remove a web application.

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • application (string): The application id.
  • Response (boolean): A success or failure.

application_webapp_set_values

Set a web application's values.

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • application (integer): The application id.
    • values (list): List of values.
  • Response (boolean): A success or failure.

applications_group_add

Add an application group.

  • Parameters:

    • name (string): Group Name.
    • description (string): Description.
  • Response (string): The id of the new group if successfully created. null otherwise.

applications_group_add_application

Add an application to an application group.

  • Parameters:

    • application (string): The application id.
    • group (string): The application group id.
  • Response (boolean): A success or failure.

applications_group_info

Fetch a list of the specified application group's attributes.

  • Parameters:

    • application_group (string): The application group id.
  • Response (object): An application group object containing the following attributes:

    • id (integer)
    • name (string)
    • description (string)
    • published (boolean)

applications_group_modify

Modify an application group.

  • Parameters:

    • id (string): Application Group ID.
    • name (string): Name.
    • description (string): Description.
    • published (boolean): Published. Set this to 1 if the application group should be enabled and 0 if not.
  • Response (boolean): A success or failure.

applications_group_remove

Remove an application group.

  • Parameters:

    • application_group (string): The application group id.
  • Response (boolean): A success or failure.

applications_group_remove_application

Remove an application from an application group.

  • Parameters:

    • application (string): Application ID.
    • group (string): Application Group ID.
  • Response (boolean): A success or failure.

applications_groups_list

Fetch a list of all application groups.

  • Parameters: N/A

  • Response (object): A list with the application group ids as keys and application group objects as values. The objects contain the following attributes:

    • id (integer)
    • name (string)
    • description (string)
    • published (boolean)

applications_list

Fetch a list of all applications.

  • Parameters:

    • type (string): Application type. Ex: linux. Set to null if not relevant.
  • Response (object): A list with the application ids as keys and application objects as values. The objects contain the following attributes:

    • id (integer)
    • name (string)
    • description (string)
    • type (string)
    • executable_path (string)
    • published (boolean)
    • desktopfile (string)
    • static (string)
    • license_threshold (integer)

applications_remove_mime_type

Remove a MIME type from an application.

  • Parameters:

    • application (string): Application ID.
    • mime_type (string): MIME Type.
  • Response (boolean): A success or failure.

applications_remove_orphans

Remove orphan applications (applications that are no longer on any application server).

  • Parameters: N/A

  • Response (boolean): A success or failure.

available_users_for_group

Fetch a list of users that are not in the specified group.

  • Parameters:

    • search (string or null): Search item is the value of the attribute specified in the search field parameter.
    • search_fields (list or null): Search field is the user group attribute to search through. Possible values are:
      • name (string)
      • description (string)
    • group (string): Group ID.
  • Response (list): A list of two items:

    • partial (boolean) - refers to whether all results were returned or not. The number of results returned will not exceed the maximum value set in for max_results_per_page in general settings.
    • data (list) - a key-value list where the keys are user logins and the values are user objects that contain the following attributes:
      • login (integer)
      • displayname (string)

certificate_add

Add a subscription key.

  • Parameters:

    • file (string): The file contents (base64 encoded).
  • Response (integer): Returns 0 if the key was added successfully, 1 if there was an error, and 2 if it already exists.

certificate_del

Remove a subscription key.

  • Parameters:

    • certificate (string): The subscription key's id.
  • Response (boolean): A success or failure.

certificate_reset_named_users

Remove all named users.

  • Parameters: N/A

  • Response (boolean): A success or failure.

certificates_limits

Fetch a list of usage limits and information for certificates.

  • Parameters: N/A

  • Response (object): A certificate object containing the following attributes:

    • global_validity (boolean): indicates if there is at least one valid certificate.
    • global_from (integer): Time stamp indicating when the current period of enterprise access began.
    • global_to (integer): Time stamp indicating when the next valid key will expire (i.e. when the next change in licensing will occur).
    • concurrent_users_max (integer)
    • named_users_max (integer)
    • concurrent_users_current (integer)
    • named_users_current (integer)

certificates_list

Fetch a list of all certificates.

  • Parameters: N/A

  • Response (list): A list of certificate objects that contain the following attributes:

    • id (integer)
    • concurrent_users (integer)
    • named_users (integer)
    • organization (string)
    • owner (string)
    • email (string)
    • start (integer)
    • expiry (integer)

checkup

Get a general set of status information about your OVD farm.

  • Parameters: N/A

  • Response (object): A status check object that contains the following attributes:

    • php (object): an object containing the following attributes:
      • cURL
      • Imagick
      • LDAP
      • Multibyte String
      • MySQL
      • XML
    • liaisons

cleanup_liaisons

Check and clean orphan objects in database.

  • Parameters: N/A

  • Response (boolean): A success or failure.

cleanup_preferences

Check for the default user group, if exist revert the setting.

  • Parameters: N/A

  • Response (boolean): A success or failure.

default_browser_get

Get the default browser.

Note

This function is available in versions 2.6.2 or earlier

  • Parameters: N/A

  • Response (string): The name of the default browser.

default_browser_set

Set the default browser.

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • type (string): Type.
    • application (string): Application ID.
  • Response (boolean): A success or failure.

default_browser_unset

Unset the default browser.

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • browser (string): Type (the browser to unset).
  • Response (boolean): A success or failure.

eula_get_acceptance

Give information about the accepted Terms and Conditions.

  • Parameters: N/A

  • Response (object): An object with the ip and time of acceptance. Returns null if not accepted yet.

eula_set_acceptance

Save the acceptation of the Terms and Conditions.

  • Parameters: N/A

  • Response (boolean): A success or failure.

external_storage_add

Add an external storage mapping.

  • Parameters:

    • uri (string): Uri.
    • type (string): Type. Supported values are:
      • cifs
      • nfs
      • webdav
      • webdavs
    • name (string): Name.
    • authentication (integer): Authentication. Supported values are:
      • 0 for OVD User Credentials
      • 1 for Guest User (no authentication)
      • 2 for Custom Authentication (must provide Login and Password for this option)
    • login (string): Login (for Custom Authentication).
    • password (string): Password (for Custom Authentication).
    • parameters (string): Parameters.
  • Response (string): The external storage mapping's id if added successfully. null otherwise.

external_storage_add_group

Add access to an external storage to a user group.

  • Parameters:

    • group_id (string): User Group ID.
    • share_id (string): External Storage Mapping ID.
  • Response (boolean): A success or failure.

external_storage_info

Fetch a list of the specified external storage mapping's attributes.

  • Parameters:

    • external_storage (string): The external storage mapping id.
  • Response (object): An external storage object containing the following attributes:

    • id (integer)
    • uri (string)
    • type (string)
    • name (string)
    • authentication (integer). Supported values are:
      • 0 for OVD User Credentials
      • 1 for Guest User (no authentication)
      • 2 for Custom Authentication
    • login (string) (for Custom Authentication)
    • password (string) (for Custom Authentication)
    • parameters (string)
    • groups (object): a list with modes as keys and objects as values. The objects have the group ids as keys and their names as values.

external_storage_modify

Modify an external storage mapping.

  • Parameters:

    • id (string): External Storage Mapping ID. This can be retrieved from the admin console (go to a mapping's page and the id will be in the url) or using the external_storages_list operation to get a list of external storage mappings. Looking at the keys of the list for ids.
    • uri (string): Uri.
    • type (string): Type. Supported values are:
      • cifs
      • nfs
      • webdav
      • webdavs
    • name (string): Name.
    • authentication (integer): Supported values are:
      • 0 for OVD User Credentials
      • 1 for Guest User (no authentication)
      • 2 for Custom Authentication
    • login (string): Login (for Custom Authentication).
    • password (string): Password (for Custom Authentication).
    • parameters (string): Parameters.
  • Response The external storage's id if added successfully. null otherwise.

external_storage_publications_list

Fetch a list of all publications or all publications for a specified external storage.

  • Parameters:

    • id (string): (optional) The external storage mapping id.
    • group_by (string): (optional) Attribute to group by. Valid options are:
      • id (external storage id)
      • group (user group id)
  • Response (list): A list with objects containing information about each external storage publication. If retrieving all publications, the keys will be external storage mapping ids and the values will be a list of publications for each storage. The array object for each publication contains the following attributes:

    • id (integer): external storage mapping id
    • group (integer): user group id
    • mode

external_storage_remove

Remove an external storage mapping.

  • Parameters:

    • external_storage (string): The external storage mapping id.
  • Response (boolean): A success or failure.

external_storage_remove_group

Remove access to an external storage from a user group.

  • Parameters:

    • group_id (string): User Group ID.
    • share_id (string): External Storage Mapping ID.
  • Response (boolean): A success or failure.

external_storages_list

Fetch a list of all external storage mappings.

  • Parameters: N/A

  • Response (object): A list with the external storage mapping ids as keys and objects containing information about each storage as values. The object for each storage contains the following attributes:

    • id (integer)
    • uri (string)
    • type (string)
    • name (string)
    • authentication (integer). Supported values are:
      • 0 for OVD User Credentials
      • 1 for Guest User (no authentication)
      • 2 for Custom Authentication
    • login (string) (for Custom Authentication)
    • password (string) (for Custom Authentication)
    • parameters (string)
    • groups (object): a list with modes as keys and objects as values. The objects have the group ids as keys and their names as values.

fileserver_cluster_add

Create a new File Server Cluster.

  • Parameters:

    • name (string): Cluster Name.
    • desc (string): Description.
    • vip (string): Virtual IP.
  • Response (string): The id of the new cluster if successfully created. null otherwise.

fileserver_cluster_add_server

Add a server to an File Server Cluster.

  • Parameters:

    • cluster_id (string): Cluster ID.
    • server (string): Server id or fqdn.
  • Response (boolean): A success or failure.

fileserver_cluster_info

Fetch a list of the specified cluster's attributes.

  • Parameters:

    • cluster_id (string): The cluster id.
  • Response (list): A list containing the following attributes:

    • id (integer)
    • name (string)
    • desc (string)
    • locked (integer)
    • vip (string)
    • status
    • servers (object ): an object with server ids as the keys and server names as the values.
    • storage units (object): an object with storage unit ids as the keys and names as the values.

fileserver_cluster_list

Fetch a list of all File Server Clusters.

  • Parameters: N/A

  • Response (object): A list with the cluster ids as keys and objects containing information about each cluster as values. The array object for each cluster contains the following attributes:

    • id (integer)
    • name (string)
    • desc (string)
    • locked (integer)
    • vip (string)
    • status
    • servers (object)

fileserver_cluster_modify

Modify a File Server Cluster.

  • Parameters: Set any attribute you are not modifying to null.

    • id (string): Cluster ID.
    • name (string): Name.
    • desc (string): Description.
    • locked (boolean): Indicate whether the cluster is enabled or disabled.
    • vip (string): Virtual IP.
  • Response (boolean): A success or failure.

fileserver_cluster_remove

Remove a File Server Cluster.

  • Parameters:

    • cluster_id (string): The cluster id.
  • Response (boolean): A success or failure.

fileserver_cluster_remove_server

Remove a server to an File Server Cluster.

  • Parameters:

    • cluster_id (string): Cluster ID.
    • server (string): Server id or fqdn.
  • Response (boolean): A success or failure.

fileserver_cluster_share

Share a cluster to a tenant.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • cluster_id (string): The internal cluster id.
    • organization_id (string): The id of the organization that will access the server.
    • value (boolean): The authorization value. Set to true to add authorization and false to remove rights.
  • Response (boolean): A success or failure.

getInitialConfiguration

Fetch a list of initial settings configurations.

Note

This function has changed between versions so please refer to the appropriate version below.

Versions 2.7 and greater

  • Parameters: N/A

  • Response (object): A configuration object containing initial settings configurations. The object contains the following attributes:

    • version (string)
    • max_items_per_page (integer)
    • admin_language (string)
    • system_inited (boolean)
    • system_in_maintenance (boolean)
    • policy
    • premium (boolean)
    • The following keys will also be present if the module it represents is enabled:
      • UserDB (object): an object with two attributes, name and writable.
      • UserGroupDB (object): an object with two attributes, name and writable.
      • UserGroupDBDynamic (boolean): a boolean value indicating whether it is enabled.
      • UserGroupDBDynamicCached (boolean): a boolean value indicating whether it is enabled.

Versions 2.6 or earlier

  • Parameters: N/A

  • Response (object): A configuration object containing initial settings configurations. The object contains the following attributes:

    • version (string)
    • max_items_per_page (integer)
    • admin_language (string)
    • system_inited (boolean)
    • system_in_maintenance (boolean)
    • policy
    • premium (boolean)
    • The following keys will also be present if the module it represents is enabled:
      • UserDB (object): an object with two attributes, name and writable.
      • UserGroupDB (object): an object with two attributes, name and writable.
      • ApplicationDB (object): an object with two attributes, name and writable.
      • UserGroupDBDynamic (boolean): a boolean value indicating whether it is enabled.
      • UserGroupDBDynamicCached (boolean): a boolean value indicating whether it is enabled.
      • ProfileDB (boolean): a boolean value indicating whether it is enabled.
      • SharedFolderDB (boolean): a boolean value indicating whether it is enabled.

get_smid

Get the session manager ID.

  • Parameters: N/A

  • Response (string): The session manager's id. Returns null if there was an issue retrieving it.

has_valid_certificate

Check if you have a valid certificate for OVD Enterprise Edition.

  • Parameters: N/A

  • Response (string or boolean): The expiry date for the certificate if a valid one exists. False otherwise.

keyfile_add

Add a keyfile for a license.

  • Parameters:

    • license_id (string): The license id.
    • file_name (string): The file name, with extension.
    • file_data (string): The file contents (base64 encoded).
  • Response (string or boolean): The id of the new key file if successfully created. False otherwise.

keyfile_info

Fetch a list of the specified license's keyfile information.

  • Parameters:

    • license_id (string): The license id.
  • Response (list): A keyfile object containing information about the keyfile for the specified license. The object contains the following attributes:

    • id (integer): id of the keyfile
    • license_id (integer)
    • file_name (string)
    • file_data (string)

keyfile_remove

Remove a keyfile for a license.

  • Parameters:

    • license_id (string): The license id.
  • Response (boolean): A success or failure.

license_add

Add a license.

  • Parameters:

    • application_id (string): Application ID. This can be retrieved from the admin console (go to an application's page and the id will be in the url) or using the applications_list operation to get a list of applications as application_id=>application info and then processing the list to have application names as the key by retrieving them from the application info.
    • key (string): License Key (set this to null if you will be adding a key file for this license instead).
    • start_date (string): Start Date (in the format YYYY-mm-dd).
    • end_date (string): Expiry Date (in the format YYYY-mm-dd).
    • num_licenses (integer): Number of Licenses.
    • type (string): License Type name.
    • cost (string): (optional) Cost.
    • vendor (string): (optional) Vendor.
  • Response (string or boolean): The id of the new license if successfully created. False otherwise.

license_info

Fetch a list of the specified license's attributes.

  • Parameters:

    • license_id (string): The license id. This can be retrieved from the admin console (go to an license's page and the id will be in the url) or using the licenses_list operation to get a list of licenses per application, isolate the list of licenses for the application the license is for, and then looking at the keys of the list.
  • Response (object): A license object containing the following attributes:

    • id (integer)
    • key (integer)
    • start_date (string)
    • end_date (string)
    • num_licenses (integer)
    • type (string)
    • cost (string)
    • vendor (string)
    • has_key_file (boolean)
    • licenses_allocated (integer)
    • application_id (integer)

license_modify

Modify a license.

  • Parameters: Set any attribute you are not modifying to null.

    • id (string): License ID. This can be retrieved from the admin console (go to an license's page and the id will be in the url) or using the licenses_list operation to get a list of licenses per application, isolate the list of licenses for the application the license is for, and then looking at the keys of the list.
    • start_date (string): Start Date (in the format YYYY-mm-dd).
    • end_date (string): Expiry Date (in the format YYYY-mm-dd).
    • num_licenses (integer): Number of Licenses.
    • type (string): License Type name.
    • vendor (string): Vendor.
    • cost (string): Cost.
    • key (string): Key.
  • Response (boolean): A success or failure.

license_remove

Remove a license.

  • Parameters:

    • license_id (string): The license id. This can be retrieved from the admin console (go to an license's page and the id will be in the url) or using the licenses_list operation to get a list of licenses per application, isolate the list of licenses for the application the license is for, and then looking at the keys of the list.
  • Response (boolean): A success or failure.

license_type_add

Add a license type.

  • Parameters:

    • license_type (string): The name of the new license type.
  • Response (string or boolean): The id of the new license type if successfully created. False otherwise.

license_type_modify

Modify a license type.

  • Parameters:

    • license_type_old (string): The old name of the license type.
    • license_type_new (string): The new name of the license type.
  • Response (boolean): A success or failure.

license_type_remove

Remove a license type.

  • Parameters:

    • license_type (string): The license type name.
  • Response (boolean): A success or failure.

license_types_list

Fetch a list of license types.

  • Parameters: N/A

  • Response (list): A list of license type objects containing the following attributes:

    • id (integer): license type id.
    • name (string)
    • is_custom (boolean): set to true if you've added this type and false if it is a default type.

license_types_reporting_list

Fetch a list of all license types present in reporting data.

  • Parameters: N/A

  • Response (list): A list of all license types present in reporting data. The license type objects contain the following attributes:

    • id (integer): license type id.
    • name (string)

licenses_list_partial

Fetch a list of all licenses grouped by application.

  • Parameters:

    • search_item (string or null): The value of the attribute specified in the search field parameter.
    • search_fields (list or null): The user attribute to search through. Possible values are:
      • application_name
      • type
      • end_date. When searching by end_date, licenses expiring in less than or equal to the number of days you enter for end_date will be returned.
    • limit (integer): Search limit is the number of results to return. If value is 0, all results are returned.
  • Response (any): A list of two items:

    • partial (boolean) - refers to whether all results were returned or not. The number of results returned will not exceed the maximum value set in for max_results_per_page in general settings.
    • data (list) - a key-value list where the keys are application ids and the values are license objects associated with that application. These license objects contain the following attributes:
      • id (integer)
      • key (string)
      • start_date (string)
      • end_date (string)
      • num_licenses (integer)
      • type (string)
      • cost (string)
      • vendor (string)
      • has_key_file (boolean)
      • licenses_allocated (integer)

licenses_reports_list

Fetch license allocation information.

  • Parameters:

    • filter (dict_string_string): The filter is a list containing the attributes to filter on and their values. Leave blank to retrieve all results. Possible attributes are:
      • start_date. This refers to the date the license was allocated and results with start dates greater than or equal to the specified date will be returned.
      • end_date. This refers to the date the license will expire, and results with end dates less than or equal to the specified date will be returned. Example: array('start_date'=>'2015-02-27', user=>cholland)
      • user
      • application
    • limit (integer): Search limit is the number of results to return. All results are returned by default.
  • Response (object): A list of license report objects containing information for each license allocated. The objects contain the following attributes:

    • user (string)
    • application_id (integer)
    • allocation_date (string)
    • expiry_date (string)
    • server_id (string)

log_download

Fetch a log file.

  • Parameters:

    • logfile (string): The log file's name.
  • Response (string): The log file's contents.

log_preview

Fetch a preview of all log files.

  • Parameters: N/A

  • Response (object): An object with the log file names as keys and their latest twenty lines as values. Also includes the key servers which is a list of all the log files for each server and their latest twenty lines.

mime_type_info

Fetch a list of applications with the specified MIME type.

  • Parameters:

    • mime_type (string): The MIME type.
  • Response (object): An object with two attributes:

    • id (string): the MIME type.
    • applications (object): an object in which the application ids are keys and the values are application objects containing the following attributes:
      • id (integer)
      • name (string)
      • description (string)
      • type (string)
      • executable_path (string)
      • published (boolean)
      • desktopfile (string)
      • static (boolean)
      • license_threshold (integer)

mime_types_list

Fetch a list of application MIME types.

  • Parameters: N/A

  • Response (list): A list of MIME types.

network_folder_remove

Remove a network folder.

Important

Deprecated in versions 2.7 and greater. Please use storage_unit_remove instead.

  • Parameters:

    • storage_id (string): The storage unit id.
  • Response (boolean): A success or failure.

news_add

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • title (string)
    • content (string)
  • Response (any)

news_info

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • news_id (string): The news id.
  • Response (object): A news object.

news_list

Note

This function is available in versions 2.6.2 or earlier

  • Parameters: N/A

  • Response (list): A list of news items.

news_modify

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • id (string)
    • title (string)
    • content (string)
  • Response (boolean): A success or failure.

news_remove

Remove the news identified by its ID and returns true if the operation is done.

Note

This function is available in versions 2.6.2 or earlier

  • Parameters:

    • news_id (string): The news id.
  • Response (boolean): A success or failure.

organization_add

Add an organization.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • organization_info (object): An object containing the organization attributes. The array must include name and domain, and can also have description if needed.
  • Response (string): The id of the new organization if successfully created. null otherwise.

organization_info

Fetch a list of the specified organization's attributes.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • organization_id (string): The organization id.
  • Response (object): An object containing the following attributes:

    • id (string)
    • name (string)
    • description (string)
    • domain (string)

organization_modify

Modify an organization.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • organization_info (object): An array containing the organization attributes. The array must include id, which refers to the organization id. Additional keys name, domain, and description are optional.
  • Response (boolean): A success or failure. If no attribute has been changed, the function returns a failure.

organization_remove

Remove an organization.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • organization_id (string): The organization id.
  • Response (boolean): A success or failure.

organization_select

Select a particular organization for subsequent call to the API.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • organization (string): The organization id. If null, this will return to the global context without any selected organization.
    • persist (boolean): A persistence boolean. If false, only the next API call will be affected by the organization selection.
  • Response (boolean): A success or failure.

organization_set_default

Set an organization as the system's default organization.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • organization_id (string): The organization id. A null value means no default organization is defined.
  • Response (boolean): A success or failure.

organizations_list

Fetch a list of all organizations.

Note

This function is available in versions 2.7 and greater

  • Parameters: N/A

  • Response (object): A list with the organizations ids as keys and organization objects containing information about each organization as values. The organization objects contain the following attributes:

    • id (string)
    • name (string)
    • description (string)
    • domain (string)

publication_add

Add a publication (give a user group access to an application group).

  • Parameters:

    • users_group (string): User Group ID.
    • applications_group (string): Application Group ID.
  • Response (boolean): A success or failure.

publication_remove

Remove a publication (remove a user group's access to an application group).

  • Parameters:

    • users_group (string): User Group ID.
    • applications_group (string): Application Group ID.
  • Response (boolean): A success or failure.

script_add

Add a script.

  • Parameters:

    • name (string): Name.
    • os (string): OS. Valid values are windows, linux, and all.
    • type (string): Type. Valid values are:
      • when OS is linux: bash and python
      • when OS is windows: batch, powershell, python, and vbs
      • when OS is all: python
    • data (string): Data.
  • Response (integer): The id of the new script if successfully created. null otherwise.

script_info

Fetch a list of the specified scripts's attributes.

  • Parameters:

    • script_id (string): The script id.
  • Response (object): A script object containing the following attributes:

    • id (string)
    • name (string)
    • os (string)
    • type (string)
    • data (string)
    • groups (object): A list for which the group ids are the keys and the group names are the values.

script_modify

Modify a script.

  • Parameters:

    • id (string): Script ID.
    • name (string): Name.
    • os (string): OS. Valid values are windows, linux, and all.
    • type (string): Type. Valid values are:
      • when OS is linux: bash and python
      • when OS is windows: batch, powershell, python, and vbs
      • when OS is all: python
    • data (string): Data.
  • Response (boolean): A success or failure.

script_remove

Remove a script.

  • Parameters:

    • script_id (string): The script id.
  • Response (boolean): A success or failure.

scripts_groups_list

Fetch a list of all scripts for a user group.

  • Parameters:

    • user_group_id (string): The user group id.
  • Response (object): A list with the script ids as keys and script objects as values. The script objects contain the following attributes:

    • id (string)
    • name (string)
    • type (string)
    • os (string)
    • data (string)

scripts_list

Fetch a list of all scripts.

  • Parameters: N/A

  • Response (object): A list with the script ids as keys and script objects containing information about each script as values. The script objects contain the following attributes:

    • id (string)
    • name (string)
    • type (string)
    • os (string)
    • data (string)

send_test_alert

Send a test email alert to all email addresses listed in the "Notifications" settings.

  • Parameters: N/A

  • Response (boolean): A success or failure.

server_add_static_application

Add a static application to a server.

  • Parameters:

    • application (string): The application id.
    • server_id_or_fqdn (string): The internal server id or the server fqdn.
  • Response (boolean): A success or failure.

server_info

Fetch a list containing the information for a specified server.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • full (boolean): A boolean value indicating whether the server information contains all information (true) or only basic information (false).
  • Response (object): A list of information about the specified server. The list contains the following information:

    • server id
    • server fqdn
    • server status
    • whether server is registered or not
    • whether server is locked/in maintenance mode or not
    • a list containing storage unit ids for the server

server_register

Register an unregistered server.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
  • Response (boolean): A success or failure.

server_remove

Remove a server.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
  • Response (boolean): A success or failure.

server_remove_static_application

Remove a static application from a server.

  • Parameters:

    • application (string): The application id.
    • server_id_or_fqdn (string): The internal server id or the server fqdn.
  • Response (boolean): A success or failure.

server_role_disable

Disable a specified role for a server.

Note

This function has changed between versions so please refer to the appropriate version below.

Versions 2.7 and greater

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • role (string): The server role. Supported values are:
      • aps
      • fs
  • Response (boolean): A success or failure.

Versions 2.6 or earlier

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • role (string): The server role. Supported values are:
      • webapps
      • aps
      • fs
  • Response (boolean): A success or failure.

server_role_enable

Enable a specified role for a server.

Note

This function has changed between versions so please refer to the appropriate version below.

Versions 2.7 and greater

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • role (string): The server role. Supported values are:
      • aps
      • fs
  • Response (boolean): A success or failure.

Versions 2.6 or earlier

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • role (string): The server role. Supported values are:
      • webapps
      • aps
      • fs
  • Response (boolean): A success or failure.

server_set_available_sessions

Set the maximum number of sessions for this server.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • nb_session (integer): The maximum number of sessions.
  • Response (boolean): A success or failure.

server_set_display_name

Set the server's display name.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • display_name (string): The display name.
  • Response (boolean): A success or failure.

server_set_fqdn

Set a server's fqdn.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • fqdn (string): The new fqdn.
  • Response (boolean): A success or failure.

server_set_rdp_port

Set a server's rdp port.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • rdp_port (integrer): The rdp port.
  • Response (boolean): A success or failure.

server_share

Grant access to a server to a specific organization.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • server_id (string): The internal server id.
    • organization_id (string): The id of the organization that will access the server.
  • Response (boolean): A success or failure.

server_switch_maintenance

Switch server into or out of maintenance mode.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • maintenance (boolean): A boolean value indicating whether the server is going into (true) or out of (false) maintenance mode.
  • Response (boolean): A success or failure.

server_unset_display_name

Remove a server's display name.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
  • Response (boolean): A success or failure.

server_unset_rdp_port

Remove a server's rdp port.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
  • Response (boolean): A success or failure.

server_unshare

Remove access to a server from a specific organization.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • server_id (string): The internal server id.
    • organization_id (string): The id of the organization that will no longer have access to the server.
  • Response (boolean): A success or failure.

servers_group_add

Add a server group.

  • Parameters:

    • name (string): The group's name.
    • description (string): The group's description.
  • Response (string): The id of the new server group if successfully created. null otherwise.

servers_group_add_server

Add a server to a server group.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • group (string): The server group id.
  • Response (boolean): A success or failure.

servers_group_info

Fetch a list of the specified server group's attributes.

  • Parameters:

    • server_group_id (string): The server group id.
  • Response (any): A server group object containing the following attributes:

    • id (string)
    • name (string)
    • description (string)
    • published (boolean)

servers_group_modify

Modify a server group.

  • Parameters: Set any attribute you are not modifying to null.

    • id (string): Server Group ID.
    • name (string): Name.
    • description (string): Description.
    • published (boolean): Published. Set this to 1 if the group should be published and 0 if not.
  • Response (boolean): A success or failure.

servers_group_publication_add

Add a publication (give a user group access to an application group).

  • Parameters:

    • users_group (string): User Group ID.
    • servers_group (string): Server Group ID.
  • Response (boolean): A success or failure.

servers_group_publication_remove

Remove a publication (remove a user group's access to an application group).

  • Parameters:

    • users_group (string): User Group ID.
    • servers_group (string): Server Group ID.
  • Response (boolean): A success or failure.

servers_group_remove

Remove a server group.

  • Parameters:

    • server_group_id (string): The server group id.
  • Response (boolean): A success or failure.

servers_group_remove_server

Remove a server from a server group.

  • Parameters:

    • server_id_or_fqdn (string): The internal server id or the server fqdn.
    • group (string): The server group id.
  • Response (boolean): A success or failure.

servers_groups_list

Fetch a list of all server groups.

  • Parameters: N/A

  • Response (object): A list with the server group ids as keys and server group objects as values. The server group objects contain the following attributes:

    • id (string)
    • name (string)
    • description (string)
    • published (boolean)

servers_list

Fetch a list of servers.

Note

This function has changed between versions so please refer to the appropriate version below.

Versions 2.7 and greater

  • Parameters:

    • filter (string): Used to return a filtered list of servers. This value is null by default (return all servers). It can also be set to:
      • online
      • unregistered
      • role_aps (this refers to application servers)
    • historical (boolean): Used to return list of historical server information (a list of all servers that have ever existed in the farm) instead of a list of current servers. The keys for this list are server ids and the values are server fqdns. This value is false by default. It can be set to true in order to retrieve historical data instead.
    • organizations (list): An array for optional attributes you would like added to the results. Currently the only available option is:
      • organizations
  • Response (object): A list of server objects containing information about each server.

Versions 2.6 or earlier

  • Parameters:

    • filter (string): Used to return a filtered list of servers. This value is null by default (return all servers). It can also be set to:
      • online
      • unregistered
      • role_aps (this refers to application servers)
    • historical (boolean): Used to return list of historical server information (a list of all servers that have ever existed in the farm) instead of a list of current servers. The keys for this list are server ids and the values are server fqdns. This value is false by default. It can be set to true in order to retrieve historical data instead.
  • Response (object): A list of server objects containing information about each server.

servers_reports_list

Fetch a list of server reports by start time range.

  • Parameters: Provide times as UNIX timestamps.

    • start_time (integer): Start of start time range.
    • end_time (integer): End of start time range.
  • Response (list): A list of server report objects. The server report objects contain the following attributes:

    • id (string)
    • fqdn (string)
    • time (integer)
    • ram (integer)
    • cpu (integer)
    • data (string)

session_disconnect

Disconnect a session.

  • Parameters:

    • session_id (string): The session id.
  • Response (boolean): A success or failure.

session_info

Fetch a list of the specified session's attributes.

  • Parameters:

    • session_id (string): The session id.
  • Response (object): A session object containing the following attributes:

    • id (string)
    • status (string)
    • mode (string)
    • user_login (string)
    • user_displayname (string)
    • servers (object)
    • if valid values exist for them:
      • external_storages (object)
      • start_time (integer)
      • desktop_server (object)
      • instances (object): a list of applications run during the session with the application ids as keys and the application names as values.
      • applications (object): a list of all applications published/available for the user with the application ids as keys and the application names as values.

session_kill

Kill a session.

  • Parameters:

    • session_id (string): The session id.
  • Response (boolean): A success or failure.

session_report_info

Fetch a list of the specified session's attributes.

  • Parameters:

    • session_id (string): The session id.
  • Response (object): A session report object containing the following attributes:

    • id (string)
    • user (string)
    • start (integer)
    • end (integer)
    • stop_reason (string)
    • server (string)
    • data (string): XML data containing information about servers, log files, storages, published applications, applications run during the session, settings, and session statuses.

session_report_remove

Remove a session report.

  • Parameters:

    • session_id (string): The session id.
  • Response (boolean): A success or failure.

session_simulate

Fetch a list of session info for a user by simulating a session.

  • Parameters:

    • login (string): The user login.
  • Response (object): A session object containing the following attributes:

    • settings (object)
    • user_grps (object): a list of the user's user groups. The user group ids are keys and their names are values.
    • groups_partial_list (boolean): indicaties whether groups contains all the groups the user is in or only a subset of them.
    • app_grps (object): a list of the user's application groups. The application group ids are keys and the values are application objects with the following attributes:
      • id (integer)
      • name (string)
      • type (string)
    • shared_folders (object): a list with the shared folder ids as keys and the values as shared folder objects with the following attributes:
      • share_name (string)
      • mode (string)
    • profiles (object)
    • can_start_session_desktop (boolean)
    • can_start_session_applications (boolean)
    • external_storage (object): only appears if using the Enterprise Edition and external storages are defined. This is a list with the external data storage mapping ids as keys and the values as external data storage objects with the following attributes:
      • id (integer)
      • uri (string)
      • type (string)
      • name (string)
      • authentication (integer)
      • login (string)
      • password (string)
      • parameters (string)
    • servers (object): a list with server ids as keys and the values as server objects with the following attributes:
      • id (string)
      • name (string)
      • type (string)
    • cannot_start_session_reason (string): set only if can_start_session_desktop equals false.

sessions_count

Fetch the number of sessions.

  • Parameters: N/A

  • Response (object): A list of the number of sessions per status. Possible statuses are:

    • total (will always be present)
    • unknown
    • error
    • creating
    • created
    • init
    • ready
    • logged
    • disconnected
    • wait_destroy
    • destroying
    • destroyed

sessions_history

Fetch a list of session history information for reporting or summarizing purposes.

  • Parameters: Provide times as UNIX timestamps.
    • from (integer): Start of start time range.
    • to (integer): End of start time range.
    • mode (string): Increments. The summary information will be provided for each increment within the start time range. Possible values are:
      • day (default)
      • hour
      • minute
    • servers (list): A list of server IDs. This should be a list containing all the server IDs associated with the server. In most cases this will be a list containing only a single server ID but in some cases more than one ID may have been associated with the same FQDN (ex: if a server was previously deleted and then registered again in the farm. It will have had a different ID associated with it each time it was registered).
  • Response (object): A list with two keys:
    • sessions (object) - an array where the time increments are the keys and the number of sessions launched at that time are the values.
    • stop_why (object) - an array where the stop status types are the keys and the number of sessions that ended with that status are the values. A server id can be specified if summary information is only required for that particular server.

sessions_list

Fetch a list of sessions.

  • Parameters:

    • offset (integer): Offset (the index at which to start returning results. Ex: 100 results, an offset of 10 means to return results starting at the 11th one). Set to null if no offset is desired.
  • Response (object): A list with the session ids as keys and session objects as values. The session objects contain the following attributes:

    • id (string)
    • status (string)
    • mode (string)
    • user_login (string)
    • user_displayname (string)
    • servers (object)
    • start_time (integer) (if valid value exists)
    • desktop_server (object) (if valid value exists)

sessions_list_by_server

Fetch a list of sessions for the specified server.

  • Parameters:

    • server (string): Server ID.
    • offset (integer): Offset (the index at which to start returning results. Ex: 100 results, an offset of 10 means to return results starting at the 11th one). Set to null if no offset is desired.
  • Response (object): A list with the session ids as keys and session objects as values. The session objects contain the following attributes:

    • id (string)
    • status (string)
    • mode (string)
    • user_login (string)
    • user_displayname (string)
    • servers (object)
    • start_time (integer) (if valid value exists)
    • desktop_server (object) (if valid value exists)

sessions_reports_list

Fetch a list of session reports by start time range.

  • Parameters: Provide times as UNIX timestamps.

    • start (integer): Start of start time range.
    • stop (integer): End of start time range.
  • Response (object): A list with the session ids as keys and session report objects as values. The session report objects contain the following attributes:

    • id (string)
    • user (string)
    • start (integer)
    • end (integer)
    • stop_reason (string)
    • server (string)
    • data (string): XML data containing information about servers, log files, storages, published applications, applications run during the session, settings, and session statuses.

sessions_reports_list2

Fetch a list of session reports by start and stop time range and (optionally) by server.

  • Parameters: Provide times as UNIX timestamps.

    • start (integer): Start of start time range.
    • stop (integer): End of start and stop time range (i.e. the session was started and ended before this time).
    • server (string): Server ID. Set to null if no specific server's results are required.
  • Response (object): A list with the session ids as keys and session report objects as values. The session report objects contains the following attributes:

    • id (string)
    • user (string)
    • start (integer)
    • end (integer)
    • stop_reason (string)
    • server (string)
    • data (string): XML data containing information about servers, log files, storages, published applications, applications run during the session, settings, and session statuses. A server id can be specified if reports are only required for that particular server.

sessions_reports_list3

Fetch a list of all session reports or reports filtered by time range and/or user.

  • Parameters: Provide times as UNIX timestamps.

    • start (integer): Start of start time range. Set to null if no specific start time is required.
    • stop (integer): End of start and stop time range (i.e. the session was started and ended before this time). Set to null if no specific end is required for the range.
    • user (string): User Login. Set to null if no specific user's results are required.
    • limit (integer): Search Limit. This value is 50 by default.
  • Response (object): A list with the session ids as keys and session report objects as values. The session report objects contain the following attributes:

    • id (string)
    • user (string)
    • start (integer)
    • end (integer)
    • stop_reason (string)
    • server (string)
    • data (string): XML data containing information about servers, log files, storages, published applications, applications run during the session, settings, and session statuses.

set_license_threshold

Set the license threshold for an application. When the number of remaining licenses for the application is less than or equal to the threshold, an alert will be sent if it is enabled in "Notifications".

  • Parameters:

    • application_id (string): The application id.
    • threshold (integer): The threshold.
  • Response (boolean): A success or failure.

settings_domain_integration_preview

Verify validity of LDAP/Active Directory connectivity.

  • Parameters:

    • settings (object): A list containing setting keys and their values.
  • Response (object): A list of setting with keys and their values.

settings_get

Fetch a list of settings configurations.

  • Parameters: N/A

  • Response (object): A list of settings configurations, with each setting's name as key.

settings_set

Modify settings configurations.

  • Parameters:

    • settings (object): A list containing the settings you are modifying. The setting names should be the keys and the value for each key should be the new value for the setting. See the Configuring OVD Settings section for a list of setting names.
  • Response (boolean): A success or failure.

shared_folder_add

Add a shared folder to a server.

  • Parameters:

    • shared_folder (string): The name of the shared folder.
    • server_id_or_fqdn (string): The internal server id or the server fqdn.
  • Response (string): The shared folder's id if added successfully, null otherwise.

shared_folder_add_group

Add access to a shared folder to a user group.

  • Parameters:

    • group_id (string): User Group ID.
    • share_id (string): Shared Folder ID.
    • mode (string): Mode. Valid values are ro (read only) and rw (read and write).
  • Response (boolean): A success or failure.

shared_folder_info

Fetch a list of the specified shared folder's attributes.

  • Parameters:

    • shared_folder (string): The shared folder id.
  • Response (object): A list containing the following attributes:

    • id (string)
    • name (string)
    • server (string)
    • status (string)
    • groups (object): a list with modes as keys and lists as values. The lists have the group ids as keys and their names as values.

shared_folder_modify

Modify attributes of a shared folder.

  • Parameters: null value is allowed for name and quota. The result is no modification for this attribute.

    • id (string): The shared folder id.
    • name (string): The folder's new name.
    • quota (int): The quota value (integer).
  • Response (boolean): A success or failure.

shared_folder_remove

Remove a shared folder.

  • Parameters:

    • shared_folder (string): The shared folder id.
  • Response (boolean): A success or failure.

shared_folder_remove_group

Remove access to a shared folder from a user group.

  • Parameters:

    • group_id (string): User Group ID.
    • share_id (string): Shared Folder ID.
  • Response (boolean): A success or failure.

shared_folders_list

Fetch a list of all shared folders.

  • Parameters: N/A

  • Response (object): A list with the shared folder ids as keys and shared folder objects as values. The shared folder objects contain the following attributes:

    • id (string)
    • name (string)
    • server (string)
    • status (string)

storage_unit_remove

Remove a storage unit.

Note

This function is available in versions 2.7 and greater

  • Parameters:

    • storage_unit (string): The storage unit id.
  • Response (boolean): A success or failure.

system_set_default_users_group

Set a user group as the system's default user group (all users are in the default group).

  • Parameters:

    • user_group (string): The user group id. A null value means no default group defined.
  • Response (boolean): A success or failure.

system_switch_maintenance

Switch the system into or out of maintenance mode.

Important

Deprecated. Please use system_set instead.

  • Parameters:

    • switch (boolean): A boolean value. Set to false to switch into maintenance mode and true to switch out of it.
  • Response (boolean): A success or failure.

Test if you are successfully connected and able to use this API.

  • Parameters: N/A

  • Response (boolean): A success or failure.

user_add

Add a user.

  • Parameters:

    • login (string): Login.
    • displayname (string): Display Name.
    • password (string): Password.
  • Response (boolean): A success or failure.

user_info

Fetch a list of the specified user's attributes.

  • Parameters:

    • user (string): The user login.
  • Response (object): A user object containing the following attributes:

    • login (string)
    • displayname (string)
    • locale (string)
    • groups (object): a list of user groups this user is in.
    • groups_partial_list (boolean): a boolean value indicating whether all the user's user groups are in groups or only a partial result.
    • applications (object): the applications the user has access to. The value for this is a list for which the keys are application ids and the values are application names.
    • sessions (object): the user's sessions. The value for this is a list for which the keys are session ids and the values are session start times.
    • profiles (object): a list with profile ids as keys and profile objects as values. The profile objects contain the following attributes:
      • id (string)
      • server_id (string)
      • server_name (string)
    • settings (object)
    • settings_defaults (object)

user_modify

Modify a user.

  • Parameters: Set any attribute you are not modifying to null.

    • login (string): Login.
    • displayname (string): Display Name.
    • password (string): Password.
  • Response (boolean): A success or failure.

user_personal_data_delete

Delete all non-operational data related to a specific user (for privacy reasons). To delete all other data associated with a user, the user must also be deleted from the system.

  • Parameters:

    • user (string): The user login.
  • Response (boolean): A success or failure.

user_personal_data_extract

Extract all data related to a specific user (for privacy reasons).

  • Parameters:

    • user (string): The user login.
  • Response (object): A user data object containing the following attributes:

    • login (string)
    • displayname (string)
    • locale (string)
    • groups (object): a list of user groups this user is in.
    • groups_partial_list (boolean): a boolean value indicating whether all the user's user groups are in groups or only a partial result.
    • applications (object): the applications the user has access to. The value for this is a list for which the keys are application ids and the values are application names.
    • sessions (object): the user's sessions. The value for this is a list for which the keys are session ids and the values are session start times.
    • profiles (object): a list with profile ids as keys and profile objects as values. The profile objects contain the following attributes:
      • id (string)
      • server_id (string)
      • server_name (string)
    • settings (object)
    • settings_defaults (object)

user_profile_add

Add a user profile.

  • Parameters:

    • user (string): The user login.
  • Response (boolean): A success or failure.

user_profile_info

Fetch a list of the specified profile's attributes.

  • Parameters:

    • profile (string): The profile id.
  • Response (any): A user profile object containing the following attributes:

    • id (string)
    • server (object)
    • status (string)
    • users (object): a list for which the keys are user logins and the values are user display names.

user_profile_remove

Remove a user profile.

  • Parameters:

    • profile (string): The profile id.
  • Response (boolean): A success or failure.

user_remove

Remove a user.

  • Parameters:

    • user (string): The user login.
  • Response (boolean): A success or failure.

user_settings_remove

Remove user settings.

  • Parameters:

    • user_id (string): User Login.
    • container (string): Container. This is the name of the settings section you are configuring.
    • setting (string): Setting.
  • Response (boolean): A success or failure.

user_settings_set

Configure user settings.

  • Parameters:

    • user_id (string): User Login.
    • container (string): Container. This is the name of the settings section you are configuring.
    • setting (string): Setting.
    • value (any): Value.
  • Response (boolean): A success or failure.

users_group_add

Add a user group.

  • Parameters:

    • name (string): Name.
    • description (string): Description.
  • Response (string): The id of the new license if successfully created. null otherwise.

users_group_add_policy

Add a policy to a user group.

Important

Deprecated in versions 2.7 and greater. Please use users_group_settings_set instead.

  • Parameters:

    • group_id (string): User Group ID.
    • rule (string): Policy/Rule. Valid values are:
      • canUseAdminPanel
      • viewServers
      • manageServers
      • viewSharedFolders
      • manageSharedFolders
      • viewUsers
      • manageUsers
      • viewUsersGroups
      • manageUsersGroups
      • viewApplications
      • manageApplications
      • viewApplicationsGroups
      • manageApplicationsGroups
      • viewPublications
      • managePublications
      • viewConfiguration
      • manageConfiguration
      • viewStatus
      • manageSession
      • manageReporting
      • viewSummary
      • manageScripts
      • viewScripts
      • manageScriptsGroups
      • viewScriptsGroups
  • Response (boolean): A success or failure.

users_group_add_script

Add a script to a user group.

  • Parameters:

    • script (string): Script ID.
    • group (string): User Group ID.
  • Response (boolean): A success or failure.

users_group_add_user

Add a user to a user group.

  • Parameters:

    • user_id (string): User Login.
    • group_id (string): User Group ID.
  • Response (boolean): A success or failure.

users_group_info

Fetch a list of the specified user group's attributes.

  • Parameters:

    • user_group (string): The user group id.
  • Response (object): A user group object containing the following attributes:

    • id (integer)
    • name (string)
    • description (string)
    • published (integer)
    • type (string)
    • default (boolean)
    • users (object): a list of users in this user group. User logins are the keys and their display names are the values.
    • users_partial_list (boolean): indicates whether all the user groups's users are in users or only a partial result.
    • applicationsgroups (object): the application groups the user group has access to. The value for this is a list for which the keys are application group ids and the values are the group names.
    • serversgroups (object): the server groups the user group has access to. The value for this is a list for which the keys are the server group ids and the values are their names.
    • sharedfolders (object): a list with modes as keys and lists as values. The lists have the folder ids as keys and their names as values.
    • policy
    • default_policy
    • settings (object)
    • settings_defaults (object)

users_group_modify

Modify a user group.

  • Parameters:

    • id (string): User Group ID.
    • name (string): Name.
    • description (string): Description.
    • published (boolean): Published. Set this to 1 if the group should be enabled and 0 if not.
  • Response (boolean): A success or failure.

users_group_remove

Remove a user group.

  • Parameters:

    • user_group (string): The user group id.
  • Response (boolean): A success or failure.

users_group_remove_policy

Remove a policy from a user group.

Important

Deprecated in versions 2.7 and greater. Please use users_group_settings_remove instead.

  • Parameters:

    • group_id (string): User Group ID.
    • rule (string): Policy/Rule. Valid values are:
      • canUseAdminPanel
      • viewServers
      • manageServers
      • viewSharedFolders
      • manageSharedFolders
      • viewUsers
      • manageUsers
      • viewUsersGroups
      • manageUsersGroups
      • viewApplications
      • manageApplications
      • viewApplicationsGroups
      • manageApplicationsGroups
      • viewPublications
      • managePublications
      • viewConfiguration
      • manageConfiguration
      • viewStatus
      • manageSession
      • manageReporting
      • viewSummary
      • manageScripts
      • viewScripts
      • manageScriptsGroups
      • viewScriptsGroups
  • Response (boolean): A success or failure.

users_group_remove_script

Remove a script from a user group.

  • Parameters:

    • script (string): Script ID.
    • group (string): User Group ID.
  • Response (boolean): A success or failure.

users_group_remove_user

Remove a user from a user group.

  • Parameters:

    • user_id (string): User Login.
    • group_id (string): User Group ID.
  • Response (boolean): A success or failure.

users_group_settings_remove

Remove user group settings.

  • Parameters:

    • group_id (string): User Group ID.
    • container (string): Container. This is the name of the settings section you are configuring.
    • setting (string): Setting.
  • Response (boolean): A success or failure.

users_group_settings_set

Configure user group settings.

  • Parameters:

    • group_id (string): User Group ID.
    • container (string): Container. This is the name of the settings section you are configuring.
    • setting (string): Setting.
    • value (any): Value.
  • Response (boolean): A success or failure.

users_groups_list_partial

Fetch a list of user groups.

  • Parameters:

    • search (string or null): Search item is the value of the attribute specified in the search field parameter.
    • search_fields (list or null): Search field is the user group attribute to search through. Possible values are:
      • name
      • description
    • user_login (string): User Login. Search only in user groups this user is in. Set to null if this option is not required.
  • Response (list): A list of two items:

    • partial (boolean) - refers to whether all results were returned or not. The number of results returned will not exceed the maximum value set in for max_results_per_page in general settings.
    • data (list) - a key-value list where the keys are user group ids and the values are user group objects that contain the following attributes:
      • id (integer)
      • name (string)
      • description (string)
      • published (boolean)
      • type (string)
      • default (boolean)

users_list_partial

Fetch a list of users.

  • Parameters:

    • search (string): Search item is the value of the attribute specified in the search field parameter. Leave blank to retrieve all results.
    • search_fields (list): Search field is the user attribute to search through. Possible values are:
      • login
      • displayname
    • search_user (string): User Group ID. Search for users within this user group. Set to null if this option is not required.
  • Response (list): A list of two items:

    • partial (boolean) - refers to whether all results were returned or not. The number of results returned will not exceed the maximum value set in for max_results_per_page in general settings.
    • data (list) - a key-value list where the keys are user logins and the values are user objects that contain the following attributes:
      • login (integer)
      • displayname (string)

users_populate

Populate the system with default users.

  • Parameters:

    • override (boolean): Set this to true if you have already populated the system with default users and you are now changing their passwords. To override default values, set to false.
    • password (string or null): The password for your default users. It is set to the user's login by default.
  • Response (boolean): A success or failure.

users_profiles_list

Fetch a list of all user profiles.

  • Parameters: N/A

  • Response (object): A list with profile ids as keys and profile objects as values. The profile objects contain the following attributes:

    • id (string)
    • server (string)
    • status (string)
    • users (object): a list for which the keys are user logins and the values are user display names.

users_profiles_list_partial

Fetch a partial list of user profiles.

  • Parameters:

    • user (string): Login name. User profiles will be returned for any user logins that fully or partially match this value. Set to null if this option is not required.
  • Response (list): A list of two items:

    • partial (boolean) - refers to whether all results were returned or not. The number of results returned will not exceed the maximum value set in for max_results_per_page in general settings.
    • data (list) - a key-value list where the keys are user logins and the values are user objects that contain the following attributes:
      • login (integer)
      • displayname (string)