Managing the FirePass Windows client with command-

line interface commands

After you have downloaded and installed the MSI package, you can use the command-line
interface to start, troubleshoot, and monitor the F5 FirePass client. You type the
command-line interface command and then press the Enter key to run it. The command-
line interface also provides help.

The command-line interface has two modes: blocked and non-blocked. In blocked mode,
(the default), the command-line interface displays its results when a specified operation
fails or completes. In non-blocked mode, the command-line interface displays its results
immediately. It does not wait for an operation to complete. You can check the status of
the operation using the -info command.

Important: You must install the FirePass controller client before you issue the command-
line interface commands.

The syntax for issuing a command-line interface command is shown following:

f5fpc <command><option>

where <command> can be the following:

-start

-stop

-info

-profile

-help

f5fpc calls the F5 command-line interface utility from the F5 FirePass command-line
interface Setup Path; for example, C:Program Files\F5 VPN\f5fpc> f5fpc . To use the
command-line utility, issue the command-line interface commands from this directory.

This section contains the following topics:

 -start command
 -stop command

 -information command
  -profile command

 Getting help about commands

-start command

Use the -start command to for the following reasons:.

 Start a FirePass controller session.

 Start autolaunch favorites or specific favorites.

 Log on to a specified host.

The following table lists the options and parameters for the -start command.

Short
Options Parameter Description
cut
Configuration profile name.
When you create and install an
MSI package, the FirePass
/config /c string controller creates a default
profile (a default configuration
file). The user can also specify
his custom profile.
Enables non-block mode. In
non-block mode, the
/nonblock /nb N/A command-line interface
returns its results immediately.
The default is block mode.
The FirePass controller host
name format. If you do not
specify the host name, the
/host /h [http|https]host[:port][/landing_uri] command-line interface uses
the default profile, or a dialog
box requesting input from the
user is displayed.
/user /u string User name. If the user name is
required for establishing a
session, but not specified, the
command-line interface uses
the value from the profile or
the customized profile create
 by the user; otherwise; the
command-line interface
presents a dialog box to the
user.
Password. If the password is
required for establishing a
session, but not specified, the
command-line interface uses
the value from the default
/password /p string profile or the customized
profile created by the user;
otherwise; the FirePass
controller command-line
interface presents a dialog box
to the user.
Hex encoded user name. If
required to establish a session ,
but not specified, the
/userhex /uh string command-line interface uses
the value from the default
profile or a dialog box is
presented to the user.
Hex encoded password. If the
password is required for
session establishing, but not
/passwordhex /ph string specified, the command-line
interface uses the value from
the default profile or a dialog
box is presented to the user.
UI mode. The default is simple
/mode /m [simple|advanced]
UI mode.
Session ID used to start
/sid /s string favorite for an already
established session.
Favorite name to start. If the
/fname /n name[:{vpn|apptunnel|terminal}] name is not unique, you can
specify an optional type.
Favorite ID returned by the -
/fid /f string
info command.
Enables Verbose output to
/verbouse /v N/A
standard output.
Note: When using the start commands, only the option /sid is required.

Process exit code

Process exit code Status

0x0 success
0x1 disconnected by user
0x2 authentication failure
0x4 autolaunch failure
0x8 favorites failure
0x10 user attention required
0x100 generic error
0x200 unknown parameter
0x300 wrong value
0x400 unknown session id
0x500 unknown favorite id

Note: You must create a script to view process exit codes.

You must specify a session

To view the profile issue the following command, f5fpc -profile

Example: Start the F5 FirePass command-line interface in Simple mode

To start the F5 VPN command-line interface in simple mode, issue the following
command to start the host firepass.com:443 and the user john

Program Files\F5 VPN\f5fpc> f5fpc -start /h firepass.com:443 /u john

The command-line interface displays the following results:

session id: 15

Example: Start Network Access with the favorites

To start Network Access with the name My favorite 1 and App Tunnel resource with the
name favorite2, issue the following command:

Program Files\F5 VPN\f5fpc> f5fpc -start /nb /h firepass.com /u john /p password /m

advanced /n My favorite 1:vpn /n favorite2:apptunnel
The command-line interface displays the following results:

session id: 15

Stop command

Use the -stop command to terminate a specified session or favorite within a session.

The following table lists the options for the stop command.

Short
Options Optional/Required Parameter Description
cut
Terminates the
session ID and all
/sid /s [required] string established
favorites within
the session
The favorite ID,
unique within a
session. The
favorite with the
/fid /f [optional] string
specified favorite
ID is terminated.
The session ID is
required
The favorite
name. You can
specify an
optional type if
the name is not
unique. The
command-line
/fname /n optional name[:{vpn|apptunnel|terminal}]
interface
terminates the
favorite with the
specified favorite
name. The
session ID is
required

The command-line interface displays the following exit codes when you issue -stop
command.

Process exit code (Hex) Process exit code (Decimal) Status

0 0 success
0x100 256 generic error
0x200 512 unknown parameter
0x300 768 wrong value
0x400 1024 unknown session ID
0x500 1280 unknown favorite ID

Note: You must create a script to view process exit codes.

Example: Terminates a session with the session id=15

To terminate a session with the session id=15, issue the following command:

