Setting Gateway Options on the Command Line

Entering Arguments on the Command Line

Arguments with a value can be specified using either of the following methods (tag is case-insensitive):


`tag:VALUE`	For example: `gateway model:i_beam.zmf` or `rt_gateway model:i_beam.zmf` There must be no spaces between the tag and value.
`-tag VALUE`	For example: `gateway -model i_beam.zmf` or `rt_gateway -model i_beam.zmf` There must be at least one space between the tag and value.

Only the second format can be used for single-letter tags, as the first format would resemble a Windows path.

Arguments without a value can be specified in either format also:


`-tag`	Turns on the feature.
`tag:y`	Turns on the feature (same as above). The `y` is required.

If you use more than one command line argument and the two are in conflict with each other, the later argument overrides the earlier one.

If an argument contains spaces, enclose it in single quotation marks or double quotation marks on the Linux command line or in interactive mode. On the Windows command line, always use double quotation marks. For example:

start file:'model test.zmf'
fipercmd start file: "C:\documents and settings\user\mymodel.zmf"

`<no_argument>`

Not specifying an argument with the gateway command or the rt_gateway command opens the gateway with no model loaded.

`<model-name>.zmf`

Allows you to specify a particular model that will be loaded into the gateway. You can also use the two alternative forms of this argument: -m <model_name> and model:<model_name>.

`-config`

This Runtime Gateway argument prompts you to configure your model before executing, allowing you to do such things as update parameter values or customize the job name. The argument must be used with the run option. For more information, see Setting Execution Options and Running a Job.

`configfile:<file_name>`

This argument is interchangeable with the @FILENAME argument. For more information, see the entry for @FILENAME below. However, the syntax is different as shown below:

gateway configfile:acs.txt

rt_gateway configfile:acs.txt

`@FILENAME`

This argument allows you to read a set of command line arguments from a specified file. The file must be a text file containing command line arguments as they would typically appear on a command line.

For example, if you had a file acs.txt in your home directory that contained the following entries:

profile:acs1 logonprompt:no
# provide user name and password to connect
user:fiperacs pw:fiperacs

you could start the gateway connected to a SIMULIA Execution Engine with the following command (which assumes that the acs.txt file is located in the current working directory):

gateway @acs.txt

rt_gateway @acs.txt

You can also specify an absolute path to the directory containing the acs.txt file:

gateway "@c:\documents and settings\user\acs.txt"

rt_gateway "@c:\documents and settings\user\acs.txt"

Furthermore, you can mix and match the contents of the file with the actual command line option at the command prompt. For example:

gateway @acs.txt logonprompt:yes

rt_gateway @acs.txt logonprompt:yes

Using the contents of the file created earlier, this argument would show the logon dialog box (logonprompt command) even though the file provided everything necessary and also instructed the logon dialog box to not appear.

