The gasadmin tool

The gasadmin tool is provided as an administrative command for the Genero Application Server.

With this tool, you can, for example:

Display GAS version information. See Display GAS version information.
Specify the GAS application directory. See Specify GAS directory .
List all sessions. See List sessions.
Stop sessions. See Kill sessions.
Validate the GAS configuration. See Validating with the gasadmin tool.
Explode GAS configuration resources. See Explode configuration file.
Ping active sessions. See Ping active sessions.
Manage archive files. See Deploying and managing applications with GAR.
Manage Genero Browser Clients deployed in the GAS. See GBC command examples.
Reset the log output for a session. See Reset logs.
Retrieve information to monitor a session. See Monitor session.

Syntax

gasadmin { -V | -h | command [options] }

Syntax with commands

gasadmin { session|config|gar|gbc|reset-log [options] }

gasadmin commands

The gasadmin tool supports five commands:

```
gasadmin session [options]
```
The session command administers GAS sessions (default). Options are described in Table 2.
```
gasadmin config [options]. 
```
The config command handles GAS configuration. Options are described in Table 3.
```
gasadmin gar [options] 
```
The gar command deploys Genero archives (gar) files. Options are described in Table 4.
Important: If you start the dispatcher with the option (-E) to override the $(res.appdata.path) location, you must also override the resource when deploying applications with the gasadmin gar command, in order to deploy to the correct directory.
For example, specify the same option with both commands:
- Starting the dispatcher:
  httpdispatch -E res.appdata.path=/work/tmp/gas/appdata
- Deploying the application:
  gasadmin gar -E res.appdata.path=/work/tmp/gas/appdata --deploy-archive myapp.gar
```
gasadmin gbc [options] 
```
The gbc command deploys Genero Browser Client (GBC). Options are described in Table 5.
```
gasadmin reset-log [options ] [session-id ...]
```
The reset-log command reconfigures the logs for one or more sessions. Options are described in Table 6.

Options

Table 1. gasadmin version and help options
Option	Description
`-V` or `--version`	Display GAS version information.
`-h` or `--help`	Displays help for the gasadmin commands.

Table 2. gasadmin session command options
Option	Description
`-h` `--help`	Displays help for the session command.
`-q` `--quiet`	Operates in silent mode
`-p` `directory_name` `--as-directory` `directory_name`	Specify the Genero Application Server directory.
`-fconfiguration-file` `--configuration-fileconfiguration_file_name`	Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used.
`-E` `resource_name=value` `--resource-overwrite` `resource_name=value`	Define or overwrite a resource.
`-d` `dispatcher-name` `--dispatcher` `dispatcher_name`	Target the dispatcher - used by session-related options to select the target dispatcher.
`-K` `--kill-all-sessions`	Terminate (kill) all active sessions by requesting each proxy to stop.
`-k` `session-id` `--kill-session` `session_id`	Terminate (kill) the specified session id. See Kill dispatcher sessions
`-X` `--ping-all-sessions`	Ping all active sessions.
`-x` `session-id` `--ping-session` `session_id`	Ping the specified session id.
`-l` `--list-sessions`	List all known sessions. See List dispatcher sessions
`-C` `--session-cleanup`	Clear remaining Linux®/UNIX™ domain sockets and delete temporary files/directories created, that may not have been removed at the end of a session. See Cleanup session.
`--monitor`	Retrieve monitor information for a session. Information is displayed in XML format on the standard output. See Monitor session.

