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

This command enables SGD Administrators to set up and dismantle arrays of SGD servers.

The command can be run on any SGD server in the array.

Syntax

tarantella array add_backup_primary | clean | detach |
edit_backup_primary | join | list | list_backup_primaries |
make_primary | remove_backup_primaries

Description

The following table shows the available subcommands for this command.

Subcommand
Description
More Information
add_backup_primary
Adds a secondary server to the backup primaries list for an array.
clean
Returns an SGD server to a preconfigured array state.
detach
Removes secondary servers from an array.
edit_backup_primary
Sets the position of a secondary server in the backup primaries list for an array.
join
Adds a server to an array.
list
Lists the members of the array, identifying the primary server.
list_backup_primaries
Displays the backup primaries list for an array.
make_primary
Makes a secondary server the primary server for the array that it is currently a member of.
remove_backup_primary
Removes one or all secondary servers from the backup primaries list for an array.

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


Examples

The following example adds the server boston to the array with primary server newyork.

$ tarantella array join --primary newyork.example.com \
--secondary boston.example.com

The following example makes the secondary server boston the primary server in the array. The previous primary server becomes a secondary server.

$ tarantella array make_primary \
--secondary boston.example.com

tarantella array add_backup_primary

Adds a secondary server to the list of backup primaries for an SGD array.

Syntax
tarantella array add_backup_primary 
                          --secondary serv
                          --position [ first | last | position ]
Description

The following table shows the available options for this command.

Option
Description
--secondary
Specifies the peer Domain Name System (DNS) name of a secondary server to add to the backup primaries list. The server name must be the name of a secondary server in the array.

You can only add one server at a time.

--position
The position of the secondary server in the backup primaries list. For position, you can either type a number, or you can use the first or last keyword to specify the first or last position in the list. The number 0 means first position in the list.
Examples

The following example adds the secondary server boston to the backup primaries list for the array. The server is added in last position of the list.

$ tarantella array add_backup_primary \
--secondary boston.example.com --position last

tarantella array clean

Deletes array information and returns an SGD server to a preconfigured array state. By default, a confirmation prompt is displayed.


Note - This command only affects the SGD server where the command is run.


Syntax
tarantella array clean [ --standalone | --contactmembers ]
                       [ --quiet ]
Description

The following table shows the available options for this command.

Option
Description
--standalone
Deletes all array information and returns the SGD server to standalone state. In standalone state, the server is not a member of an array. This is the default option.

Caution

Caution - After you run this command on the primary server in an SGD array, the secondary servers will not be able to contact the primary server.


--contactmembers
The SGD server remains in an array with any servers that are contactable and that report the same array membership. Non-contactable servers, or servers that disagree on the current array membership, are not included in the array.
--quiet
Does not display a confirmation prompt before cleaning.

Note - After running this command, it is advisable to run the tarantella status command on the SGD server to check the status of the server.


Examples

The following example removes array configuration and returns the SGD server where the command is run to a standalone state. A confirmation prompt is not shown.

$ tarantella array clean --quiet

tarantella array detach

Removes a secondary server from the array of SGD servers it belongs to.

Syntax
tarantella array detach --secondary serv
Description

The following table shows the available options for this command.

Option
Description
--secondary
Specifies the peer DNS name of a secondary server to remove. The server name must be the name of a secondary server in the same array.

You can only remove one server at a time.

To remove the primary server from an array, first use tarantella array make_primary to make another server the primary server and then detach the old primary server.

When you use this command, the secondary server is removed from the backup primaries list for the SGD array.

When you remove a server from an array, it loses its license keys.


Note - After running this command, it is advisable to wait until SGD has copied the changes to all SGD servers in the array before running any further tarantella array commands. Run the tarantella status command on the primary SGD server to check the status of the array.


If you are using secure intra-array communication, the secondary server generates its own Certificate Authority (CA) certificate and its own server peer Secure Sockets Layer (SSL) certificate when it is detached.

Examples

The following example removes the secondary server boston from the array.

$ tarantella array detach --secondary boston.example.com

tarantella array edit_backup_primary

Sets the position of a secondary server in the list of backup primaries for an SGD array.

Syntax
tarantella array edit_backup_primary 
                           --secondary serv 
                           --position [ first | last | position ]
Description

