Exit Print View

Oracle Secure Global Desktop Administration Guide for Version 4.6

Document Information

Preface

1.  Networking and Security

2.  User Authentication

3.  Publishing Applications to Users

4.  Configuring Applications

5.  Client Device Support

6.  SGD Client and Webtop

7.  SGD Servers, Arrays, and Load Balancing

A.  Global Settings and Caches

B.  Secure Global Desktop Server Settings

C.  User Profiles, Applications, and Application Servers

D.  Commands

The tarantella Command

Syntax

Description

Examples

The tarantella archive Command

Syntax

Description

Examples

The tarantella array Command

Syntax

Description

Examples

tarantella array add_backup_primary

tarantella array clean

tarantella array detach

tarantella array edit_backup_primary

tarantella array join

tarantella array list

tarantella array list_backup_primaries

tarantella array make_primary

tarantella array remove_backup_primary

The tarantella cache Command

Syntax

Description

Examples

The tarantella config Command

Syntax

Description

Examples

tarantella config edit

tarantella config list

The tarantella emulatorsession Command

Syntax

Description

Examples

tarantella emulatorsession list

tarantella emulatorsession info

tarantella emulatorsession shadow

tarantella emulatorsession suspend

tarantella emulatorsession end

The tarantella help Command

Syntax

Description

Examples

The tarantella object Command

Syntax

Description

Examples

tarantella object add_host

tarantella object add_link

tarantella object add_mapping

tarantella object add_member

tarantella object delete

tarantella object edit

tarantella object list_attributes

tarantella object list_contents

tarantella object new_3270app

tarantella object new_5250app

tarantella object new_charapp

tarantella object new_container

tarantella object new_dc

tarantella object new_doc

tarantella object new_dynamicapp

tarantella object new_group

tarantella object new_host

tarantella object new_org

tarantella object new_orgunit

tarantella object new_person

tarantella object new_windowsapp

tarantella object new_xapp

tarantella object remove_host

tarantella object remove_link

tarantella object remove_mapping

tarantella object remove_member

tarantella object rename

tarantella object script

The tarantella passcache Command

Syntax

Description

Examples

tarantella passcache delete

tarantella passcache edit

tarantella passcache list

tarantella passcache new

The tarantella print Command

Syntax

Description

Examples

tarantella print cancel

tarantella print list

tarantella print move

tarantella print pause

tarantella print resume

tarantella print start

tarantella print status

tarantella print stop

The tarantella query Command

Syntax

Description

Examples

tarantella query audit

tarantella query billing

tarantella query errlog

tarantella query uptime

The tarantella restart Command

Syntax

Description

Examples

tarantella restart sgd

tarantella restart webserver

The tarantella role Command

Syntax

Description

Examples

tarantella role add_link

tarantella role add_member

tarantella role list

tarantella role list_links

tarantella role list_members

tarantella role remove_link

tarantella role remove_member

The tarantella security Command

Syntax

Description

Examples

tarantella security certinfo

tarantella security certrequest

tarantella security certuse

tarantella security customca

tarantella security decryptkey

tarantella security disable

tarantella security enable

tarantella security fingerprint

tarantella security peerca

tarantella security selfsign

tarantella security start

tarantella security stop

The tarantella service Command

Syntax

Description

Examples

tarantella service delete

tarantella service edit

tarantella service list

tarantella service new

The tarantella setup Command

Syntax

Description

Examples

The tarantella start Command

Syntax

Description

Examples

tarantella start cdm

tarantella start sgd

tarantella start webserver

The tarantella status Command

Syntax

Description

Examples

The tarantella stop Command

Syntax

Description

Examples

tarantella stop cdm

tarantella stop sgd

tarantella stop webserver

The tarantella tokencache Command

Syntax

Description

Examples

tarantella tokencache delete

tarantella tokencache list

The tarantella tscal Command

Syntax

Description

Examples

tarantella tscal free

tarantella tscal list

tarantella tscal return

The tarantella uninstall Command

Syntax

Description

Examples

The tarantella version Command

Syntax

Description

Examples

The tarantella webserver Command

Syntax

Description

Examples

tarantella webserver add_trusted_user

tarantella webserver delete_trusted_user

tarantella webserver list_trusted_users

The tarantella webtopsession Command

Syntax

Description

Examples

tarantella webtopsession list

tarantella webtopsession logout

E.  Login Scripts

F.  Third-Party Legal Notices

Glossary

Index

The tarantella object Command

The tarantella object command enables you to create, list, edit, and delete objects in the organizational hierarchy. You can also add and remove assigned applications links, configure application server load balancing for each application, and add and remove group members.

Syntax

tarantella object add_host | add_link | add_mapping | add_member | 
delete | edit | list_attributes | list_contents | new_3270app |
new_5250app | new_charapp | new_container | new_dc | new_doc |
new_dynamicapp | new_group | new_host | new_org | new_orgunit |
new_person | new_windowsapp | new_xapp | remove_host | 
remove_link | remove_mapping | remove_member | rename | script

Description

The following table shows the available subcommands for this command.

Subcommand
Description
More Information
add_host
Adds application servers to the list of those that can run an application.
add_link
Adds assigned applications links.
add_mapping
Adds mappings to a dynamic application.
add_member
Adds members to a group.
delete
Permanently deletes objects from the organizational hierarchy.
edit
Edits attributes for an object.
list_attributes
Lists attributes of an object.
list_contents
Lists the contents of an OU or an organization.
new_3270app
Creates 3270 application objects.
new_5250app
Creates 5250 application objects.
new_charapp
Creates character application objects.
new_container
Creates Active Directory container objects.
new_dc
Creates domain component objects.
new_doc
Creates document objects.
new_dynamicapp
Creates dynamic application objects.
new_group
Creates group objects.
new_host
Creates application server objects.
new_org
Creates organization objects.
new_orgunit
Creates organizational unit objects.
new_person
Creates user profile objects.
new_windowsapp
Creates Windows application objects.
new_xapp
Creates X application objects.
remove_host
Removes application servers from those that can run an application.
remove_link
Removes assigned applications links.
remove_mapping
Removes mappings for a dynamic application.
remove_member
Removes members from groups.
rename
Renames or moves an object.
script
Runs a batch script of object commands.

Note - All commands include a --help option. You can use tarantella object subcommand --help to get help on a specific command.


Examples

The following example lists the objects that belong to the organizational unit Sales.

$ tarantella object list_contents \
--name "o=Indigo Insurance/ou=Sales"

tarantella object add_host

Adds application servers to the list of those that can run an application, for application server load balancing.

Syntax
tarantella object add_host { --name obj...
                             --host hobj...
                           } | --file file
Description

The following table shows the available options for this command.

Option
Description
--name
The names of application objects you want to configure load balancing for.
--host
The names of application server objects you want to add to the load balancing pool.
--file
A file containing a batch of commands to configure application server load balancing.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example adds the application server rome to the load balancing pool for the application Slide-o-Win.

$ tarantella object add_host \
--name "o=applications/cn=Slide-o-Win" \
--host "o=appservers/ou=Sales/cn=rome"

The following example adds the group WinHosts to the load balancing pool for the applications Write-o-Win and Slide-o-Win. Load balancing is performed across all the application servers in WinHosts.

$ tarantella object add_host \
--name "o=applications/cn=Write-o-Win" \
"o=applications/cn=Slide-o-Win" \
--host "o=appservers/cn=WinHosts"

tarantella object add_link

Adds assigned applications links for an object.

Syntax
tarantella object add_link { --name obj...
                             --link lobj...
                           } | --file file
