D.1. 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

Section D.2, “tarantella archive”

array

Creates and manages arrays of SGD servers.

SGD Administrators

Section D.3, “tarantella array”

cache

Manages the cache of Lightweight Directory Access Protocol (LDAP) data.

SGD Administrators

Section D.13, “tarantella cache”

config

Edits global and server-specific configuration.

root or ttaserv group

Section D.14, “tarantella config”

emulatorsession

Lists and controls application sessions.

root or ttaserv group

Section D.18, “tarantella emulatorsession”

help

Shows a list of SGD commands.

root or ttaserv group

Section D.24, “tarantella help”

object

Manipulates objects in the organizational hierarchy.

root or ttaserv group

Section D.25, “tarantella object”

passcache

Manipulates the password cache.

root or ttaserv group

Section D.54, “tarantella passcache”

print

Controls SGD printing services.

root or ttaserv group

Section D.59, “tarantella print”

query

Examines the SGD server's log files.

root

Section D.68, “tarantella query”

restart

Restarts SGD services.

root

Section D.73, “tarantella restart”

role

Gives users specific roles, and assigns applications specific to that role.

root or ttaserv group

Section D.76, “tarantella role”

security

Controls security services, manages certificates.

root

Section D.84, “tarantella security”

service

Manages service objects for LDAP and Active Directory authentication.

root or ttaserv group

Section D.97, “tarantella service”

setup

Changes Setup options, restores original objects.

root

Section D.102, “tarantella setup”

start

Starts SGD services.

root

Section D.103, “tarantella start”

status

Shows the current status of SGD servers in the array.

root or ttaserv group

Section D.107, “tarantella status”

stop

Stops SGD services.

root

Section D.108, “tarantella stop”

uninstall

Uninstalls SGD.

root

Section D.112, “tarantella uninstall”

version

Displays versions of installed SGD packages.

root or ttaserv group

Section D.113, “tarantella version”

webserver

Configures trusted users for the third-party authentication mechanism.

root

Section D.114, “tarantella webserver”

webtopsession

Lists and controls user sessions.

root or ttaserv group

Section D.118, “tarantella webtopsession”

Note

All commands include a --help option. You can use tarantella command --help to get help on a specific 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"