The tarantella Command

You can control SGD from the command line using the /opt/tarantella/bin/tarantella command.

Syntax

tarantella option [ option-specific-arguments ]

Description

Do not try to control the SGD server by running binaries directly, or by using kill. Using the tarantella command is the only supported way of controlling the SGD server.

The options for this command enable you to control the SGD server in different ways, or produce information about the SGD server. The tarantella command can be used in your own shell scripts to help automate your administration of SGD.

If the SGD server is running, most tarantella options can be run by root or any user in the ttaserv group. The ttaserv group does not have to be the user’s primary or effective group. See the table below for details of which users can use the command options.

If the SGD server is stopped, only root can use the tarantella command.

The following table shows the available options for this command.

Option Description Can Be Run By More Information archive Archives the SGD server’s log files. root The tarantella archive Command array Creates and manages arrays of SGD servers. SGD Administrators The tarantella array Command cache Manages the cache of Lightweight Directory Access Protocol (LDAP) data. SGD Administrators The tarantella cache Command config Edits global and server-specific configuration. root or ttaserv group The tarantella config Command emulatorsession Lists and controls application sessions. root or ttaserv group The tarantella emulatorsession Command help Shows a list of SGD commands. root or ttaserv group The tarantella help Command object Manipulates objects in the organizational hierarchy. root or ttaserv group The tarantella object Command passcache Manipulates the password cache. root or ttaserv group The tarantella passcache Command print Controls SGD printing services. root or ttaserv group The tarantella print Command query Examines the SGD server’s log files. root The tarantella query Command restart Restarts SGD services. root The tarantella restart Command role Gives users specific roles, and assigns applications specific to that role. root or ttaserv group The tarantella role Command security Controls security services, manages certificates. root The tarantella security Command service Manages service objects for LDAP and Active Directory authentication. root or ttaserv group The tarantella service Command setup Changes Setup options, restores original objects. root The tarantella setup Command start Starts SGD services. root The tarantella start Command status Shows the current status of SGD servers in the array. root or ttaserv group The tarantella status Command stop Stops SGD services. root The tarantella stop Command tokencache Manipulates the token cache. root or ttaserv group The tarantella tokencache Command tscal Manages Microsoft Windows Terminal Services Client Access Licenses (CALs) for non-Windows clients. root or ttaserv group The tarantella tscal Command uninstall Uninstalls SGD. root The tarantella uninstall Command version Displays versions of installed SGD packages. root or ttaserv group The tarantella version Command webserver Configures trusted users for the third-party authentication mechanism. root The tarantella webserver Command webtopsession Lists and controls user sessions. root or ttaserv group The tarantella webtopsession Command

Examples

The following example stops and then restarts the SGD server, without displaying any messages.

# tarantella restart sgd --quiet

The following example adds a link for the Write-o-Win application to the assigned applications for members of the Global Administrators role.

$ tarantella role add_link --role global \
--link "o=applications/cn=Write-o-Win"