Program Files\F5 VPN\f5fpc> f5fpc -stop /s 15

The command-line interface displays the following results:

Program Files\F5 VPN\f5fpc> f5fpc -stop /s 15

STOP result:

Standalone closed!

Program Files\F5 VPN>

Example: Terminates Network Access with the name favorite for a session with a
session id=15

To terminate Network Access with the name favorite for a session with a session id=15,
issue the following command:
Program Files\F5 VPN\f5fpc> f5fpc -stop /s 15 /n favorite:vpn

To terminate a favorite with id=1 for a session with the session id=345, issue the
following command:

Program Files\F5 VPN\f5fpc> f5fpc -stop /s 345 /f 1e

Information command
Use the -info command to display information about sessions and favorites.

The following table lists options for the -info command.

Short Required /
Option Parameter Description
cut Optional
Session ID that displays
information about specified
session. If session ID is not
/sid /s optional string
specified, the command-
line interface displays all
current sessions.
Requires session ID. If the
session ID is not specified,
/fid /f optional string the command-line interface
displays information about
all favorites.
Favorite name. You can
specify an optional type if
the name is not unique
/fname /n optional name[:{vpn|apptunnel|terminal}] information about the
favorite. The specified
favorite name is displayed.
The session ID is required.

Output format

If the session ID is not specified, The command-line interface displays a list of created
sessions with their status in the following format:

session_id status_code user_friendly_message

The following table lists the session status codes for the information command.

Process exit code Process exit code

Status
(HEX) (Decimal)
0x1 1 session established
0x2 2 logon in progress
user should select host from presented
0x4 4
list
0x8 8 autolaunch in progress
0x10 16 user attention required

Note: You must create a script to view process exit codes.

If the session id is specified, The command-line interface displays a list of favorites for
this session with their status in the following format:

session_id favorite_id favorite_type favorite_name status_code

user_friendly_message

The exit code should be equal to the session status.

The following table lists favorite information status codes.

Process exit code status

0x0 nonactive favorite
0x1 established favorite
0x2 favorite connecting
0x10 user attention required

If the favorite is specified (option /n) the text output contains information about this
favorite only.
The exit code should be equal to favorite status

Process exit codes

Process exit code status

0 success
0x100 generic error
0x200 unknown parameter
0x300 wrong value
0x400 unknown session id
0x500 unknown favorite id

Note: You must create a script to view process exit codes.

Other result codes depend on the specified option.

Example: Print a list of active sessions

To print a list of active sessions, issue the following command:

Program Files\F5 VPN\f5fpc> f5fpc -info

The command-line interface displays the following results:

INFO result:

session: code: status:

1515172 2 logon in progress

663410 1 session established

There is 2 active session(s)!

Example: Print status and list of favorites for session with id=15

To print status and list of favorites for session with id=15, issue the following command:

Program Files\F5 VPN\f5fpc> f5fpc -info /s 15

The command-line interface displays the following results:

session code status

15 1 session established

session favorite type name code status

15 1 vpn network 1 established
15 2 apptunnel AS400 0 available
15 3 apptunnel SALES 0 available

Example: Display information about a favorite with id=1 for a session with id=15

To display information about a favorite with id=1 for a session with id=15, issue the
following command:

Program Files\F5 VPN\f5fpc> f5fpc -info /s 15 /f 1

The command-line interface displays the following results:

session favorite type name code status

15 1 vpn network1 1 established
Example: Display information about a favorite with name SALES for session with
id=15

To display information about a favorite with name SALES for session with id=15, issue
the following command:

Program Files\F5 VPN\f5fpc> f5fpc -info /s 15 /n SALES:apptunnel

The command-line interface displays the following results:

session favorite type name code status

15 3 apptunnel SALES 0 available

The error code should be equal to favorite status.

Profile command

The -profile command displays information about a F5 FirePass profile configured using
the Customize Client Components tab at the Device Management :Client Downloads:
Windows (x86) screen.

For example:

Program Files\F5 VPN\f5fpc> f5fpc -profile

The command-line interface displays the following results:

Name Address Port Description

Main 44.58.251.1 443 The main gateway
Asia 28.45.13.22 443 Asia gateway

Process exit codes code status 0x0 success 0x100 generic error 0x200 unknown
parameter 0x300 wrong value.

The following table list the arguments for the profile command.

Short
Options Parameter Description
cut
Configuration profile file name. If not specified, the
/config /c string command-line interface uses the default current
program profile.
The following table lists the process exit codes for the profile command.

Process Exit Code Status

0x0 success
0x100 generic error
0x200 unknown parameter
0x300 wrong value

Note: To view process exit codes, you must create a script.

Getting help about commands

To display all possible options for a command-line interface command or option, type the
command followed immediately by -help or /?.

For example:

Program Files\F5 VPN\f5fpc> f5fpc -help

C:\PROGRA~1\F5VPN~1> f5fpc -help

Usage: f5fpc

[arguments] Valid commands are:

-start
-info
-stop
-profile
-help

For help on a specific command, enter f5fpc/? for them.

The following examples list other ways you get help about commands.

Program Files\F5 VPN\f5fpc> f5fpc <command> /?

Program Files\F5 VPN\f5fpc> f5fpc -stop /?<