The file you create can contain one or more lines. Each line can contain one or more command line arguments. Arguments with spaces must be contained within single or double quotation marks. Comment lines are allowed (any line starting with # is ignored). Empty lines are also ignored.

Note: This command automatically creates gateway log files. By default, two log files are created, with the second log file being used once the first log file reaches its maximum size. You can specify the name and location of these log files using the logfile command described below. In addition, you can set the size of the log files as well as the number of log files that can be created using the -Dfiper.logging commands described in Using the FIPER_JVMPARMS Variable.

This argument is interchangeable with the configfile argument.

`-help`

Prints information about the available command line arguments and exits.

`import:<job_name>.zrf`

Allows you to import the specified job as soon as the Runtime Gateway opens.

`importJob:<job_name>.zrf`

Allows you to load the specified job as soon as the Runtime Gateway opens. You can also specify a file name. You can use the shorter version of this argument: -j.

`input:<nv_file>`

Allows you to configure model inputs from the specified name-value file. The argument must be used with the run option.

`jobID`

Allows you to specify a job that will be loaded automatically from the Isight database when the Runtime Gateway is started. You must specify the Job ID string, not the job name. The Job ID string can be located using the Job Database interface (in the Job Details area at the bottom of the dialog box). For more information on the job database, see Using the Job Database Interface. When using this command, the Job ID string is not case-sensitive.

`lfd`

Saves execution log messages in the specified directory in a file named by the Job ID string. This argument can be used only in conjunction with the run argument. For example, the following command executes a model locally and saves the execution log messages in the c:\temp directory:

rt_gateway sample.zmf run:local lfd:c:\temp

`locale`

Sets the local (language environment) for the current session. It is useful only when testing support for a language.

For example, entering

gateway locale:ja

displays all messages in Japanese, or entering

rt_gateway -1 de_DE

displays all messages in German.

You can also use the shorter version of this argument: -l.

`logfile`

Allows you to specify a file name and a location for the Isight log file. By default, one log file is created. However, once the log file reaches its maximum size, the old file is saved and a new log file is created. If a third log file is necessary, the currently active log file is saved, but the original backup file (the first log file created) is deleted. You can adjust the maximum size of the log files and the number of backup (old) log files saved using the -Dfiper.logging commands described in Using the FIPER_JVMPARMS Variable.

`loglevel`

Allows you to determine what information is sent to the Isight log file. Components create different levels of log messages. You can define the minimum log information setting (debug), and you will receive information on that particular level and all other levels above it. For more information on log levels, see Setting Preferences.

`logonprompt:[yes|no]`

Allows you to specify if the Logon dialog box appears when the gateway is started. If you use this argument to stop the Logon dialog box from appearing, you must specify a profile name. The user name and password are needed when logging on to a SIMULIA Execution Engine using the arguments in this list. Failure to specify this information will cause the gateway to cancel the logon and exit because of the error.

`profile:<connection_profile_file_name>`

Allows you to specify the connection profile that the gateway uses. If you only specify this argument, the Logon dialog box will appear, and you will have to specify the name and password for the connection profile.

If you receive an error that the connection profile cannot be found, use a full path to the profile. For example:

gateway profile:\SIMULIA\Isight\2023\config\standalone.cpr


rt_gateway profile:\SIMULIA\Isight\2023\config\standalone.cpr

`pw:<password>`

Allows you to specify the password of the user that will log on to the gateway when connecting to a SIMULIA Execution Engine. It is not used for Standalone mode connections. If you specify only this argument, the Logon dialog box will appear, but the password will already be defined.

`-r`

Allows you to open the Runtime Gateway (instead of the Design Gateway) using the gateway command.

`run:[local|remote]`

Allows you to execute the specified model either locally (the local option) or on a SIMULIA Execution Engine (the remote option).

`tab`

Allows you to specify which tab is selected when the Runtime Gateway appears.

`tree`

Allows you to specify which component is selected on the model explorer (on the left side of the interface) when the Runtime Gateway appears. For example, the following would show the Aerodynamics Simcode component in the Airplane Sizing model.

rt_gateway model:AirplaneSizingDOE.zmf tab:History
"tree:SizingDOE.Aerodynamics"

`unix_user:<user_id>`

Allows you to specify a Linux user name when logging in using the SIMULIA Execution Engine extended grid credentials.

You can also use the alias of this argument: unix_name.

`unix_pw:<password>`

Allows you to specify a Linux password when logging in using the SIMULIA Execution Engine extended grid credentials.

`user:<user_id>`

Allows you to specify the user that will log on to use the gateway when connecting to a SIMULIA Execution Engine. It is not used for Standalone mode connections. If you specify only this argument, the Logon dialog box will appear, but the user name will already be defined.

`win_domain:<domain_name>`

Allows you to specify a Windows domain name when logging in using the SIMULIA Execution Engine extended grid credentials.

`win_user:<user_id>`

Allows you to specify a Windows user name when logging in using the SIMULIA Execution Engine extended grid credentials.

You can also use the alias of this argument: win_name.

`win_pw:<password>`

Allows you to specify a Windows password when logging in using the SIMULIA Execution Engine extended grid credentials.