UNIX (shell) Command Summary

The following Unix (shell) commands are available at your shell prompt when /opt/SUNWicg/SunScreen/bin is included in your $PATH. The following table lists the SunScreen Unix (shell) commands and their descriptions. Many of these commands duplicate administration GUI functions, while others provide a context for other commands.

Table A-1 SunScreen UNIX (shell) Command Summary

Unix Command	Description
ss_install	Create an initial SunScreen configuration. ss_install, when combined with pkgadd, is equivalent to using the install-wizard graphical user interface.
ss_client	Provide communication between an Administration Station and a Screen that was configured by an earlier SunScreen firewall product release. ss_client is provided only for the purpose of remotely administering such products using the SunScreen system as a remote Administration Station.
ssadm	Primary command-line tool for SunScreen administration. ssadm sub-commands perform various operations such as editing and activating a SunScreen configuration, and examining the status of a Screen.

---

Note -

The commands used by skiptool can be found in the SunScreen SKIP 1.5.1 User's Guide.

---

UNIX (shell) Commands

ss_install Command

ss_install is a text-based command-line utility for creating an initial SunScreen configuration. ss_install, combined with pkgadd, is the command-line equivalent to the installation wizard graphical user interface.

ss_install interactively queries you with various options for configuring the SunScreen, creates a configuration, stores it under the policy name "Initial", and activates it. After ss_install is complete, you can administer the firewall.

ssadm Command

ssadm is the primary command-line tool for SunScreen administration. ssadm has a number of sub-commands that perform various operations such as editing and activating a configuration, and examining the status of a Screen.

ssadm runs directly on a locally administered Screen, or indirectly from a remote Administration Station that is using SunScreen SKIP to encrypt IP network communications passing between them. See the SunScreen SKIP User's Guide for more information regarding SKIP encryption.

Usage:

ssadm [-b] [-n] sub-command [parameters...]

ssadm [-b] [-n] -r remotehost [-F ticketfile] sub-command [parameters...]

Options:

-b -- Allow binary data (instead of text) in standard input and output.

-n -- Do not read any input from standard input.

-r remotehost -- Access remote Screen using address or hostname remotehost.

-F ticketfile -- Use authorization ticket stored in ticketfile.

The available ssadm sub-commands are each described in the ssadm Sub-Command section of this document.

The -b option normally is not needed since those commands that process binary data enable the binary mode automatically. For example, ssadm backup, ssadm restore, ssadm log, ssadm logdump, and ssadm patch handle binary data even if -b is not specified.

When ssadm is executed locally on the Screen (that is, without the -r option) no login or authentication is required, but you must be superuser to have any effect.

When ssadm is used with the -r option to access a remote Screen, login authentication is required. You must use the ssadm login command to get a ticket that is used by subsequent invocations of ssadm to allow access to the remote Screen. Normally, the ticket is stored in a ticketfile, the name of which can be specified using the -F option, or through the SSADM_TICKET_FILE environment variable. See the ssadm login command for information about ticket files and remote administration using ssadm.

Executing an ssadm Command on a Local Screen

You can configure a local Screen by typing the commands listed in this appendix using the Screen's keyboard. For example, to activate a policy called "Initial," you would type:

# ssadm activate Initial

where ssadm is the command you want to execute, activate is the name of the ssadm subcommand, and Initial is the name of the policy you want to activate.

The ssadm command resides in the /opt/SUNWicg/SunScreen/bin directory. Include this directory in your directory search path to have access to the commands on the local Screen.

Executing an ssadm -r Command on a Remote Administration Station

You can configure a Screen from a remote Administration Station by preceding the commands listed in this appendix with the ssadm -r command and the name of the Screen you want to administer. For example, to activate the policy "Initial" on a remote Screen called SunScreen1, you would type:

# ssadm -r SunScreen1 activate Initial

where ssadm -r indicates that you want to execute a command on a remote Screen called SunScreen1, activate is the name of the ssadm sub-command, and Initial is the name of the policy you want to activate

---

Note -

A local ssadm command can be turned into a remote ssadm command by adding -r remote_Screen_name immediately after ssadm.

---

When ssadm is used with the -r option to access a remote Screen, the name of the ticketfile can be specified using the -F option, or through the SSADM_TICKET_FILE environment.

Remotely Logging Into and Out of SunScreen

If you are using remote administration, you must log in before you can perform most ssadm commands.

To Remotely Log Into SunScreen

Type the following:

# export SSADM_TICKET_FILE # touch $SSADM_TICKET_FILE # chmod go= $SSADM_TICKET_FILE # ssadm -r SunScreen1 login username password WRITE access <E23B344150C702EC>

To Remotely Log Out of SunScreen

Type the following:

# ssadm -r SunScreen1 logout