D.47. tarantella object new_xapp

Creates one or more X application objects. See Section C.1.15, “X Application Object”.


tarantella object new_xapp {
   --name obj
   --width pixels
   --height pixels 
 [ --description text ]
 [ --app pathname ]
 [ --args args ]
 [ --appserv obj... ]
 [ --method telnet|ssh ]
 [ --resumable never|session|always ]
 [ --endswhen lastclient|windowmanager|windowmanageralone|
nowindows|loginscript|loginscriptnowindows ]
 [ --maxinstances 0|instances ]
 [ --displayusing clientwm|independent|kiosk ]
 [ --xrandr true|false ]
 [ --variablerootsize true|false ]
 [ --maximize true|false ]
 [ --scalable true|false ]
 [ --depth 8|16|24|16/8|24/8|8/16|8/24 ]
 [ --icon icon_name ]
 [ --hints hint...]
 [ --clipboardlevel level ]
 [ --roottype default|custom ]
 [ --rootcolor color ]
 [ --compression automatic|on|off ]
 [ --execution automatic|inorder|optimized ]
 [ --quality automatic|best|24|21|18|16|15|12|9|6 ]
 [ --interlaced automatic|on|off ]
 [ --accel true|false ]
 [ --delayed true|false ]
 [ --ldapusers user_dn... ]
 [ --ldapgroups group_dn... ]
 [ --ldapsearch search_string... ]
 [ --loadbal default|cpu|memory|sessions ]
 [ --env setting... ]
 [ --login script ]
 [ --winmgr command... ]
 [ --resumetimeout mins ]
 [ --middlemouse ms ]
 [ --force3button true|false ]
 [ --windowclose notifyapp|killapp|suspendsession|endsession ]
 [ --dpi monitordpi ]
 [ --keepopen true|false ]
 [ --share true|false ]
 [ --securityextension true|false ]
 [ --ssharguments args ]
 [ --unixaudiopreload true|false ]
 [ --remotewindowkeys true|false ]
 [ --allowkioskescape true|false ]
 [ --allowsshdowngrade true|false ]
 } | --file file


The following table shows the available options for this command.



More Information


The common name of the object in the SGD datastore.

Section C.2.84, “Name”


The width of the application, in pixels.

Section C.2.126, “Window Size: Width”


The height of the application, in pixels.

Section C.2.120, “Window Size: Height”


A text description of the object.

Section C.2.29, “Comment”


Full path name of the application.

Section C.2.4, “Application Command”


The command-line arguments to use when starting the application.

Section C.2.11, “Arguments for Command”


The application servers that can run the application.

Section C.2.60, “Hosting Application Servers Tab”


The mechanism used by the SGD server to access the application server and start the application.

Section C.2.31, “Connection Method”


Resumability behavior for the application.

Section C.2.6, “Application Resumability”


When the application session ends.

Section C.2.98, “Session Termination”


The maximum number of instances of the application a user can run simultaneously.

Section C.2.85, “Number of Sessions”


How the application is displayed to the user.

Section C.2.127, “Window Type”


Enables the RANDR X extension.

Section C.2.124, “Window Size: RandR Extension”


Resize the root window to match the size of the user's screen.

Section C.2.123, “Window Size: Variable Root Window Size”


The initial size of the application.

Section C.2.118, “Window Size: Client's Maximum Size”


Scale the application to fit the window in which it is displayed.

Section C.2.125, “Window Size: Scale to Fit Window”


Color depth for the application.

Section C.2.24, “Color Depth”


Webtop icon for the application.

Section C.2.61, “Icon”


String containing additional name-value data for the application.

Section C.2.58, “Hints”


Clipboard security level for the application.

Section C.2.36, “Copy and Paste: Application's Clipboard Security Level”


Appearance of the root window.

Section C.2.114, “Window Color”


Color of the root window.

Section C.2.115, “Window Color: Custom Color”


Whether the AIP protocol compresses commands for transmission.

Section C.2.27, “Command Compression”


Whether the AIP protocol always executes commands in order, or optimizes commands for performance reasons.

Section C.2.28, “Command Execution”


The effective color depth displayed on client devices.

Section C.2.26, “Color Quality”


Enables interlaced image transmission.

Section C.2.63, “Interlaced Images”


Enables graphics acceleration for the application's display.

Section C.2.57, “Graphics Acceleration”


Enables delayed updates of the application's display.

Section C.2.41, “Delayed Updates”


Assigns the application to the specified LDAP users.

Section C.2.13, “Assigned User Profiles Tab”


Assigns the application to the specified LDAP groups.

Section C.2.13, “Assigned User Profiles Tab”


Assigns the application to the users that match the LDAP search criteria.

Section C.2.13, “Assigned User Profiles Tab”


Load balancing algorithm to use.

Section C.2.5, “Application Load Balancing”


Environment variable settings needed to run the application.

Section C.2.48, “Environment Variables”


The login script used to start the application.

Section C.2.73, “Login Script”


The Window Manager to use for the application.

Section C.2.117, “Window Manager”


Number of minutes the application is resumable for.

Section C.2.7, “Application Resumability: Timeout”


Timeout for emulating a middle mouse button click using a two-button mouse.

Section C.2.81, “Middle Mouse Timeout”


Specifies that the application only supports a 3-button mouse.

Section C.2.83, “Mouse”


Effect on application session of closing the main application window.

Section C.2.113, “Window Close Action”


Monitor resolution that SGD reports to X applications.

Section C.2.82, “Monitor Resolution”


Keep open the connection used to start the application.

Section C.2.64, “Keep Launch Connection Open”


Enables resource sharing for similar application sessions.

Section C.2.100, “Share Resources Between Similar Sessions”


Enables the X Security Extension for the application.

Section C.2.130, “X Security Extension”


Command-line arguments for the ssh client.

Section C.2.33, “Connection Method: SSH Arguments”


Enables the SGD audio redirection library.

Section C.2.15, “Audio Redirection Library”


Sends window management key strokes to the remote session.

Section C.2.116, “Window Management Keys”


Enables a pull-down header for kiosk mode applications.

Section C.2.67, “Kiosk Mode Escape”


Enables SGD to try an X11 connection instead of SSH, when X11 forwarding is not configured or working.

Section C.2.2, “Allow SSH Downgrade”


Batch file used to create multiple objects within the organizational hierarchy.


To batch-create multiple objects, use the --file option. Use the other options to create a single object.


The following example creates a new X application object for the application XFinance. The application can be run on the application servers paris, bonn, or lisbon. Application server load balancing decides which one to use.

$ tarantella object new_xapp \
--name "o=applications/ou=Finance/cn=XFinance" \
--width 1000  --height 800 \
--app /usr/local/bin/xfinance \
--appserv "o=appservers/ou=Finance/cn=paris" \
"o=appservers/ou=Finance/cn=bonn" "o=appservers/cn=lisbon"