F5 Logo MyF5
Search
  1. MyF5 Home
  2. Knowledge Centers
  3. BIG-IP APM
  4. BIG-IP Access Policy Manager: Edge Client and Application Configuration
  5. BIG-IP Edge Command Line Client for Linux
Manual Chapter : BIG-IP Edge Command Line Client for Linux

Applies To:

Show Versions Show Versions

BIG-IP APM

  • 11.6.5, 11.6.4, 11.6.3, 11.6.2, 11.6.1
Manual Chapter
Table of Contents | << Previous Chapter | Next Chapter >>

About BIG-IP Edge Client for Linux command line

The BIG-IP® Access Policy Manager® includes a BIG-IP Edge Client® command line for Linux. You can download and deploy this client to your organization's Linux desktops.

Task summary

Downloading the Linux command line client

You can download the BIG-IP® Edge command line client for Linux installer, as a gzipped .TAR file, and distribute it to clients for installation.
  1. On the Main tab, click Access Policy > Secure Connectivity > Client Downloads. A list of available client downloads displays.
  2. Click BIG-IP Edge Command Line Client for Linux. The file linux_sslvpn.tgz is downloaded to your local directory.
The Linux command line client is ready to be installed.

Installing the Linux command line client

You must download the file linux_sslvpn.tgz before you can install the command line client.
You can use various Linux client commands with the BIG-IP® Edge command line client for Linux.
  1. Extract the file linux_sslvpn.tgz to your local directory.
  2. Extract the file linux_sslvpn.tar to your local directory.
  3. Run the install script Install.sh under the root account.
The following text appears when installation is complete:
--> f5fpc is installed in /usr/local/bin

--> Please check f5fpc --help command to get started

--> Uninstaller located in /usr/local/lib/F5Networks/uninstall_F5.sh

Importing a certificate to the local trust store

You can import an untrusted certificate to the local trust store and change it into a trusted certificate.
  1. Using operating system commands, place the certificate in any folder in the operating system. For example, /etc/certs.
  2. Change the directory. For example, cd /etc/certs.
  3. Type the command c_rehash ./.
The certificate is installed.
Note: Alternatively, instead of installing the certificate, you can specify the --cacert option to import a certificate to the local store.

Linux client commands

The following commands are supported by the Linux command line client. All commands that are invoked on the Linux command line client begin with the command f5fpc.

To start a VPN connection, type either of the following commands:

  • f5fpc -- start [arguments]
  • f5fpc - s [arguments]
Note: This requires the --host or -t argument at the minimum.

Use the following table to assign arguments to the Linux commands.

Arguments Description

--nonblock
                -b
              

 Returns the command line interface immediately after the command.

--host [https://]hostname[:port]
             -t [https://]hostname[:port]
              

 The host name to which the client starts the VPN connection. This is required.

--user username
              -u username
              

 The optional user name for the connection.

--password password
                p password
              

 The optional password for the connection.

--userhex hex-encoded-username
              -U hex-encoded-username
              

 The optional hex-encoded user name for the connection.

--passwordhex hex-encoded-password
                -P hex-encoded-password
              

 The optional hex-encoded password for the connection.

--cert certificate
              -r certificate
              

 Specifies an optional client certificate.

--key certificate_key
                -k certificate_key
              

 Specifies the key for an optional client certificate.

--keypass SSL_certificate_password
                -y SSL_certificate_password
              

 Specifies the password for an optional SSL certificate.

--cacert trusted_CA_certificate
                -a trusted_CA_certificate
              

 Specifies a certificate from a trusted certificate authority (CA). If --cacert or --cacertdir is specified, then the server certificate validates for trust against the specified certificate or directory. If --cacert or --cacertdir is not specified, then the default location /etc/ssl/certs is checked to verify trust. The --nocheck option can be specified if a server certificate check is not desired, though this is not recommended.

--cacertdir trusted_CA_certificate_directory
                -d trusted_CA_certificate_directory
              

 Specifies a certificate directory that contains a certificate from a trusted CA. If --cacert or --cacertdir is specified, then the server certificate validates for trust against the specified certificate or directory. If --cacert or --cacertdir is not specified, then the default location /etc/ssl/certs is checked to verify trust. The --nocheck option can be specified if a server certificate check is not desired, though this is not recommended.

--nocheck
                -x
              

 Specifies that the trusted CA certiicate is not verified for trust at all. If --cacert or --cacertdir is specified, then the server certificate validates for trust against the specified certificate or directory. If --cacert or --cacertdir is not specified, then the default location /etc/ssl/certs is checked to verify trust. The --nocheck option can be specified if a server certificate check is not desired, though this is not recommended.
To stop the VPN connection, type either of the following commands:
  • f5fpc -- stop
  • f5fpc --o
To display the connection status, type either of the following commands:
  • f5fpc -- info
  • f5fpc --i
To display the command line client help, type either of the following commands:
  • f5fpc -- help
  • f5fpc --h

Info command status and error codes

The following status codes and error codes might be displayed when you run the --info command.

Error code/command status Hex value Shell value Description
CLI_ERROR_SUCCESS 0x0 0 The command line operation was successful.
CLI_ERROR_USERS_DISCONNECT 0x150 80 The user was disconnected
CLI_ERROR_LOGON_FAILURE 0x151 81 Login failed due to incorrect authenticaion information or login errors.
CLI_ERROR_ATTENTION_REQUIRED 0x154 84 The user's attention is required.
CLI_ERROR_GENERIC_FAILURE 0x155 85 An error occurred in the system API.
CLI_ERROR_UNKNOWN_PARAMETER 0x156 86 An incorrect or unknown parameter was passed to the command line.
CLI_ERROR_WRONG_VALUE 0x157 87 This is an undefined error.
CLI_ERROR_UNKNOWN_SESSION_ID 0x158 88 An unknown session ID was encountered. The user should reconnect to the server.
CLI_ERROR_NO_PROFILE 0x15B 91 No such profile exists.
CLI_ERROR_MSGQ_OPEN_FAILURE 0x15D 93 The system failed to open the message queue.
CLI_ERROR_OPERATION_IN_PROGRESS 0x15F 95 An operation is in progress, please retry.
kss_Initialized 1 1 The session is initialized.
kss_LogonInProgress 2 2 The user login is in progress.
kss_Idle 3 3 The session is idle.
kss_Established 5 5 The session is established.
kss_AttentionReq 6 6 The session requires the user's attention.
kss_LogonDenied 7 7 Login was denied.
kss_LoggedOut 8 8 The user is logged out of the server.
Table of Contents | << Previous Chapter | Next Chapter >>
Contact Support Contact Support

Have a Question?

Support and Sales >

About F5

Education

F5 Sites

Support Tasks




©2023 F5 Networks, Inc. All rights reserved.


Trademarks Policies Privacy California Privacy Do Not Sell My Personal Information