Description

The following table shows the available options for this command.

Option
Description
--name
The names of objects you want to add assigned applications links for.
--link
The names of assigned applications links you want to add.
--file
A file containing a batch of commands to add assigned applications links.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example adds the Write-o-Win application to Violet Carson’s assigned applications.

$ tarantella object add_link \
--name "o=Indigo Insurance/ou=Sales/cn=Violet Carson" \
--link "o=applications/cn=Write-o-Win"

The following example adds the group Applications to the assigned applications of the organizational units Sales and Marketing. Everyone who inherits assigned applications from one of these OUs, for example, they belong to that OU and Inherit Assigned Applications from Parent is selected for their user profile object, sees all the applications in the group in their assigned applications.

$ tarantella object add_link \
--name "o=Indigo Insurance/ou=Sales" \
--name "o=Indigo Insurance/ou=Marketing" \
--link "o=applications/cn=Applications"

tarantella object add_mapping

Adds mappings for a dynamic application object. See Dynamic Application Object.

Syntax
tarantella object add_mapping { --name obj
                                --mapping [type=application]
                              } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The name of a dynamic application object.
--mapping
A mapping between a type and the name of an application object.
--file
A file containing a batch of commands to add mappings.

When you add a mapping, the applications that are mapped must already exist.


Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example adds a windows type mapping to the winApp dynamic application object.

$ tarantella object add_mapping \
--name "o=applications/cn=winApp" \
--mapping windows="o=applications/cn=windows_desktop" 

The following example adds a solaris type mapping to the desktopApp dynamic application object.

$ tarantella object add_mapping \
--name "o=applications/cn=desktopApp" \
--mapping solaris="o=applications/cn=solaris_desktop"

tarantella object add_member

Adds objects to groups.

Syntax
tarantella object add_member { --name obj...
                               --member mobj...
                             } | --file file
Description

The following table shows the available options for this command.

Option
Description
--name
Specifies the names of group objects you want to add members for.
--member
Specifies the names of objects you want to add to the groups.
--file
Specifies a file containing a batch of commands to add group members.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example adds the Write-o-Win application to the group Applications.

$ tarantella object add_member \
--name "o=applications/cn=Applications" \
--member "o=applications/cn=Write-o-Win"

The following example adds the three application server objects rome, brussels, and berlin to the group WinHosts. This group can be added to an application’s Hosting Application Servers Tab to perform load balancing between the application servers. From the command line, use tarantella object add_host.

$ tarantella object add_member \
--name "o=appservers/cn=WinHosts" \
--member "o=appservers/ou=Sales/cn=rome" \
--member "o=appservers/cn=brussels" \
--member "o=appservers/ou=Marketing/cn=berlin"

tarantella object delete

Permanently deletes objects from the organizational hierarchy.

Syntax
tarantella object delete { --name obj [ --children ] } | --file file
Description

The following table shows the available options for this command.

Option
Description
--name
Specifies the name of the object you want to delete.
--children
When deleting organizational units, Active Directory containers or domain components, confirms that you want to delete the object and all objects that belong to it, recursively. As a safeguard, it is impossible to delete an organizational unit, Active Directory container or domain component without specifying --children.
--file
Specifies a file containing a batch of commands to delete objects.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example removes the user profile object for Violet Carson.

$ tarantella object delete \
--name "o=Indigo Insurance/ou=Sales/cn=Violet Carson"

The following example deletes the organizational unit Sales.

$ tarantella object delete \
--name "o=Indigo Insurance/ou=Sales" \
--children

tarantella object edit

Edits the attributes of an object in the organizational hierarchy.

Syntax
tarantella object edit { --name obj 
                       { --attribute [value] }...
                       } | --file file
Description

The following table shows the available options for this command.

Option
Description
--name
Specifies the name of the object you want to edit the attributes of.
{--attribute [value]}...
Specifies the attribute names you want to edit, and their new values. The valid attributes depend on the type of object. See the tarantella object new_object_type documentation for the appropriate list. For example, when editing attributes for an application object you can specify --displayusing to edit the Window Type attribute. If you omit value for an attribute, it is deleted from the object.
--file
Specifies a file containing a batch of commands to edit attributes.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example changes the Inherit Assigned Applications from Parent attribute for the organizational unit Sales.

$ tarantella object edit \
--name "o=Indigo Insurance/ou=Sales" \
--inherit false

tarantella object list_attributes

Lists the attributes of an object in the organizational hierarchy.

Syntax
tarantella object list_attributes { --name obj
                                    [ --attribute... ]
                                  } | --file file
Description

The following table shows the available options for this command.

Option
Description
--name
Specifies the name of the object you want to list the attributes of.
{--attribute [value]}...
Specifies the attribute names you want to list. The valid attributes depend on the type of object. See the tarantella object new_object_type documentation for the appropriate list. For example, when listing attributes for an application object you can specify --displayusing to edit the Window Type attribute.
--file
Specifies a file containing a batch of commands to list attributes.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example lists all attributes for the Sales organizational unit.

$ tarantella object list_attributes \
--name "o=Indigo Insurance/ou=Sales"

The following example lists the Email Address and Login attributes for the user profile object for Rusty Spanner.

$ tarantella object list_attributes \
--name "o=Indigo Insurance/ou=IT/cn=Rusty Spanner" \
--email --enabled

tarantella object list_contents

Lists the objects that belong to a particular object in the organizational hierarchy.

Syntax
tarantella object list_contents { --name obj }| --file file
Description

The following table shows the available options for this command.

Option
Description
--name
Specifies the name of the object you want to list the contents of.
--file
Specifies a file containing a batch of commands to list object contents.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example lists all the objects within the organizational unit Sales.

$ tarantella object list_contents \
--name "o=Indigo Insurance/ou=Sales"

tarantella object new_3270app

Creates one or more 3270 application objects. See 3270 Application Object.

