Previous Topic

Next Topic

Book Contents

Book Index

FireScript Variables

Firescripts work with the login information provided by Progress WS_FTP Professional. This includes at least the user IDs and passwords, the IP address and port of the FTP server, and sometimes the IP address and port of the firewall. These fields are often read from a site profile, an FTP URL, or from the command line. As described before, if some of the required information is missing, the connect sequence presents the login dialog so that the user can enter it interactively. The script executive stores this information in a set of intrinsic variables before beginning execution. In addition there are intrinsic variables that contain the results of the last command issued. These are set by the script executive after such statements are executed.

The syntax for using a variable depends on the statement or expression in which it is used. Below is a list of all the intrinsic variables:

FireScript Intrinsic Variables

Variable

Meaning and Usage

FwUserId

The user's user ID on the firewall. Some firewalls require users to log in to the firewall before allowing other connections to be made through the firewall.

FwPassword

The user's password on the firewall. Required if the user must log in to the firewall.

FwAccount

Account on the firewall. Required if the user must specify an account on the firewall. Practically unheard of but included in case required.

FwAddress

The IP address of the firewall. Required if the user must connect to the firewall, and have the firewall in turn connect to the FTP server and act as proxy.

HostUserId

The user's ID on the FTP server. Almost always required. Specify 'anonymous' if the user does not have a user ID on the server.

HostPassword

The user's password on the FTP server. Almost always required in conjunction with a user ID. Use your email address as the password when using 'anonymous' for the user ID.

HostAccount

The user's account on the FTP server. To access certain information in some operating systems, FTP servers on those systems require an account to be sent after successful login with user ID and password.

HostAddress

The IP address of the host. The script executive may connect directly to this address, or will send the address to a firewall that will act as a proxy.

LastFtpCode

The 3-digit, numeric code of the last response received from the FTP server or firewall. For example, after a successful login, the LastFtpCode would be 230.

LastReply

The text of the last response from the server. e.g. "230 user logged in"

FireScripts neither need nor use user-defined variables, so there are no variable declarations. Also, since the FireScript cannot directly set the value of one of the intrinsic variables, there is no need for any assignment statements.

See Also

FireScript Editor

What is a FireScript?

FireScript Components

The Connection Sequence

The FireScript Language

String Expansion

Function Expressions

FireScript Statements

SSL Statements

FireScript Key Words

FireScript reserved words