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 query Command

Examines the SGD server’s log files.

Syntax

tarantella query audit | billing | errlog | uptime

Description

The following table shows the available subcommands for this command.

Subcommand
Description
More Information
audit
Displays log entries matching some criteria.
billing
Queries billing log files.
errlog
Displays the error log of SGD components.
uptime
Displays how long an SGD server has been available for.

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


Examples

The following example displays all error logs.

# tarantella query errlog

The following example displays how long the SGD server newyork.indigo-insurance.com has been available.

# tarantella query uptime --server newyork.indigo-insurance.com

tarantella query audit

Displays all log entries matching some criteria.

Syntax
tarantella query audit
{ --app app | --person person | --host host | --filter filter }
[ --server arrayhost ]
[ --format text|csv|xml ]
Description

The following table shows the available options for this command.

Option
Description
--app
Displays log entries referring to a specific application. Use the object name for the application.
--person
Displays log entries referring to a specific person. Use the object name for the person.
--host
Displays log entries referring to a specific SGD server. Use the object name or a peer DNS name for the server.
--filter
An RFC2254-compliant LDAP search filter to find matching entries to display. Enclose the filter in quotes. You can use the “=”, “~=”, “<=” and “>=” matching rules in the filter.
--server
Only show log entries from the specified SGD server. Use a peer DNS name. If you omit this option, log entries across the entire array are displayed.
--format
Specifies the output format. The default setting is text. If you select the text format, SGD formats the log output so that it is easy to read on scree, but it does not show every detail logged. Using the csv format shows every detail logged but it is only suitable for outputting to a file.

Note - The output that you see depends on the Log Filter settings for the array. To produce log entries for processing by this command, make sure the Log Filter attribute on the Global Settings -> Monitoring tab in the Administration Console includes at least one filter that outputs to a .jsl file.


Using a Filter

The attributes you use in the filter are the log fields used in the .jsl log files. The following table lists the commonly used attributes.

Field Name
Description
log-category
The logging component/sub-component/severity setting used in the log filters. For example, to find entries for a server/printing/* log filter, you can use a "(log-category=*printing*)" filter
log-date
The system date and time when the event took place. The format is yyyy/MM/dd HH:mm:ss.SSS.
log-ip-address
The IP address of a client or server associated with an event.
log-keyword
The keyword for auditable events.
log-localhost
The peer DNS name of the SGD server where the event took place.
log-pid
The process ID of the event.
log-security-type
The type of security used on a connection, std or ssl.
log-systime
The system Coordinated Universal Time (UTC) time, in milliseconds, when the event took place.
log-tfn-name
The name of an object associated with an event. For example, starting an application session can record the name of the user, the application and the SGD server.

Note - A complete list of all the log fields is available in the /opt/tarantella/var/serverresources/schema/log.at.conf schema file.


Examples

The following example displays all log entries for the UNIX system user indigo that were logged on the SGD server boston.indigo-insurance.com.

# tarantella query audit \
--person .../_user/indigo --server boston.indigo-insurance.com

The following example outputs all log entries that refer to the Write-o-Win application, in comma-separated values (CSV) format.

# tarantella query audit \
--app "o=applications/cn=Write-o-win" --format csv

The following example outputs all log errors that occurred on or after 23 October 2003 for the Write-o-Win application, in human-readable text format.

# tarantella query audit \
--filter "(&(log-category=*error*)(log-tfn-name=o=applications/cn=Write-o-win) (log-date>=2003/10/23 00:00:00.0))"\
--format text

tarantella query billing

Outputs billing information for the array, or for a subset of the array, over a time period. Information is displayed on screen in CSV format.

Syntax
tarantella query billing { --full | --sessions | --summary }
                           --start date
                           --days days
                           --end date
                         [ --servers arrayhost... ]
Description

The following table shows the available options for this command.

Option
Description
--full
Displays detailed information for all user sessions and application sessions.
--sessions
Displays information for all application sessions.
--summary
Displays a short summary of billing information and an application session summary.
--start
Specifies the start of the billing period. The format is YYYY/MM/DD, for example, "2000/05/01".
--days
Specifies the number of days from the date specified by --start to display billing information.
--end
Specifies the end of the billing period. The format is YYYY/MM/DD, for example, “2000/05/02”. The end date is exclusive. This means, for example, that --start 2001/01/19 --end 2001/01/23 is the same as --start 2001/01/19 --days 4. Both examples query data covering the 19th, 20th, 21st, and 22nd.
--servers
Only reports billing information from the named SGD servers. Use peer DNS names. If you omit --servers, billing information across the array is reported.

The billing files are written at midnight local time each day.

You must run this command on the primary server in the array.


Note - You must enable billing services, see Billing Service, and restart all SGD servers in the array before any data is logged.


Examples

The following example displays billing information for the entire array, for the 30 days from May 1, 2000.

# tarantella query billing --full \
 --start "2000/05/01" --days 30

The following example displays a short summary of billing information for the servers prague and paris, for the 30 days from January 1 2000.

# tarantella query billing --summary \
 --start "2000/01/01" --days 30 \
-- servers prague.indigo-insurance.com paris.indigo-insurance.com

The following example displays billing information for all application sessions for the entire array for the period January 19 2001 to January 22 2001 and outputs the results to a file called Sessions.csv.

# tarantella query billing --sessions \
 --start "2000/01/19" --end "2000/01/23" > sessions.csv

tarantella query errlog

Displays the error logs of SGD components.

Syntax
tarantella query errlog
                [ all|xpe|tpe|print|jserver|pemanager|proxy|wm ]
                [ --server arrayhost ]
Description

The following table shows the available options for this command.

Option
Description
all | xpe | tpe | print | jserver | pemanager | proxy | wm
Specifies the component error log to display. Use all, the default, to display all error logs.
--server
Displays error logs from the named SGD server. Use a peer DNS name.

If you omit this option, error logs from all SGD servers in the array are displayed.


Note - To display error log information from the JServer component, make sure the Log Filter attribute on the Global Settings -> Monitoring tab of the Administration Console includes at least one filter that outputs to an error.log file. The attribute does include this, by default.


Examples

The following example displays all error logs.

$ tarantella query errlog

The following example displays the X Protocol Engine error log on the SGD server newyork.indigo-insurance.com.

$ tarantella query errlog xpe \
--server newyork.indigo-insurance.com

tarantella query uptime

Displays how long SGD servers have been available for.

Syntax
tarantella query uptime [ --server arrayhost ]
Description

The following table shows the available options for this command.

Option
Description
--server
Display information for the specified SGD server. Use a peer DNS name. If you omit this option, information for all SGD servers in the array is displayed.
Examples

The following example displays how long all SGD servers in the array have been available for.

$ tarantella query uptime