Syntax
tarantella object new_3270app {
  --name obj
  --width pixels
 --height pixels 
[ --description text ]
[ --args args ]
[ --method rexec|telnet|ssh ]
[ --resumable never|session|always ]
[ --endswhen lastclient|windowmanager|windowmanageralone|
nowindows|loginscript|loginscriptnowindows ]
[ --maxinstances 0|instances ]
[ --displayusing clientwm|independent|kiosk|localx ]
[ --maximize true|false ]
[ --scalable true|false ]
[ --icon icon_name ]
[ --hints hint...]
[ --hostname host ]
[ --portnumber tcp ]
[ --3270tnclose 0|1|2|3 ]
[ --3270kt pc|sun4|sun5|hp ]
[ --3270bl 0|1|2|3|4 ]
[ --3270ma true|false ]
[ --3270mb true|false ]
[ --3270si true|false ]
[ --3270fg color ]
[ --3270bg color ]
[ --roottype default|custom ]
[ --rootcolor color ]
[ --compression automatic|on|off ]
[ --execution automatic|inorder|optimized ]
[ --interlaced automatic|on|off ]
[ --accel true|false ]
[ --delayed true|false ]
[ --ldapusers user_dn... ]
[ --ldapgroups group_dn... ]
[ --ldapsearch search_string... ]
[ --env setting... ]
[ --login script ]
[ --winmgr command... ]
[ --resumetimeout mins ]
[ --middlemouse ms
[ --windowclose notifyapp|killapp|suspendsession|endsession ]
[ --euro unicode|iso8859-15 ]
[ --dpi monitordpi ]
[ --keepopen true|false ]
[ --lockkeymap true|false ]
[ --ssharguments args ]
[ --share true|false ]
} | --file file
Description

SGD uses the third-party TeemTalk for Unix emulator for 3270 applications. See the TeemTalk for Unix User’s Guide supplied with SGD for details.

The following table shows the available options for this command.

Option
Description
More Information
--name
The common name of the object in the SGD datastore.
--width
The width of the application, in pixels.
--height
The height of the application, in pixels.
--description
A text description of the object.
--args
The command-line arguments to use when starting the application.
--method
The mechanism used by the SGD server to access the application server and start the application.
--resumable
Resumability behavior for the application.
--endswhen
When the application session ends.
--maxinstances
The maximum number of instances of the application a user can run simultaneously.
--displayusing
How the application is displayed to the user.
--maximize
The initial size of the application.
--scalable
Scale the application to fit the window in which it is displayed.
--icon
Webtop icon for the application.
--hints
String containing additional name-value data for the application.
--hostname
The 3270 host that runs the application.
--portnumber
The Transmission Control Protocol (TCP) port number used to connect to the 3270 host.
--3270tnclose
Behavior when telnet connection to the 3270 host is closed.
--3270kt
Layout to use for mapping the keyboard to the terminal being emulated.
--3270bl
Number of “soft button” levels to display.
--3270ma
Maximizes the emulator window.
--3270mb
Enables the application’s menu bar.
--3270si
Enables the File and Settings menu items.
--3270fg
Text color in the application’s text window.
--3270bg
Background color of the application’s text window.
--roottype
Appearance of the root window.
--rootcolor
Color of the root window.
--compression
Whether the Adaptive Internet Protocol (AIP) protocol compresses commands for transmission.
--execution
Whether the AIP protocol always executes commands in order, or optimizes commands for performance reasons.
--interlaced
Enables interlaced image transmission.
--accel
Enables graphics acceleration for the application’s display.
--delayed
Enables delayed updates of the application’s display.
--ldapusers
Assigns the application to the specified LDAP users.
--ldapgroups
Assigns the application to the specified LDAP groups.
--ldapsearch
Assigns the application to the users that match the LDAP search criteria.
--env
Environment variable settings needed to run the application.
--login
The login script used to start the application.
--winmgr
The Window Manager to use for the application.
--resumetimeout
Number of minutes the application is resumable for.
--middlemouse
Timeout for emulating a middle mouse button click using a two-button mouse.
--windowclose
Effect on application session of closing the main application window.
--euro
Keycode mapping required by the application to support the euro character.
--dpi
Monitor resolution that SGD reports to X applications.
--keepopen
Keep open the connection used to start the application.
--lockkeymap
Prevents applications from changing keyboard mappings.
--share
Enables resource sharing for similar application sessions.
--ssharguments
Command-line arguments for the ssh client.
--file
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.

Examples

The following example creates a new 3270 application object for the application 3270cat. The emulator connects to the 3270 host warsaw.indigo-insurance.com.

$ tarantella object new_3270app \
--name "o=applications/ou=Finance/cn=3270cat" \
--width 1000 --height 800 \ 
--app /3270cat \
--hostname warsaw.indigo-insurance.com

tarantella object new_5250app

Creates one or more 5250 application objects. See 5250 Application Object.

Syntax
tarantella object new_5250app {
  --name obj
  --width pixels
  --height pixels 
[ --description text ]
[ --args args ]
[ --method telnet|ssh ]
[ --resumable never|session|always ]
[ --endswhen lastclient|windowmanager|windowmanageralone|
nowindows|loginscript|loginscriptnowindows ]
[ --maxinstances 0|instances ]
[ --displayusing clientwm|independent|kiosk|localx ]
[ --maximize true|false ]
[ --scalable true|false ]
[ --icon icon_name ]
[ --hints hint...]
[ --hostname host ]
[ --portnumber tcp ]
[ --tnclose 0|1|2|3 ]
[ --kt pc|sun4|sun5|hp ]
[ --bl 0|1|2|3|4 ]
[ --ma true|false ]
[ --mb true|false ]
[ --si true|false ]
[ --fg color ]
[ --bg color ]
[ --roottype default|custom ]
[ --rootcolor color ]
[ --compression automatic|on|off ]
[ --execution automatic|inorder|optimized ]
[ --interlaced automatic|on|off ]
[ --accel true|false ]
[ --delayed true|false ]
[ --ldapusers user_dn... ]
[ --ldapgroups group_dn... ]
[ --ldapsearch search_string... ]
[ --env setting... ]
[ --login script ]
[ --winmgr command... ]
[ --resumetimeout mins ]
[ --middlemouse ms ]
[ --windowclose notifyapp|killapp|suspendsession|endsession ]
[ --euro unicode|iso8859-15 ]
[ --dpi monitordpi ]
[ --keepopen true|false ]
[ --lockkeymap true|false ]
[ --share true|false ]
[ --ssharguments args ]
} | --file file
Description

SGD uses the third-party TeemTalk for Unix emulator for 5250 applications. See the TeemTalk for Unix User’s Guide supplied with SGD for details.

The following table shows the available options for this command.

Option
Description
More Information
--name
The common name of the object in the SGD datastore.
--width
The width of the application, in pixels.
--height
The height of the application, in pixels.
--description
A text description of the object.
--args
The command-line arguments to use when starting the application.
--method
The mechanism used by the SGD server to access the application server and start the application.
--resumable
Resumability behavior for the application.
--endswhen
When the application session ends.
--maxinstances
The maximum number of instances of the application a user can run simultaneously.
--displayusing
How the application is displayed to the user.
--maximize
The initial size of the application.
--scalable
Scale the application to fit the window in which it is displayed.
--icon
Webtop icon for the application.
--hints
String containing additional name-value data for the application.
--hostname
The AS/400 host that runs the application.
--portnumber
The TCP port number used to connect to the AS/400 host.
--tnclose
Behavior when telnet connection to the AS/400 host is closed.
--kt
Layout to use for mapping the keyboard to the terminal being emulated.
--bl
Number of “soft button” levels to display.
--ma
Maximizes the emulator window.
--mb
Enables the application’s menu bar.
--si
Enables the File and Settings menu items.
--fg
Text color in the application’s text window.
--bg
Background color of the application’s text window.
--roottype
Appearance of the root window.
--rootcolor
Color of the root window.
--compression
Whether the AIP protocol compresses commands for transmission.
--execution
Whether the AIP always executes commands in order, or optimizes commands for performance reasons.
--interlaced
Enables interlaced image transmission.
--accel
Enables graphics acceleration for the application’s display.
--delayed
Enables delayed updates of the application’s display.
--ldapusers
Assigns the application to the specified LDAP users.
--ldapgroups
Assigns the application to the specified LDAP groups.
--ldapsearch
Assigns the application to the users that match the LDAP search criteria.
--env
Environment variable settings needed to run the application.
--login
The login script used to start the application.
--winmgr
The Window Manager to use for the application.
--resumetimeout
Number of minutes the application is resumable for.
--middlemouse
Timeout for emulating a middle mouse button click using a two-button mouse.
--windowclose
Effect on application session of closing the main application window.
--euro
Keycode mapping required by the application to support the euro character.
--dpi
Monitor resolution that SGD reports to X applications.
--keepopen
Keep open the connection used to start the application.
--lockkeymap
Prevents applications from changing keyboard mappings.
--share
Enables resource sharing for similar application sessions.
--ssharguments
Command-line arguments for the ssh client.
--file
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.

Examples

The following example creates a new 5250 application object for the application 5250cat. The emulator runs on the application server prague, and connects to the AS/400 host warsaw.indigo-insurance.com.

$ tarantella object new_5250app \
--name "o=applications/ou=Finance/cn=5250cat" \
--width 400 --height 300 \
--app /5250cat \
--appserv "o=appservers/cn=prague" \
--hostname warsaw.indigo-insurance.com

tarantella object new_charapp

Creates one or more character application objects. See Character Application Object.

Syntax
tarantella object new_charapp {
   --name obj
   --emulator scocon|vt420|wyse60
   --termtype type
   --width pixels
   --height pixels
 [ --description text ]
 [ --app pathname ]
 [ --args args ]
 [ --appserv obj... ]
 [ --method telnet|ssh ]
 [ --resumable never|session|always ]
 [ --maxinstances 0|instances ]
 [ --displayusing independent|kiosk ]
 [ --maximize true|false ]
 [ --cols cols ]
 [ --lines lines ]
 [ --icon icon_name ]
 [ --hints hint...]
 [ --font courier|helvetica|timesroman ]
 [ --fontsize points ]
 [ --fixedfont true|false ]
 [ --autowrap true|false ]
 [ --cursor off|block|underline ]
 [ --statusline none|indicator|hostmessages|standard|extended ]
 [ --scrollstyle line|multiple|smooth ]
 [ --border normal|indented|raised ]
 [ --answermsg message ]
 [ --appkeymode true|false ]
 [ --keypad numeric|application ]
 [ --cursorkeys application|cursor ]
 [ --escape 7-bit|8-bit ]
 [ --codepage 437|850|852|860|863|865|8859-1|8859-2|
 Multinational|Mazovia|CP852 ]
 [ --ldapusers user_dn... ]
 [ --ldapgroups group_dn... ]
 [ --ldapsearch search_string... ]
 [ --loadbal default|cpu|memory|sessions ]
 [ --compression automatic|on|off ]
 [ --env setting... ]
 [ --login script ]
 [ --keymap keymap ]
 [ --attributemap attrmap ]
 [ --colormap colormap ]
 [ --resumetimeout mins ]
 [ --windowclose suspendsession|endsession ]
 [ --ssharguments args ]
 } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The common name of the object in the SGD datastore.
--emulator
The type of emulation required for the application.
--termtype
The terminal type required for the application.
--width
The width of the application, in pixels.
--height
The height of the application, in pixels.
--description
A text description of the object.
--app
Full path name of the application.
--args
The command-line arguments to use when starting the application.
--appserv
The application servers that can run the application.
--method
The mechanism used by the SGD server to access the application server and start the application.
--resumable
Resumability behavior for the application.
--maxinstances
The maximum number of instances of the application a user can run simultaneously.
--displayusing
How the application is displayed to the user.
--maximize
The initial size of the application.
--cols
The number of columns in the terminal window.
--lines
The number of lines in the terminal window.
--icon
Webtop icon for the application.
--hints
String containing additional name-value data for the application.
--font
Determines the font family used within the terminal window for the application
--fontsize
Defines the font size in the terminal window.
--fixedfont
Uses the font size specified by --fontsize for the terminal window.
--autowrap
Determines the behavior when a user types characters extending beyond the right edge of the terminal window.
--cursor
Cursor style used for the application.
--statusline
Specifies the type of status line.
--scrollstyle
The scroll behavior of the terminal window.
--border
The border style for the terminal window.
--answermsg
Defines the message to return when an inquiry is sent from the application server to the emulator.
--appkeymode
Determines whether the application can change the codes generated by keys on the keyboard.
--keypad
Specifies the behavior of the cursor keys.
--cursorkeys
Specifies the behavior of the cursor keys.
--escape
Specifies how escape sequences are sent from the emulator to the application server.
--codepage
The code page to use for the emulator.
--ldapusers
Assigns the application to the specified LDAP users.
--ldapgroups
Assigns the application to the specified LDAP groups.
--ldapsearch
Assigns the application to the users that match the LDAP search criteria.
--loadbal
Load balancing algorithm to use.
--compression
Whether the AIP protocol compresses commands for transmission.
--env
Environment variable settings needed to run the application.
--login
The login script used to start the application.
--keymap
Path name of a keyboard map file.
--attributemap
The attribute map to use for the application.
--colormap
The color map to use for the application.
--resumetimeout
Number of minutes the application is resumable for.
--windowclose
Effect on application session of closing the main application window.
--ssharguments
Command-line arguments for the ssh client.
--file
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.

Examples

The following example creates a character application object for the application Pers-o-dat. The application can be run on the application servers prague and london. Application server load balancing decides which application server to use.

$ tarantella object new_charapp \
--name "o=applications/cn=Pers-o-dat" \
--emulator vt420 --termtype vt220 \
--width 400 --height 300 \ 
--app /bin/persodat \
--appserv "o=appservers/cn=prague" \
"o=appservers/ou=IT/cn=london"

tarantella object new_container

Creates one or more Active Directory container objects. See Directory (Light): Active Directory Container Object.

Syntax
tarantella object new_container { --name obj } | --file file
Description

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

Examples

The following example creates a new Active Directory container object with name Users, within the indigo-insurance.com domain components.

$ tarantella object new_container \
--name "dc=com/dc=indigo-insurance/cn=Users"

The following example creates two Active Directory container objects using a batch script defined as a “here-document”. You can alternatively store the batch script in a file, and reference it using --file filename.

$ tarantella object new_container --file - <<EOF
--name "dc=com/dc=indigo-insurance/cn=Users"
--name "dc=com/dc=indigo-insurance/cn=Applications"
EOF

tarantella object new_dc

Creates one or more domain component objects. See Directory (Light): Domain Component Object.

Syntax
tarantella object new_dc { --name obj } | --file file
Description

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

Examples

The following example creates a new domain component object with name com, at the top level of the organizational hierarchy.

$ tarantella object new_dc --name "dc=com"

The following example creates two domain component objects using a batch script defined as a “here-document”. You can alternatively store the batch script in a file, and reference it using --file filename.

$ tarantella object new_dc --file - <<EOF
--name "dc=com"
--name "dc=com/dc=indigo-insurance"
EOF

tarantella object new_doc

Creates one or more document objects. See Document Object.

Syntax
tarantella object new_doc {
                            --name obj
                            --url url
                          [ --description text ]
                          [ --newbrowser true|false ]
                          [ --icon icon_name ]
                          [ --hints hint...]
                          [ --ldapusers user_dn... ]
                          [ --ldapgroups group_dn... ]
                          [ --ldapsearch search_string... ]
                          } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The name of the document object.
--url
Uniform Resource Locator (URL) displayed when document object link is clicked.
--description
A text description of the object.
--newbrowser
Displays the document in a new browser window.
--icon
Webtop icon for the application.
--hints
String containing additional name-value data for the application.
--ldapusers
Assigns the application to the specified LDAP users.
--ldapgroups
Assigns the application to the specified LDAP groups.
--ldapsearch
Assigns the application to the users that match the LDAP search criteria.
--file
A file containing a batch of commands to configure application server load balancing.

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

Examples

The following example creates a new document object named PhoneList.

$ tarantella object new_doc \
--name "o=applications/ou=Finance/ou=Administration/cn=Phone List" \
--url http://newyork.indigo-insurance.com \
--newbrowser false

The following example creates two document objects using a batch script defined as a “here-document”. You can alternatively store the batch script in a file, and reference it using --file filename.

$ tarantella object new_doc --file - <<EOF
--name "o=applications/ou=Finance/ou=Administration/cn=Phone List"
--url http://newyork.indigo-insurance.com
--newbrowser false
--name "o=applications/cn=Indigo Insurance web site"
--url http://www.indigo-insurance.com
--newbrowser true
EOF

tarantella object new_dynamicapp

Creates one or more dynamic application objects. See Dynamic Application Object.

Syntax
tarantella object new_dynamicapp {
                                  --name obj
                                  --mapping [type=application]
                                [ --description text ]
                                [ --icon icon ]
                                } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The name of the dynamic application.
--mapping
A mapping between a type and the name of an application object.
--description
A text description of the object.
--icon
Webtop icon for the application.
--file
A file containing a batch of commands to create dynamic application objects.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example creates a new dynamic application object named desktopApp, with a mapping for a windows type.

$ tarantella object new_dynamicapp \
--name "o=applications/cn=desktopApp" \
--mapping windows="o=applications/cn=windows_desktop"

tarantella object new_group

Creates one or more group objects. See Group Object.

Syntax
tarantella object new_group {
                              --name obj
                            [ --description text ]
                            [ --member obj... ]
                            [ --ldapusers user_dn... ]
                            [ --ldapgroups group_dn... ]
                            [ --ldapsearch search_string... ]
                            } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The name of the group object.
--description
A text description of the object.
--member
Member of the group object.
--ldapusers
Assigns the application to the specified LDAP users.
--ldapgroups
Assigns the application to the specified LDAP groups.
--ldapsearch
Assigns the application to the users that match the LDAP search criteria.
--file
A file containing a batch of commands to configure application server load balancing.

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

Examples

The following example creates a new group object with common name WinHosts, belonging to the organization object appservers. The group’s members are the application server objects for the application servers rome, brussels, and berlin.

$ tarantella object new_group \
--name "o=appservers/cn=WinHosts" \
--member "o=appservers/ou=Sales/cn=rome" \
--member "o=appservers/cn=brussels" \
--member "o=appservers/ou=Marketing/cn=berlin" 

The following example creates three group objects using a batch script defined as a “here-document”. The groups have no members. You can use tarantella object add_member to add members later from the command line. You can alternatively store the batch script in a file, and reference it using --file filename.

$ tarantella object new_group --file - <<EOF
--name "o=appservers/cn=WinHosts"
--name "o=appservers/cn=UNIXHosts"
--name "o=applications/cn=Applications"
EOF

tarantella object new_host

Creates one or more application server or dynamic application server objects. See Application Server Object and Dynamic Application Server Object.

Syntax

For an application server object, use the following syntax:

tarantella object new_host {
                             --name obj
                           [ --address address ]
                           [ --description text ]
                           [ --ntdomain dom ]
                           [ --available true|false ]
                           [ --auth trytta|nevertrytta|default ]
                           [ --location location ]
                           [ --hostlocale ll_tt ]
                           [ --maxcount count ]
                           [ --userassign spec ]
                           } | --file file

For a dynamic application server object, use the following syntax:

tarantella object new_host {
                             --name obj
                             --dynamic 
                           [ --description text ]
                           [ --auth trytta|nevertrytta|default ]
                           [ --vsbclass classname ]
                           [ --vsbparams params ]
                           } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The names of objects you want to add assigned applications links for.
--address
Network address of the application server.
--dynamic
Create a dynamic application server.
--description
A text description of the object.
--ntdomain
The Windows domain used for application server authentication.
--available
Specifies whether applications can run on this application server.
--auth
Specifies the policy for authenticating users on the application server, if no password is already cached for that server.
--location
String describing the location of the application server. Used for load balancing.
--hostlocale
Default language setting for the application server.
--vsbclass
Fully-qualified class name for the virtual server broker (VSB).

Dynamic application servers only.

--vsbparams
Parameters passed to the VSB.

Dynamic application servers only.

--maxcount
Maximum number of application sessions that can be run concurrently on the application server
--userassign
Specifies the users that can run applications on the application server
--file
A file containing a batch of commands to add assigned applications links.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example creates a new application server object with common name paris, belonging to the organizational unit object Finance, which must already exist.

$ tarantella object new_host \
--name "o=appservers/ou=Finance/cn=paris" \
--address paris.indigo-insurance.com \
--auth default \
--location Europe-north

The following example creates a new dynamic application server object MyBroker that uses the User-defined SGD broker.

$ tarantella object new_host --dynamic \
--name "o=appservers/cn=MyBroker" \
--vsbclass com.sun.sgd.vsbim.UserDefinedSGDBroker 

The following example creates three application server objects using a batch script defined as a “here-document”. Alternatively, you can store the batch script in a file, and reference it using --file filename.

$ tarantella object new_host --file - <<EOF
--name "o=appservers/ou=Finance/cn=paris"
--address paris.indigo-insurance.com
--name "o=appservers/cn=brussels"
--address brussels.indigo-insurance.com
--name "o=appservers/ou=IT/cn=london"
--address london.indigo-insurance.com
EOF

tarantella object new_org

Syntax

Creates one or more organization objects. See Directory: Organization Object.

tarantella object new_org {
                            --name obj 
                          [ --description text ]
                          [ --conntype type_spec... ]
                          [ --cdm drive_spec... ]
                          [ --userprintingconfig true|false ]
                          [ --mapprinters 2|1|0 ]
                          [ --pdfenabled 1|0 ]
                          [ --pdfviewerenabled 1|0 ]
                          [ --pdfdriver driver_name ]
                          [ --pdfisdefault 1|0 ]
                          [ --pdfviewerisdefault 1|0 ]
                          [ --links obj... ]
                          [ --editprofile 2|1|0 ]
                          [ --clipboard 2|1|0 ]
                          [ --serialport 2|1|0 ]
                          } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The name of the organization object in the SGD datastore.
--description
A text description of the object.
--conntype
The connections that are allowed between the client device and the SGD server.
--cdm
The drives on a Microsoft Windows client device that can be accessed from applications running on application servers.
--userprintingconfig
Enables user-specific printing configuration.
--mapprinters
The client printers users can print to when printing from Windows applications.
--pdfenabled
Enables users to print using the SGD “Universal PDF Printer” printer when printing from Windows applications.
--pdfviewerenabled
Enables users to print using the SGD “Universal PDF Viewer” printer when printing from Windows applications.
--pdfdriver
The printer driver to use for SGD Portable Document Format (PDF) printing when printing from Windows applications.
--pdfisdefault
Sets the SGD “Universal PDF Printer” printer as the client’s default printer when printing from Windows applications.
--pdfviewerisdefault
Sets the SGD “Universal PDF Viewer” printer as the client’s default printer when printing from Windows applications.
--links
Defines assigned applications links.
--editprofile
Whether users can create and edit profiles for use with the SGD Client.
--clipboard
Whether users can use copy and paste in Windows or X application sessions.
--serialport
Whether users can access the serial ports on a client device from a Windows application.
--file
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.

Examples

The following example creates a new organization object with name Indigo Insurance. Connections for all users in the organization are secure (SSL-based) unless the OU or user profile objects are configured to give a different type of connection.

$ tarantella object new_org \
--name "o=Indigo Insurance" \
--conntype '*:*:SSL'

The following example creates two organization objects using a batch script defined as a “here-document”. You can alternatively store the batch script in a file, and reference it using --file filename.

$ tarantella object new_org --file - <<EOF
--name "o=Indigo Insurance"
--name "o=Indigo Insurance Services"
EOF

tarantella object new_orgunit

Creates one or more organizational unit (OU) objects. See Directory: Organizational Unit Object.

Syntax
tarantella object new_orgunit {
                                --name obj
                              [ --description text ]
                              [ --inherit true|false ]
                              [ --conntype type_spec... ]
                              [ --cdm drive_spec... ]
                              [ --userprintingconfig 1|0 ]
                              [ --mapprinters 2|1|0 ]
                              [ --pdfenabled 1|0 ]
                              [ --pdfviewerenabled 1|0 ]
                              [ --pdfdriver driver_name ]
                              [ --pdfisdefault 1|0 ]
                              [ --pdfviewerisdefault 1|0 ]
                              [ --links obj... ]
                              [ --editprofile 2|1|0 ]
                              [ --clipboard 2|1|0 ]
                              [ --serialport 2|1|0 ]
                              } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The name of the organizational unit object in the SGD datastore.
--description
A text description of the object.
--inherit
Whether the assigned applications for the object also includes the assigned applications for the object’s parent.
--conntype
The connections that are allowed between the client device and the SGD server.
--cdm
The drives on a Microsoft Windows client device that can be accessed from applications running on application servers.
--userprintingconfig
Enables user-specific printing configuration.
--mapprinters
The client printers users can print to when printing from Windows applications.
--pdfenabled
Enables users to print using the SGD “Universal PDF Printer” printer when printing from Windows applications.
--pdfviewerenabled
Enables users to print using the SGD “Universal PDF Viewer” printer when printing from Windows applications.
--pdfdriver
The printer driver to use for SGD PDF printing when printing from Windows applications.
--pdfisdefault
Sets the SGD “Universal PDF Printer” printer as the client’s default printer when printing from Windows applications.
--pdfviewerisdefault
Sets the SGD “Universal PDF Viewer” printer as the client’s default printer when printing from Windows applications.
--links
Defines the assigned applications for an object.
--editprofile
Whether users can create and edit profiles for use with the SGD Client.
--clipboard
Whether users can use copy and paste in Windows or X application sessions.
--serialport
Whether users can access the serial ports on a client device from a Windows application.
--file
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.

Examples

The following example creates a new OU object with the name IT, belonging to the organization object Indigo Insurance, which must already exist. This OU inherits assigned applications from its parent, the organization object. Connections for all users in the OU are secure (SSL-based) unless their user profile objects are configured to give a different type of connection.

$ tarantella object new_orgunit \
--name "o=Indigo Insurance/ou=IT" \
--inherit true --conntype '*:*:SSL'

The following example creates three OU objects using a batch script defined as a “here-document”. The OU Administration belongs to the OU Finance, just created. You can alternatively store the batch script in a file, and reference it using --file filename.

$ tarantella object new_orgunit --file - <<EOF
--name "o=Indigo Insurance/ou=IT"
--name "o=Indigo Insurance/ou=Finance"
--name "o=Indigo Insurance/ou=Finance/ou=Administration"
EOF

tarantella object new_person

Creates one or more user profile objects. See User Profile Object.

Syntax
tarantella object new_person {
                               --name obj
                               --surname surname
                             [ --description text ]
                             [ --user user ]
                             [ --email name@domain ]
                             [ --ntdomain dom ]
                             [ --inherit true|false ]
                             [ --shared true|false ]
                             [ --enabled true|false ]
                             [ --conntype type_spec... ]
                             [ --cdm drive_spec... ]
                             [ --keymap keymap ]
                             [ --bandwidth limit ]
                             [ --links obj... ]
                             [ --userprintingconfig 1|0 ]
                             [ --mapprinters 2|1|0 ]
                             [ --pdfenabled 1|0 ]
                             [ --pdfviewerenabled 1|0 ]
                             [ --pdfdriver driver_name ]
                             [ --pdfisdefault 1|0 ]
                             [ --pdfviewerisdefault 1|0 ]
                             [ --editprofile 2|1|0 ]
                             [ --clipboard 2|1|0 ]
                             [ --serialport 2|1|0 ]
                             } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The common name of the object in the SGD datastore.
--surname
The surname, or family name, for the user profile.
--description
A text description of the object.
--user
The user name for the user profile. This is typically their UNIX system user name.
--email
The email address for the user profile.
--ntdomain
The Windows domain used for application server authentication.
--inherit
Whether the assigned applications for the object also includes the assigned applications for the object’s parent.
--shared
Whether the user profile object is used by a single user, or can be shared by multiple users in the form of a “guest” account.
--enabled
Whether someone can log in using this user profile object.
--conntype
Defines the connections that are allowed between the client device and the SGD server.
--cdm
The drives on a Microsoft Windows client device that users can access from applications.
--keymap
The path name of a keyboard map file.
--bandwidth
The maximum bandwidth this person can use for applications.
--links
Defines the assigned applications for an object.
--userprintingconfig
Enables user-specific printing configuration.
--mapprinters
The client printers users can print to when printing from Windows applications.
--pdfenabled
Enables users to print using the SGD “Universal PDF Printer” printer when printing from Windows applications.
--pdfviewerenabled
Enables users to print using the SGD “Universal PDF Viewer” printer when printing from Windows applications.
--pdfdriver
The printer driver to use for SGD PDF printing when printing from Windows applications.
--pdfisdefault
Sets the SGD “Universal PDF Printer” printer as the client’s default printer when printing from Windows applications.
--pdfviewerisdefault
Sets the SGD “Universal PDF Viewer” printer as the client’s default printer when printing from Windows applications.
--editprofile
Whether users can create and edit profiles for use with the SGD Client.
--clipboard
Whether users can use copy and paste in X or Windows application sessions.
--serialport
Whether users can access the serial ports on a client device from a Windows application.
--file
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.

Examples

The following example creates a new user profile object for Indigo Jones. Indigo inherits assigned applications from the organization object.

$ tarantella object new_person \
--name "o=Indigo Insurance/cn=Indigo Jones" \
--surname Jones --user indigo \
--email indigo@indigo-insurance.com --inherit true

The following example creates three user profile objects using a batch script defined as a “here-document”. You can alternatively store the batch script in a file, and reference it using --file filename.

$ tarantella object new_person --file - <<EOF
--name "o=Indigo Insurance/cn=Indigo Jones" --surname Jones
--name "o=Indigo Insurance/ou=IT/cn=Bill Orange" --surname Orange
--name "o=Indigo Insurance/ou=Finance/cn=Mulan Rouge" --surname Rouge
EOF

tarantella object new_windowsapp

Creates one or more Windows application objects. See Windows Application Object.

Syntax
tarantella object new_windowsapp {
   --name obj
   --width pixels 
   --height pixels  
 [ --description text ]
 [ --winproto wts|none ]
 [ --trylocal true|false ]
 [ --ntdomain dom ]
 [ --app pathname ]
 [ --args args ]
 [ --appserv obj... ]
 [ --workingdir dir ]
 [ --resumable never|session|always ]
 [ --displayusing independent|kiosk|seamless ]
 [ --maxinstances 0|instances ]
 [ --maximize true|false ]
 [ --scalable true|false ]
 [ --depth 8|16|24/32 ]
 [ --icon icon_name ]
 [ --hints hint...]
 [ --compression automatic|on|off ]
 [ --execution automatic|inorder|optimized ]
 [ --interlaced automatic|on|off ]
 [ --accel true|false ]
 [ --delayed true|false ]
 [ --winmgr command... ]
 [ --login script ]
 [ --protoargs args ]
 [ --resumetimeout mins ]
 [ --middlemouse ms ]
 [ --euro unicode|iso8859-15 ]
 [ --dpi monitordpi ]
 [ --lockkeymap true|false ]
 [ --loadbal default|cpu|memory|sessions ]
 [ --ldapusers user_dn... ]
 [ --ldapgroups group_dn... ]
 [ --ldapsearch search_string... ]
 [ --clipboardlevel level ]
 [ --windowclose suspendsession|endsession ]
 [ --cdm drive_spec... ]
 [ --appprintingconfig 1|0 ]
 [ --mapprinters 2|1|0 ]
 [ --pdfenabled 1|0 ]
 [ --pdfviewerenabled 1|0 ]
 [ --pdfdriver driver_name ]
 [ --pdfisdefault 1|0 ]
 [ --pdfviewerisdefault 1|0 ]
 [ --allowkioskescape true|false ]
 [ --swmopts true|false ]
 [ --console 1|0 ]
 [ --remotewindowkeys true|false ]
 [ --disablewallpaper 1|0 ]
 [ --disablefullwindowdrag 1|0 ]
 [ --disablemenuanimations 1|0 ]
 [ --disabletheming 1|0 ]
 [ --disablecursorshadow 1|0 ]
 [ --disablecursorsettings 1|0 ]
 [ --enablefontsmoothing 1|0 ]
 [ --noprintprefs 1|0 ]
 [ --remoteaudio 1|0 ]
 } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The common name of the object in the SGD datastore.
--width
The width of the application, in pixels.
--height
The height of the application, in pixels.
--description
A text description of the object.
--winproto
Whether to run the Windows application from an application server using Remote Desktop Protocol.
--trylocal
Try starting the application on the user’s client device.
--ntdomain
The Windows domain to use for the application server authentication process.
--app
Full path name of the application.
--args
The command-line arguments to use when starting the application.
--appserv
The application servers that can run the application.
--workingdir
Working directory to be used by the application.
--resumable
Resumability behavior for the application.
--displayusing
How the application is displayed to the user.
--maxinstances
The maximum number of instances of the application a user can run simultaneously.
--maximize
The initial size of the application.
--scalable
Scale the application to fit the window in which it is displayed.
--depth
Color depth for the application.
--icon
Webtop icon for the application.
--hints
String containing additional name-value data for the application.
--compression
Whether the AIP protocol compresses commands for transmission.
--execution
Whether the AIP protocol always executes commands in order, or optimizes commands for performance reasons.
--interlaced
Enables interlaced image transmission.
--accel
Enables graphics acceleration for the application’s display.
--delayed
Enables delayed updates of the application’s display.
--winmgr
The Window Manager to use for the application.
--login
The login script used to start the application.
--protoargs
Command-line arguments used for the SGD Remote Desktop Client.
--resumetimeout
Number of minutes the application is resumable for.
--middlemouse
Timeout for emulating a middle mouse button click using a two-button mouse.
--euro
Keycode mapping required by the application to support the euro character.
--dpi
Monitor resolution that SGD reports to X applications.
--lockkeymap
Prevents applications from changing keyboard mappings.
--loadbal
Load balancing algorithm to use.
--ldapusers
Assigns the application to the specified LDAP users.
--ldapgroups
Assigns the application to the specified LDAP groups.
--ldapsearch
Assigns the application to the users that match the LDAP search criteria.
--clipboardlevel
Clipboard security level for the application.
--windowclose
Effect on application session of closing the main application window.
--cdm
The drives on a Microsoft Windows client device that can be accessed from the application running on an application server.
--appprintingconfig
Enables application-specific printing configuration.
--mapprinters
The client printers users can print to when printing from the application.
--pdfenabled
Enables users to print using the SGD “Universal PDF Printer” printer when printing from the application.
--pdfviewerenabled
Enables users to print using the SGD “Universal PDF Viewer” printer when printing from the application.
--pdfdriver
The printer driver to use for SGD PDF printing when printing from the application.
--pdfisdefault
Sets the SGD “Universal PDF Printer” printer as the client’s default printer when printing from the application.
--pdfviewerisdefault
Sets the SGD “Universal PDF Viewer” printer as the client’s default printer when printing from the application.
--allowkioskescape
Enables a pull-down header for kiosk mode applications.
--swmopts
Enables local window hierarchy for applications displayed in seamless windows mode. Needed for compatibility with some Borland applications.
--console
Starts the application in console mode, also called remote administration mode.
--remotewindowkeys
Sends window management key strokes to the remote session.
--disablewallpaper
Disables background wallpaper. This can improve performance.
--disablefullwindowdrag
Disables the option to show the contents of a window when it is moved. This can improve performance.
--disablemenuanimations
Disables transition effects for menus and tooltips. This can improve performance.
--disabletheming
Disables themes for the application. This can improve performance.
--disablecursorshadow
Disables the mouse pointer shadow. This can improve performance.
--disablecursorsettings
Disables mouse pointer schemes and customizations. This can improve performance.
--enablefontsmoothing
Enables font smoothing for text in the application. This can improve text readability, but can affect performance.
--noprintprefs
Disables caching of printer preferences, such as paper size and page orientation.
--remoteaudio
Leaves audio at the remote application server.
--file
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.

Examples

The following example creates a new Windows application object for the application Write-o-Win. The application runs on the application server rome.

$ tarantella object new_windowsapp \
--name "o=applications/cn=Write-o-Win" \
--width 1000 --height 800 \
--app c:\\programs\\apps\\write.exe \
--appserv "o=appservers/ou=Sales/cn=rome"

tarantella object new_xapp

Creates one or more X application objects. See X Application Object.

Syntax
tarantella object new_xapp {
   --name obj
   --width pixels
   --height pixels 
 [ --description text ]
 [ --app pathname ]
 [ --args args ]
 [ --appserv obj... ]
 [ --method rexec|telnet|ssh ]
 [ --resumable never|session|always ]
 [ --endswhen lastclient|windowmanager|windowmanageralone|
nowindows|loginscript|loginscriptnowindows ]
 [ --maxinstances 0|instances ]
 [ --displayusing clientwm|independent|kiosk|localx ]
 [ --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 ]
 [ --euro unicode|iso8859-15 ]
 [ --dpi monitordpi ]
 [ --keepopen true|false ]
 [ --lockkeymap true|false ]
 [ --share true|false ]
 [ --securityextension true|false ]
 [ --ssharguments args ]
 [ --unixaudiopreload true|false ]
 [ --remotewindowkeys true|false ]
 [ --allowkioskescape true|false ]
 [ --allowsshdowngrade true|false ]
 } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The common name of the object in the SGD datastore.
--width
The width of the application, in pixels.
--height
The height of the application, in pixels.
--description
A text description of the object.
--app
Full path name of the application.
--args
The command-line arguments to use when starting the application.
--appserv
The application servers that can run the application.
--method
The mechanism used by the SGD server to access the application server and start the application.
--resumable
Resumability behavior for the application.
--endswhen
When the application session ends.
--maxinstances
The maximum number of instances of the application a user can run simultaneously.
--displayusing
How the application is displayed to the user.
--maximize
The initial size of the application.
--scalable
Scale the application to fit the window in which it is displayed.
--depth
Color depth for the application.
--icon
Webtop icon for the application.
--hints
String containing additional name-value data for the application.
--clipboardlevel
Clipboard security level for the application.
--roottype
Appearance of the root window.
--rootcolor
Color of the root window.
--compression
Whether the AIP protocol compresses commands for transmission.
--execution
Whether the AIP protocol always executes commands in order, or optimizes commands for performance reasons.
--quality
The effective color depth displayed on client devices.
--interlaced
Enables interlaced image transmission.
--accel
Enables graphics acceleration for the application’s display.
--delayed
Enables delayed updates of the application’s display.
--ldapusers
Assigns the application to the specified LDAP users.
--ldapgroups
Assigns the application to the specified LDAP groups.
--ldapsearch
Assigns the application to the users that match the LDAP search criteria.
--loadbal
Load balancing algorithm to use.
--env
Environment variable settings needed to run the application.
--login
The login script used to start the application.
--winmgr
The Window Manager to use for the application.
--resumetimeout
Number of minutes the application is resumable for.
--middlemouse
Timeout for emulating a middle mouse button click using a two-button mouse.
--force3button
Specifies that the application only supports a 3-button mouse.
--windowclose
Effect on application session of closing the main application window.
--euro
Keycode mapping required by the application to support the euro character.
--dpi
Monitor resolution that SGD reports to X applications.
--keepopen
Keep open the connection used to start the application.
--lockkeymap
Prevents applications from changing keyboard mappings.
--share
Enables resource sharing for similar application sessions.
--securityextension
Enables the X Security Extension for the application.
--ssharguments
Command-line arguments for the ssh client.
--unixaudiopreload
Enables the SGD audio redirection library.
--remotewindowkeys
Sends window management key strokes to the remote session.
--allowkioskescape
Enables a pull-down header for kiosk mode applications.
--allowsshdowngrade
Enables SGD to try an X11 connection instead of SSH, when X11 forwarding is not configured or working.
--file
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.

Examples

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"

tarantella object remove_host

Removes application servers from the list of those that can run an application, for application server load balancing.

Syntax
tarantella object remove_host { --name obj...
                                --host hobj...
                              } | --file file
Description

The following table shows the available options for this command.

Option
Description
--name
Specifies the names of application objects you want to configure load balancing for.
--host
Specifies the names of application server objects you want to remove from the load balancing pool.
--file
Specifies a file containing a batch of commands to configure application server load balancing.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example removes the application server rome from the load balancing pool for the application Slide-o-Win.

$ tarantella object remove_host \
--name "o=applications/cn=Slide-o-Win" \
--host "o=appservers/ou=Sales/cn=rome"

The following example removes the group WinHosts from the load balancing pool for the applications Write-o-Win and Slide-o-Win. Load balancing is no longer performed across all the application servers in WinHosts.

$ tarantella object remove_host \
--name "o=applications/cn=Write-o-Win" \
"o=applications/cn=Slide-o-Win" \
--host "o=appservers/cn=WinHosts"

tarantella object remove_link

Removes assigned applications links for an object.

Syntax
tarantella object remove_link { --name obj...
                                --link lobj...
                              } | --file file
Description

The following table shows the available options for this command.

Option
Description
--name
Specifies the names of objects you want to remove links for.
--link
Specifies the names of objects you want to remove links for.
--file
Specifies a file containing a batch of commands to remove links for.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example removes the Write-o-Win application from the assigned applications for Violet Carson.

$ tarantella object remove_link \
--name "o=Indigo Insurance/ou=Sales/cn=Violet Carson" \
--link "o=applications/cn=Write-o-Win"

The following example removes the group Applications from the assigned applications of the organizational units Sales and Marketing. Everyone who inherits assigned applications from one of these OUs no longer sees all the applications in their assigned applications. For example, if they belong to that OU and Inherit Assigned Applications from Parent is selected for their user profile object. However, they might still see an application if it is inherited from elsewhere.

$ tarantella object remove_link \
--name "o=Indigo Insurance/ou=Sales" \
"o=Indigo Insurance/ou=Marketing" \
--link "o=applications/cn=Applications"

tarantella object remove_mapping

Removes type-application mappings for a dynamic application object. See Dynamic Application Object.

Syntax
tarantella object remove_mapping {
                                   --name obj
                                   --mappingtype [type]
                                 } | --file file
Description

The following table shows the available options for this command.

Option
Description
More Information
--name
The name of the dynamic application object.
--mappingtype
Type of mapping to be removed.
--file
A file containing a batch of commands to remove mappings.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example removes a mapping for the windows type from a dynamic application object with common name winApp.

$ tarantella object remove_mapping \
--name "o=applications/cn=winApp" \
--mappingtype windows

The following example removes a mapping for the solaris type from a dynamic application object named desktopApp.

$ tarantella object remove_mapping \
--name "o=applications/cn=desktopApp" \
--mappingtype solaris 

tarantella object remove_member

Removes objects from groups.

Syntax
tarantella object remove_member { --name obj...
                                  --member mobj...
                                } | --file file
Description

The following table shows the available options for this command.

Option
Description
--name
Specifies the names of group objects you want to remove members from.
--member
Specifies the names of objects you want to remove from the groups.
--file
Specifies a file containing a batch of commands to remove group members.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example removes the Write-o-Win application from the group Applications.

$ tarantella object remove_member \
--name "o=applications/cn=Applications" \
--member "o=applications/cn=Write-o-Win"

The following example removes the three application server objects rome, brussels, and berlin from the group WinHosts.

$ tarantella object remove_member \
--name "o=appservers/cn=WinHosts" \
--member "o=appservers/ou=Sales/cn=rome" \
"o=appservers/cn=brussels" \
"o=appservers/ou=Marketing/cn=berlin"

tarantella object rename

Renames or moves an object in the organizational hierarchy.

Syntax
tarantella object rename { --name obj...
                           --newname newobj...
                         } | --file file
Description

The following table shows the available options for this command.

Option
Description
--name
Specifies the name of the object you want to rename or move.
--newname
Specifies the new name of the object.
--file
Specifies a file containing a batch of commands to rename or move objects.

Note - Make sure you quote any object names containing spaces, for example, "o=Indigo Insurance".


Examples

The following example renames the user profile object for Elizabeth Blue to Liz Blue.

$ tarantella object rename \
--name "o=Indigo Insurance/ou=Sales/cn=Elizabeth Blue" \
--newname "o=Indigo Insurance/ou=Sales/cn=Liz Blue"

The following example moves Ginger Butcher between the organizational units IT and Sales.

$ tarantella object rename \
--name "o=Indigo Insurance/ou=IT/cn=Ginger Butcher" \
--newname "o=Indigo Insurance/ou=Sales/cn=Ginger Butcher"

tarantella object script

Runs a batch script of tarantella object commands, or enables commands to be run interactively.

Syntax
tarantella object script
Description

The batch script consists of standard tarantella object commands, one per line, without the tarantella object prefix. For example, use edit rather than tarantella object edit.

The batch script can use a back slash (\) to break commands across multiple lines. Lines beginning with a hash (#) are treated as comments and ignored.

If you need to include quotes (") or a backslash (\) character in any of the values for the commands, you must backslash protect them. For example, to use "c:\ Program Files" as a value for the --args option, type the following: --args "\"c:\\Program Files\""

The command reads from standard input. For example, you can use a “here-document” to run a batch script:

$ tarantella object script <<EOF
commands
EOF

If standard input is empty, you can run tarantella object commands interactively.

Examples

The following example adds the group Applications to the organizational units Sales and Marketing, and sets the Sales OU’s Inherit Assigned Applications from Parent attribute to false.

$ tarantella object script <<EOF
add_link
--name "o=Indigo Insurance/ou=Sales"
"o=Indigo Insurance/ou=Marketing"
--link "o=Indigo Insurance/cn=Applications"
edit
--name "o=Indigo Insurance/ou=Sales" --inherit false
EOF