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

This command enables SGD Administrators to list and manipulate application sessions.

Syntax

tarantella emulatorsession list | info | shadow | suspend | end

Description

The following table shows the available subcommands for this command.

Subcommand
Description
More Information
list
Lists application sessions.
info
Displays detailed information about application sessions.
shadow
Shadows an application session.
suspend
Suspends application sessions.
end
Ends application sessions.

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


Examples

The following example lists Emma Rald’s application sessions.

$ tarantella emulatorsession list \
--person "o=Indigo Insurance/cn=Emma Rald"

The following example shadows the application session with the specified session ID.

$ tarantella emulatorsession shadow \
"paris.indigo-insurance.com:965127448604:...%2f_ens%2fo=Indigo Insurance%2fcn=Emma Rald"

tarantella emulatorsession list

Lists application sessions matching the criteria specified. Information shown includes session IDs, which are used with other tarantella emulatorsession commands.

An example session ID is paris.indigo-insurance.com:965127448604: ...%2f_ens%2fo=Indigo Insurance%2fcn=Emma Rald.

Session IDs can contain spaces, so make sure you quote them.

Syntax
tarantella emulatorsession list [ --person pobj ]
                                [ --application appobj ]
                                [ --appserver hobj ]
                                [ --server serv ]
                                [ --format text|count|xml ]
Description

The following table shows the available options for this command.

Option
Description
--person
Lists application sessions matching the name of the person specified.

Use the user identity of the person.

--application
Lists application sessions matching the name of application specified.

Use the name of an application object in the local repository.

--appserver
Lists application sessions matching the name of application server specified.

Use the name of an application server object in the local repository.

--server
Lists application sessions hosted by the SGD server specified.

Use the name of an application server object in the local repository (if the SGD server has an application server object), or the peer DNS name for the server.

--full
Includes the current IP address of the client and the status of the application session in the output. It takes longer to display this information.
--format
Specifies the output format. The default setting is text. Use count to display only the number of matching sessions.

If --person, --application, --appserver, and --server are all omitted, all application sessions are listed.

Examples

The following example lists Emma Rald’s application sessions.

$ tarantella emulatorsession list \
--person "o=Indigo Insurance/cn=Emma Rald"

The following example lists all application sessions hosted by the SGD server boston.indigo-insurance.com. This is the server on which the Protocol Engines run.

$ tarantella emulatorsession list \
--server boston.indigo-insurance.com

tarantella emulatorsession info

Displays detailed information about application sessions.

Syntax
tarantella emulatorsession info [ --sessid sessid... ]
                                [ --peid peid... ]
                                [ --format text|xml|quiet ]
Description

The following table shows the available options for this command.

Option
Description
--sessid
Displays detailed information on application sessions matching the session IDs listed. Use tarantella emulatorsession list to find out session IDs.
--peid
Displays detailed information on application sessions matching the Protocol Engine process IDs listed. Valid process IDs are as follows:
  • A number, such as 3456, representing the process ID on the application server where the command is run

  • A combination of peer DNS name and process ID, for example boston.indigo-insurance.com:3456, representing the process ID on the SGD server named.

--format
Specifies the output format. The default setting is text. With --format quiet, no messages are displayed.

The exit code indicates the number of session IDs and process IDs named that do not exist.

Examples

The following example displays detailed information on application sessions matching the Protocol Engine process IDs “3456” and “4567” on the application server where the command is run.

$ tarantella emulatorsession info --peid 3456 4567

tarantella emulatorsession shadow

Shadows an application session, enabling you and the user to interact with the application simultaneously. Only SGD Administrators can shadow application sessions. You can only shadow Windows and X applications. Suspended applications cannot be shadowed.

Syntax
tarantella emulatorsession shadow sessid
                                             [ --read-only ]
                                             [ --silent ]
                                             [ --format text|quiet ]
Description

The following table shows the available options for this command.

Option
Description
sessid
Shadows the application session with the specified session ID. Use tarantella emulatorsession list to find out session IDs.
--read-only
Enables an Administrator to shadow a session without being able to interact with the application.
--silent
Enables an Administrator to shadow a session and interact with the application. The user is not notified that an Administrator wants to shadow their session and they cannot refuse permission.

If this is used with --read-only, the user does not know they are being shadowed and the Administrator cannot interact with the application.


Note - In some countries, it is illegal to shadow a user without their knowledge. It is your responsibility to comply with the law.


--format
Specifies the output format. The default setting is text. With --format quiet, no messages are displayed.

Note - You can also shadow a session from the Global Settings -> Application Sessions tab of the Administration Console. You select the session from either the user profile object or the application object. However, using the Administration Console does not enable you to shadow a session in read-only mode or silent mode.


If --silent is not used, the user is notified that an Administrator wants to shadow their session and they can refuse permission. The user is also notified when shadowing ends.

The exit code is 0 for success, 1 if the session does not exist, 2 if the session is not shadowable, or 3 if the session is suspended.

Examples

The following example shadows the application session with the specified session ID.

$ tarantella emulatorsession shadow \
"paris.indigo-insurance.com:965127448604:...%2f_ens%2fo=Indigo Insurance%2fcn=Emma Rald"

The following example shadows the application session with the specified session ID without the user knowing that they are being shadowed. The Administrator is unable to interact with the application.

$ tarantella emulatorsession shadow \
"paris.indigo-insurance.com:965127448604:...%2f_ens%2fo=Indigo Insurance%2fcn=Emma Rald" \
--read-only --silent

tarantella emulatorsession suspend

Suspends application sessions.

Syntax
tarantella emulatorsession suspend sessid...
                                   [ --format text|quiet ]
Description

The following table shows available options for this command.

Option
Description
sessid...
Suspends the application sessions with the specified session IDs. Use tarantella emulatorsession list to find out session IDs.
--format
Specifies the output format. The default setting is text. With --format quiet, no messages are displayed.

The exit code is 0 for success, 1 if some sessions do not exist, 2 if some sessions are already suspended, or 3 if there is a mixture of nonexistent and suspended sessions.

Examples

The following example suspends the application session with the specified session ID.

$ tarantella emulatorsession suspend \
"paris.indigo-insurance.com:965127448604:...%2f_ens%2fo=Indigo Insurance%2fcn=Emma Rald"

tarantella emulatorsession end

Ends application sessions. The applications exit immediately, which might result in loss of data for users.

Syntax
tarantella emulatorsession end sessid...
                           [ --format text|quiet ]
Description

The following table shows the available options for this command.

Option
Description
sessid...
Specifies the session IDs of the application sessions to end. Use tarantella emulatorsession list to find out session IDs.
--format
Specifies the output format. The default setting is text. With --format quiet, no messages are displayed.

The exit code of the command is 0 if all sessions were successfully ended, or 1 if some session IDs did not exist.

Examples

The following example ends the specified application session.

$ tarantella emulatorsession end \
"paris.indigo-insurance.com:965127448604:...%2f_ens%2fo=Indigo Insurance%2fcn=Emma Rald"