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

Syntax

Description

Examples

tarantella array clean

Syntax

Description

Examples

tarantella array detach

Syntax

Description

Examples

tarantella array edit_backup_primary

Syntax

Description

Examples

tarantella array join

Syntax

Description

Examples

tarantella array list

Syntax

Examples

tarantella array list_backup_primaries

Syntax

Description

Examples

tarantella array make_primary

Syntax

Description

Examples

tarantella array remove_backup_primary

Syntax

Description

Examples

The tarantella cache Command

Syntax

Description

Examples

The tarantella config Command

Syntax

Description

Examples

tarantella config edit

Syntax

Description

Examples

tarantella config list

Syntax

Description

Examples

The tarantella emulatorsession Command

Syntax

Description

Examples

tarantella emulatorsession list

Syntax

Description

Examples

tarantella emulatorsession info

Syntax

Description

Examples

tarantella emulatorsession shadow

Syntax

Description

Examples

tarantella emulatorsession suspend

Syntax

Description

Examples

tarantella emulatorsession end

Syntax

Description

Examples

The tarantella help Command

Syntax

Description

Examples

The tarantella object Command

Syntax

Description

Examples

tarantella object add_host

Syntax

Description

Examples

tarantella object add_link

Syntax

Description

Examples

tarantella object add_mapping

Syntax

Description

Examples

tarantella object add_member

Syntax

Description

Examples

tarantella object delete

Syntax

Description

Examples

tarantella object edit

Syntax

Description

Examples

tarantella object list_attributes

Syntax

Description

Examples

tarantella object list_contents

Syntax

Description

Examples

tarantella object new_3270app

Syntax

Description

Examples

tarantella object new_5250app

Syntax

Description

Examples

tarantella object new_charapp

Syntax

Description

Examples

tarantella object new_container

Syntax

Description

Examples

tarantella object new_dc

Syntax

Description

Examples

tarantella object new_doc

Syntax

Description

Examples

tarantella object new_dynamicapp

Syntax

Description

Examples

tarantella object new_group

Syntax

Description

Examples

tarantella object new_host

Syntax

Description

Examples

tarantella object new_org

Syntax

Description

Examples

tarantella object new_orgunit

Syntax

Description

Examples

tarantella object new_person

Syntax

Description

Examples

tarantella object new_windowsapp

Syntax

Description

Examples

tarantella object new_xapp

Syntax

Description

Examples

tarantella object remove_host

Syntax

Description

Examples

tarantella object remove_link

Syntax

Description

Examples

tarantella object remove_mapping

Syntax

Description

Examples

tarantella object remove_member

Syntax

Description

Examples

tarantella object rename

Syntax

Description

Examples

tarantella object script

Syntax

Description

Examples

The tarantella passcache Command

Syntax

Description

Examples

tarantella passcache delete

Syntax

Description

Examples

tarantella passcache edit

Syntax

Description

Examples

tarantella passcache list

Syntax

Description

Examples

tarantella passcache new

Syntax

Description

Examples

The tarantella print Command

Syntax

Description

Examples

tarantella print cancel

Syntax

Description

Examples

tarantella print list

Syntax

Description

Examples

tarantella print move

Syntax

Description

Examples

tarantella print pause

Syntax

Description

Examples

tarantella print resume

Syntax

Description

Examples

tarantella print start

Syntax

Description

Examples

tarantella print status

Syntax

Description

Examples

tarantella print stop

Syntax

Description

Examples

The tarantella query Command

Syntax

Description

Examples

tarantella query audit

Syntax

Description

Using a Filter

Examples

tarantella query billing

Syntax

Description

Examples

tarantella query errlog

Syntax

Description

Examples

tarantella query uptime

Syntax

Description

Examples

The tarantella restart Command

Syntax

Description

Examples

tarantella restart sgd

Syntax

Description

Examples

tarantella restart webserver

Syntax

Description

Examples

The tarantella role Command

Syntax

Description

Examples

tarantella role add_link

Syntax

Description

Examples

tarantella role add_member

Syntax

Description

Examples

tarantella role list

Syntax

Description

Examples

tarantella role list_links

Syntax

Description

Examples

tarantella role list_members

Syntax

Description

Examples

tarantella role remove_link

Syntax

Description

Examples

tarantella role remove_member

Syntax

Description

Examples

The tarantella security Command

Syntax

Description

Examples

tarantella security certinfo

Syntax

Description

Examples

tarantella security certrequest

Syntax

Description

Examples

tarantella security certuse

Syntax

Description

Examples

tarantella security customca

Syntax

Description

Examples

tarantella security decryptkey

Syntax

Description

Examples

tarantella security disable

Syntax

Description

Examples

tarantella security enable

Syntax

Description

Examples

tarantella security fingerprint

Syntax

Description

Examples

tarantella security peerca

Syntax

Description

Examples

tarantella security selfsign

Syntax

Description

Examples

tarantella security start

Syntax

Description

Examples

tarantella security stop

Syntax

Description

Examples

The tarantella service Command

Syntax

Description

Examples

tarantella service delete

Syntax

Description

Examples

tarantella service edit

Syntax

Description

Examples

tarantella service list

Syntax

Description

Examples

tarantella service new

Syntax

Description

Examples

The tarantella setup Command

Syntax

Description

Examples

The tarantella start Command

Syntax

Description

Examples

tarantella start cdm

Syntax

Description

Examples

tarantella start sgd

Syntax

Description

Examples

tarantella start webserver

Syntax

Description

Examples

The tarantella status Command

Syntax

Description

Examples

The tarantella stop Command

Syntax

Description

Examples

tarantella stop cdm

Syntax

Description

Examples

tarantella stop sgd

Syntax

Description

Examples

tarantella stop webserver

Syntax

Description

Examples

The tarantella tokencache Command

Syntax

Description

Examples

tarantella tokencache delete

Syntax

Description

Examples

tarantella tokencache list

Syntax

Description

Examples

The tarantella tscal Command

Syntax

Description

Examples

tarantella tscal free

Syntax

Description

Examples

tarantella tscal list

Syntax

Description

Examples

tarantella tscal return

Syntax

Description

Examples

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

Syntax

Description

Examples

tarantella webserver delete_trusted_user

Syntax

Description

Examples

tarantella webserver list_trusted_users

Syntax

Description

Examples

The tarantella webtopsession Command

Syntax

Description

Examples

tarantella webtopsession list

Syntax

Description

Examples

tarantella webtopsession logout

Syntax

Description

Examples

E.  Login Scripts

F.  Third-Party Legal Notices

Glossary

Index

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

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"