Table 3. gasadmin config command options
Option	Description
`-h` `--help`	Displays help for the config command.
`-q` `--quiet`	Operates in silent mode
`-p directory_name` `--as-directory directory_name`	Specify the Genero Application Server directory.
`-f configuration_file_name` `--configuration-file configuration_file_name`	Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used.
`-E resource_name=value` `--resource-overwrite resource_name=value`	Define or overwrite a resource with a value.
`-c` `--configuration-check`	Checks the configuration file and exits. See Validating with the gasadmin tool.
`-e` `--configuration-explode`	Explode the GAS configuration into a hierarchy of configuration elements and output to file in XML format, one for each application.
`-t configuration_file_name` `--configuration-explode-externalconfiguration_file_name`	Explode the given external configuration file in current directory. See Explode configuration file into an XML file
`-r` `--configuration-expand-resources`	Expand resources and replace with real values. Used with `--configuration-explode` or `--configuration-explode-external`. See Explode configuration file into XML files
`-z paths , [...]` `--compress-resources paths, [...]`	Compress the resources located in specified paths. The path separator is a comma (,). See Compress resources.

Table 4. gasadmin gar command options
Option	Description
`-h` `--help`	Displays help for the gar command.
`-p directory_name` `--as-directory directory_name`	Specify the Genero Application Server directory.
`-f configuration_file_name` `--configuration-file configuration_file_name`	Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used.
`-E resource_name=value` `--resource-overwrite resource_name=value`	Define or overwrite a resource with a value.
`--deploy-archive archive_file`	Unpack the given archive content into the deployment directory.
`--undeploy-archive archive_file`	Undeploy the given archive.
`--enable-archive archive_file`	Expose all services and applications contained in the given archive.
`--disable-archive` `archive_file`	Unexpose all services and applications contained in the specified archive.
`--list-archives`	List all archives deployed on the Genero Application Server.
`--clean-archives`	Clean up all undeployed archives.
`--xml-output`	Output result of command in XML format. Only compatible with archive options.
`-y` `--yes`	Do not prompt for confirmation.

Table 5. gasadmin gbc command options
Option	Description
`-h` `--help`	Displays help for the gbc command.
`-p` `directory_name` `--as-directory` `directory_name`	Specify the Genero Application Server directory.
`-fconfiguration-file` `--configuration-fileconfiguration_file_name`	Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used.
`-E` `resource_name=value` `--resource-overwrite` `resource_name=value`	Define or overwrite a resource.
`--deploy gbc_content`	Unpack given GBC content into the deployment directory defined by the `res.gbc.deployment` resource. See Deploy GBC.
`--undeploy gbc_content`	Remove the given GBC content. If the undeployed GBC is the current default, the new default will be the one embedded in the FGLGWS package.
`--default gbc_client`	Set the specified GBC as default client. See Set default GBC
`--list`	List all GBC clients deployed on the Genero Application Server.
`--reset`	Reset to initial delivered GBC in the FGLGWS package.
`--rename` `old_gbc_name=new_gbc_name`	Rename the given GBC. Note: The GBC client set as default, can not be renamed as it may be in use.
`--xml-output`	Output result of command in XML format.

Table 6. gasadmin reset-log command options
Option	Description
`-h` `--help`	Displays help for the reset-log command.
`-q` `--quiet`	Operates in silent mode
`-p` `directory_name` `--as-directory` `directory_name`	Specify the Genero Application Server directory.
`-fconfiguration-file` `--configuration-fileconfiguration_file_name`	Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used.
`-E` `resource_name=value` `--resource-overwrite` `resource_name=value`	Define or overwrite a resource.
`-d` `dispatcher-name` `--dispatcher` `dispatcher_name`	Target the dispatcher - used by session-related options to select the target dispatcher.
`--output-type <arg>`	Log type (`CONSOLE` or `DAILYFILE`), default is `DAILYFILE`. See Reset-log command examples.
`--output-path` `<arg>`	Define the output directory where the `DAILYFILE` log file is stored. If you do not specify an output directory, gasadmin uses the value defined in the `LOG` configuration from the as.xcf.
`--raw-data-max-length` `<arg>`	Define the max length of a log message. See RAW_DATA. If you do not specify the data max length, gasadmin uses the value defined in the `LOG` configuration from the as.xcf.
`--format` `<arg>`	Define the columns to output as the format of the log message. See FORMAT. If you do not specify the column headings, gasadmin uses the values defined in the `LOG` configuration from the as.xcf.
`--categories` `<arg>`	Define the log categories to enable. See CATEGORIES_FILTER. If you do not specify the log categories, gasadmin uses the values defined in the `LOG` configuration from the as.xcf. See Reset-log command examples.

