gasadmin tool

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

Links to examples of some of the more common uses of the tool are grouped under headings: manage sessions, manage applications and clients, manage logs, GAS configuration, and display information:

Syntax 1

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

Syntax 2: with commands (session, config, gar, gbc, reset-log)

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

gasadmin commands

The gasadmin tool supports five commands:
  1. gasadmin session [options]
    The session command administers GAS sessions (default). Options are described in Table 2.
  2. gasadmin config [options]
    The config command handles GAS configuration. Options are described in Table 3.
  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

  4. gasadmin gbc [options]
    The gbc command deploys Genero Browser Client (GBC). Options are described in Table 5.
  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
--version

 Display GAS version information.

-h
--help

 Displays help for the gasadmin command.
Table 2. gasadmin session command options
Option Description
-h

--help

 Displays help for the command.
-q

--quiet

 Operates in silent mode
-p directory-name

--as-directory directory-name

Specify the Genero Application Server directory.
-f filename

--configuration-file filename

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

 Stop (kill) all active sessions by requesting each proxy to stop. The user agent is notified with error messages.

-k session-id   

--kill-session session_id   

Stop the specified session id . The user agent is notified with error messages. See Stop dispatcher sessions.
--close-all-sessions Close all active sessions. No messages are sent to the user agent. Sessions are closed gracefully.
--close-session session_id Close the specified session id. No message is sent to the user agent. The session is closed gracefully. See Close dispatcher sessions.

-X

--ping-all-sessions

 Ping all active sessions. See Ping dispatcher 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 command.
-q

--quiet

 Operates in silent mode
-p directory-name

--as-directory directory-name

Specify the Genero Application Server directory.
-f filename

--configuration-file filename

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.

-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 config_file_name

--configuration-explode-external  config_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.
--list Lists all applications and services (not just the deployed ones) found in the GAS.
--xml-output Output result in XML format (for --list option only).
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.
-f configuration-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 static GBC ( those configured in the as.xcf) and deployed clients 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.
-f configuration-file

--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.

-d dispatcher-name

--dispatcher dispatcher_name

Target the dispatcher - used by session-related options to select the target dispatcher.
--output-type { CONSOLE | DAILYFILE} Log type (CONSOLE or DAILYFILE), default is DAILYFILE.
--output-path output_dir Log output directory for DAILYFILE, default is the current directory.
--raw-data-max-length max Data max length, default is -1.
--format column-headings Log format, columns to output, the default is: time event-type event-params.
--categories category-list Log categories to enable, the default is: GAS ACCESS PROCESS ERROR

Session command examples

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

Ping dispatcher sessions

This example shows how to use -X -f -d options to ping all sessions of a specified GAS configuration file. This effects sessions running on the specified dispatcher. 
gasadmin session -X -f as1.xcf -d httpdispatch
The GAS outputs the reply from all current sessions. The output displays the session id, which is a long string, for example, "96c9ce0ded72135ddf43ad421a2d87b9" with the name of the service or application in parenthesis. If the ping is successful, the reply from the dispatcher is OK.
Checking all sessions: (httpdispatch)
Ping session 96c9ce0ded72135ddf43ad421a2d87b9 (demo/RestBook): OK
Ping session dfd29c347ecf2d572aef95a13c6d4a04 (_default/gwc-demo): OK

List dispatcher sessions

This example shows you how to use the -l option to list all sessions. The -d option specifies the dispatcher. 
gasadmin session -l -d httpdispatch

The output displays a list of the sessions. It includes the following details:

  • the session identifier. This represents the GAS session for the application or Web service. In the example, "96c9ce0ded72135ddf43ad421a2d87b9" is the session for the demo/RestBook Web service.
  • Port: this is the port number the dispatcher is listening on
  • Type: identifies the type of session (service or application)
  • Pid: this is the process id number
  • GSID: this is the Genero session id used by Web applications. (for example, "1a5569ed45193a6abd7a2e8e67199300")
    Note: The GSID is used by the browser to keep track of the session of a Web application. The value is stored in a cookie. GSID is not used by Web services.
Session list: (httpdispatch)
  - 96c9ce0ded72135ddf43ad421a2d87b9 (demo/RestBook)
    Port: 51744
    Type: WebServices
    Pid : 7708
    GSID:
  - dfd29c347ecf2d572aef95a13c6d4a04 (_default/gwc-demo)
    Port: 51732
    Type: UA Client
    Pid : 8632
    GSID: 1a5569ed45193a6abd7a2e8e67199300

Stop dispatcher sessions

If you need to stop a session, you use the -k option of the gasadmin session command for this purpose.

This action effects the specified session id, "d98290172c8f7c0d861db329f1ce6597" in the example. With the option -f you can specify the configuration file. The -d option you specify the dispatcher where the session is running.
gasadmin session -k d98290172c8f7c0d861db329f1ce6597 -f as1.xcf -d isapidispatch
Tip: You can use the -K option to terminate (kill) all active sessions.

Close dispatcher sessions

If you need to stop a session gracefully and therefore not send messages to the user agent, use the close session option instead of the -k (kill) option. The --close-session option runs the gasadmin command on the TCP_ADMIN_PORT port for this purpose.

In the example the close session action effects the specified session id, "d98290172c8f7c0d861db329f1ce6597". With the option -f you can specify the configuration file. The -d option specifies the dispatcher where the session is running.
gasadmin session --close-session d98290172c8f7c0d861db329f1ce6597 -f as1.xcf -d isapidispatch
Tip: You can use the --close-all-sessions option to close all active sessions on the dispatcher.

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:\fjs\gbc-projects\gbc-1.00.53\archive\custA.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 custB
Figure: List deployed GBC and set default

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
Figure: Sample GAS Version Information

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