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

Use the tarantella tscal command to manage Microsoft Windows Terminal Services CALs for non-Windows clients.

Syntax

tarantella tscal free | list | return

Description

The following table shows the available subcommands for this command.

Subcommand
Description
More Information
free
Frees a Terminal Services CAL for use by another non-Windows client.
list
Lists the Terminal Services CALs currently reserved for non-Windows clients.
return
Returns Terminal Services CALs to the Windows license server.

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


Examples

The following example lists the Terminal Services CALs currently reserved for non-Windows clients.

$ tarantella tscal list

tarantella tscal free

Use the tarantella tscal free command to free a Microsoft Windows Terminal Services CAL so that it can be used by another non-Windows client.

Syntax
tarantella tscal free [ --inuseby user | --calid id ]
Description

You can only free a CAL if the user has no application sessions that use Windows Terminal Services.


Note - Freed CALs are not returned to the Windows license server.


Normally, you do not need to run this command, as SGD automatically frees a CAL as soon as a user exits their last Windows application. However, if an SGD server is removed from an array or it loses contact with the array, it might still be listed as using CALs. In this situation, you can run this command to free a CAL.

If you do not use any arguments, the command frees all CALs that have no application sessions that use Windows Terminal Services.

If you run this command on a secondary server in a SGD array and the primary server is unavailable, the CAL information might not be completely accurate. This is because the primary server is responsible for updating all SGD servers in the array with changes to CAL information. The command warns you if the primary is unavailable.

The following table shows the available options for this command.

Option
Description
--inuseby
Free only the CALs for a particular user where the user is either of the following:
  • The name of a user.

  • A wild card filter.

The * character is the only character you can use in a wild card filter. It represents a string of any length containing any characters. So, an --inuseby "*green*" argument frees only the unused CALs for users whose name contains the string “green”.

--calid
The ID of the CAL you want to free. Use the tarantella tscal list command to obtain the ID of the CAL you wish to free.
Examples

The following example frees the CALs for Elizabeth Blue.

$ tarantella tscal free \
--inuseby "o=Indigo Insurance/ou=Sales/cn=Elizabeth Blue"

tarantella tscal list

Use the tarantella tscal list command to list the Microsoft Windows Terminal Services CALs currently reserved for use by non-Windows clients.

Syntax
tarantella tscal list [ --inuseby user | --inuse | --free ] 
                      [ --type name ]
                      [ --format text|xml ]
Description

If you do not use any arguments, the command lists all CALs and shows whether or not they are in use.

If you run this command on a secondary server in an SGD array and the primary server is unavailable, the list might not be completely accurate. This is because the primary server is responsible for updating all SGD servers in the array with changes to CAL information. The command warns you if the primary is unavailable.

The following table shows the available options for this command.

Option
Description
--inuseby
List only the CALs being used by a particular user where the user is either of the following:
  • The name of a user.

  • A wild card filter.

You can use the tarantella emulatorsession list command to determine the name of a user.

The * character is the only character you can use in a wild card filter. It represents a string of any length containing any characters. So, an --inuseby "*green*" argument lists only the CALs for users whose name contains the string “green”.

--inuse
List only the CALs that are currently in use.
--free
List only the CALs that are currently not in use.
--type
List only the CALs that can connect to a particular type of Terminal Services server. This is either WinNT4-TS-CAL or Win200x-TS-CAL.

Note - The name is not case sensitive.


--format
Specifies the output format. The default setting is text.
Examples

The following example lists the CALs for non-Windows clients that are currently not in use.

$ tarantella tscal list --free

tarantella tscal return

Use the tarantella tscal return command to return all free Microsoft Windows Terminal Services CALs to the Windows license server.

Syntax
tarantella tscal return --free
Description

Note - The Windows license server might not reissue the returned CALs until approximately 90 days have elapsed since they were last in use.


Use the tarantella tscal free command to free a CAL so that it can be returned.

Normally, you do not need to run this command, as SGD automatically returns a CAL if it has not been used for 90 days. However, if an SGD server is removed from an array, you can use this command to manually return the CALs.

The following table shows the available options for this command.

Option
Description
--free
Returns all free CALs to the Windows license server.
Examples

The following example returns all free CALs to the Windows license server.

$ tarantella tscal return --free