Session command examples

These examples show how you use the gasadmin session command to work with sessions.

List dispatcher sessions

This examples shows you how to use -X -f -d options to list all sessions of a specified GAS configuration file. This effects sessions running on the specified dispatcher.

gasadmin session -X -f as1.xcf -d httpdispatch

Kill dispatcher sessions

If you need to stop a session, this example shows you how to use the -k option of the gasadmin session command for this purpose. This action effects the specified session id, "d98290172c8f7c0d861db329f1ce6597" in the example. With options

-f
-d

you can specify the configuration file in use and the dispatcher where the session is running.

gasadmin session -k d98290172c8f7c0d861db329f1ce6597 -f as1.xcf -d isapidispatch

Note: You can use the -K option to terminate (kill) all active sessions.

Cleanup session

This example shows you how to perform a cleanup on the GAS to remove temporary files or directories that may have been used during a session.

gasadmin session --cleanup-session -d <dispatcher>

The -d or --dispatcher option is required to specify the dispatcher. The dispatcher is specified as either httpdispatch, isapidispatch, or fastcgidispatch.

Note: This cleanup is performed automatically at dispatcher start up.

If your GAS version is prior to 3.10, you need to use the following command:

gasadmin --session-cleanup -d <dispatcher>

Monitor session

This example shows how to use the --monitor option to retrieve information to monitor a specified session. Information on the current status of the dispatcher is sent to the standard output in XML format during the session.

gasadmin session --dispatcher <dispatcher> --monitor <session-id>

The -d or --dispatcher option is required to specify the dispatcher.

If your GAS version is prior to 3.10, you need to use the following command:

gasadmin --dispatcher <dispatcher> --monitor <session-id>

Config command examples

These examples show how you use the gasadmin config command to work with configuration files.

Explode configuration file into an XML file

This example shows how you use the -t option of the gasadmin config command to explode the specified application configuration file and expand its resources and its parent's resources into an XML file.

gasadmin config -t demo/Card

Explode configuration file into XML files

This example shows how you use the -r -t options to explode the specified application configuration file. This causes its resources and its parent resources to be replaced with real values. The result is output in separate XML files.

gasadmin config -r -t demo/Card

Compress resources

This example shows how you compress the resources located in the specified paths.

gasadmin config -z $FGLASDIR/app,$FGLASDIR/services,$FGLASDIR/web,$$FGLASDIR/tpl

GBC command examples

These examples show how you use the gasadmin gbc command to manage GBC clients.

Deploy GBC

This example shows how you can use the gasadmin deploy command to deploy a GBC client on the GAS.

gasadmin gbc --deploy c:\tmp\gbc-1.10.30.zip

Set default GBC

These examples show how you can use gasadmin deploy command to list the deployed GBC clients and set a default client on the GAS.

gasadmin gbc --list

gasadmin gbc --default gbc-1.10.30

Images shows the result of the gasadmin commands to list deployed GBC and to set the default client

Reset-log command examples

This example shows how you can use the gasadmin reset-log command to reconfigure the log output.

Reset logs

gasadmin reset-log --output-type CONSOLE --categories "ALL DEBUG" 1170f560ca4d03fd3aa4bbac75da97e9

The example command uses options for --output-type and --categories. The output type effects where the logs are sent, either the console or the daily log file (DAILYFILE). The categories effects the type of logs output. These changes only effect the specified session.

Tip: You can specify multiple sessions by listing the session ids, separated by spaces.

If an option (for example, --output-path) is not specified, gasadmin tries to use the LOG configuration from the as.xcf. If not found in the as.xcf (for example, CONSOLE may not be configured in as.xcf), default values are used.

Display GAS version information

gasadmin -V

Image shows GAS version and build information displayed when the gasadmin -V command is run