D.21. 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 Section D.19, “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.example.com:965127448604:...%2f_ens%2fo=Example%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.example.com:965127448604:...%2f_ens%2fo=Example%2fcn=Emma Rald" \
--read-only --silent