The following table shows the available options for this command.

Option
Description
--secondary
Specifies the peer DNS name of the secondary server in the backup primaries list. The server name must be the name of a secondary server in the array.

You can only change the position for one server at a time.

--position
The position of the secondary server in the backup primaries list. For position, you can either type a number, or you can use the first or last keyword to specify the first or last position in the list. The number 0 means first position in the list.
Examples

The following example sets the position of the secondary server boston in the backup primaries list for the array. The server is moved to last position in the list.

$ tarantella array edit_backup_primary \
--secondary boston.example.com --position last

tarantella array join

Adds a server to an array of SGD servers, either as a primary or a secondary server.

Syntax
tarantella array join [ --primary pserv ]
                      [ --secondary sserv ]
Description

The clock on the server joining the array must be in synchronization with the clocks on the other servers in the array. If the time difference is more than one minute, this command will fail.

After running this command, it is advisable to wait until SGD has copied the changes to all SGD servers in the array before running any further tarantella array commands. Run the tarantella status command on the primary SGD server to check the status of the array.

It is best to use a fully-qualified DNS name when specifying the server to add to an array.

The following table shows the available options for this command.

Option
Description
--primary
Specifies the peer DNS name of the primary server in the array. Defaults to the server where the command is run.
--secondary
Specifies the peer DNS name of the server to add. The secondary server must be the only member of an array. Defaults to the server where the command is run.

You can only add one secondary server at a time.

When you use this command, the secondary server is added to the end of the backup primaries list for the SGD array.

If the server you add has been load balancing application servers using Advanced Load Management, use the tarantella restart sgd --warm command to do a warm restart of the new server after it has joined the array. If the array to which the new server is joined is using Advanced Load Management, do a warm restart of the whole array after the new server has joined.

If you are using secure intra-array communication, you are prompted to accept the CA certificate of either the primary server or the secondary server, depending on where you ran the command.

Examples

The following example adds the server boston to the array with newyork as its primary server.

$ tarantella array join \
--primary newyork.example.com \
--secondary boston.example.com

The following example adds the server where the command is run to the array with newyork as its primary server.

$ tarantella array join \
--primary newyork.example.com

tarantella array list

Lists each member of the array of SGD servers, identifying the primary server.

Syntax
tarantella array list
Examples

The following example lists all SGD servers in the array.

$ tarantella array list

tarantella array list_backup_primaries

Displays the contents of the backup primaries list for an SGD array.

Syntax
tarantella array list_backup_primaries [ --first | --last | --all ]
Description

If no options are specified, this command displays all entries in the backup primaries list.

The following table shows the available options for this command.

Option
Description
--first
Displays the first entry in the backup primaries list.
--last
Displays the last entry in the backup primaries list.
--all
Displays all entries in the backup primaries list. This is the default option.
Examples

The following example displays all entries in the backup primaries list for the SGD array.

$ tarantella array list_backup_primaries

tarantella array make_primary

Makes a secondary server the primary server for the array that it is currently a member of. The previous primary server becomes a secondary server.

Syntax
tarantella array make_primary --secondary serv
Description

The following table shows the available options for this command.

Subcommand
Description
--secondary
Specifies the peer DNS name of the secondary server to be made the primary server.

Note - After running this command, it is advisable to wait until SGD has copied the changes to all SGD servers in the array before running any further tarantella array commands. Run the tarantella status command on the primary SGD server to check the status of the array.


If you are using secure intra-array communication, the new primary becomes the certificate authority for the array and issues new server peer SSL certificates to all SGD servers in the array.

Examples

The following example makes the secondary server boston the primary server in the array.

$ tarantella array make_primary \
--secondary boston.example.com

tarantella array remove_backup_primary

Removes one or all secondary servers from the list of backup primaries for an SGD array.

Syntax
tarantella array remove_backup_primary [ --secondary serv | --all ]
Description

The following table shows the available options for this command.

Option
Description
--secondary
Specifies the peer DNS name of the secondary server to remove from the backup primaries list. The server name must be the name of a secondary server in the array.

With this option, you can only remove one server at a time from the list.

--all
Removes all secondary servers from the backup primaries list.
Examples

The following example removes the secondary server boston from the backup primaries list for the array.

$ tarantella array remove_backup_primary \
--secondary boston.example.com