gasadmin tool
The gasadmin tool is provided as an administrative command for the Genero Application Server.
- Manage sessions
- Manage Genero archive (gar) files.
- Manage Genero Browser clients.
- Manage logs for a session.
- GAS configuration
- Display GAS version information.
Syntax
gasadmin {
-V |
-h |
command [
options ]
[
args ]
}
- Display help or version information for the gasadmin command. Help is specific to commands and there is a help option for each command.
- command. There are six commands to administer the GAS:
- session administers application sessions.
- config handles GAS configuration.
- gar deploys and manages Genero archives (gar) files.
- gbc deploys and manages Genero Browser Clients (GBC) on the GAS.
- reset-log reconfigures the logs for sessions running on the GAS.
- monitoring monitors Web service on the GAS. This command supports six commands:
- options are specific to commands and these are described in the next paragraphs.
- args. Some commands have arguments and these are described in the next paragraphs.
Syntax 1: session command
gasadmin session [
options]
- The session command administers GAS sessions (default).
- options are described in Session options.
Syntax 2: config command
gasadmin config [
options]
- The config command handles GAS configuration.
- options are described in Config options.
Syntax 3: gar command
gasadmin gar [
options]
- The gar command deploys Genero archives (gar) files.
- options are described in gar options.
Syntax 4: gbc command
gasadmin gbc [
options]
- The gbc command deploys Genero Browser Client (GBC).
- options are described in gbc options.
Syntax 5: reset-log command
gasadmin reset-log [
options]
session-id [...]
- The reset-log command reconfigures the logs for one or more sessions.
- options are described in reset-log options.
- The session-id is a string that identifies the
session, for example
"
96c9ce0ded72135ddf43ad421a2d87b9
". One or more sessions may be specified.
Syntax 6: monitoring status command
gasadmin monitoring status [
options]
{
session-id |
service-name }
- The monitoring status command gets monitoring configuration status.
- options are described in monitoring status options.
-
The session-id is a string that identifies the
session, for example
"
96c9ce0ded72135ddf43ad421a2d87b9
". - The service-name identifies the Web service session. If
the service belongs to a group of services in the GAS, the format is
group-name/service-name
. For example, "demo/Calculator". If the service belongs to the default group of services in the GAS, there is no need to use the group name.
Syntax 7: monitoring update command
gasadmin monitoring update [
options]
{
session-id |
service-name }
- The monitoring update command sets the monitoring configuration.
- options are described in monitoring update options.
-
The session-id is a string that identifies the
session, for example
"
96c9ce0ded72135ddf43ad421a2d87b9
". - The service-name identifies the Web service session. If
the service belongs to a group of services in the GAS, the format is
group-name/service-name
. For example, "demo/Calculator". If the service belongs to the default group of services in the GAS, there is no need to use the group name.
Syntax 8: monitoring reset command
gasadmin monitoring reset [
options]
{
session-id |
service-name }
- The monitoring reset command resets the monitoring configuration.
- options are described in monitoring reset options.
-
The session-id is a string that identifies the
session, for example
"
96c9ce0ded72135ddf43ad421a2d87b9
". - The service-name identifies the Web service session. If
the service belongs to a group of services in the GAS, the format is
group-name/service-name
. For example, "demo/Calculator". If the service belongs to the default group of services in the GAS, there is no need to use the group name.
Syntax 9: monitoring fetch command
gasadmin monitoring fetch [
options]
session-id
- The monitoring fetch command retrieves monitoring data stored in .dat files.
- options are described in monitoring fetch options.
-
The session-id is a string that identifies the
session, for example
"
96c9ce0ded72135ddf43ad421a2d87b9
".
Syntax 10: monitoring clean command
gasadmin monitoring clean [
options]
- The monitoring clean command removes monitoring data stored in .dat files.
- options are described in monitoring clean options.
Syntax 11: monitoring preload command
gasadmin monitoring preload [
options]
command-file
- The monitoring preload command configures monitoring from commands stored in a file.
- options are described in monitoring preload options.
- command-file identifies the command file.
Options
Option | Description |
---|---|
|
Display GAS version information. |
|
Displays help for the gasadmin command. |
Option | Description |
---|---|
-h
|
Displays help for the command. |
-q
|
Operates in silent mode |
-p directory-name
|
Specify the Genero Application Server directory. |
-f filename
|
Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used. |
|
Define or overwrite a resource. |
|
Target the dispatcher - used by session-related options to select the target dispatcher. |
|
Stop (kill) all active sessions by requesting each proxy to stop. The user agent is notified with error messages. |
|
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. |
|
Ping all active sessions. See Ping dispatcher sessions. |
|
Ping the specified session id. |
|
List all known sessions. See List dispatcher sessions. |
|
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. |
Option | Description |
---|---|
-h
|
Displays help for the command. |
-q
|
Operates in silent mode |
-p directory-name
|
Specify the Genero Application Server directory. |
-f filename
|
Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used. |
|
Define or overwrite a resource. |
|
Checks the configuration file and exits. See Validating with the gasadmin tool. |
|
Explode the GAS configuration into a hierarchy of configuration elements and output to file in XML format, one for each application. |
|
Explode the given external configuration file in current directory. See Explode configuration file into an XML file |
|
Expand resources and replace with real values. Used with
--configuration-explode or --configuration-explode-external . See
Explode configuration file into XML files |
|
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). |
Option | Description |
---|---|
|
Displays help for the gasadmin command. |
-p directory-name
|
Specify the Genero Application Server directory. |
-f filename
|
Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used. |
|
Define or overwrite a resource. |
--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. |
|
Do not prompt for confirmation. |
Option | Description |
---|---|
|
Displays help for the gasadmin command. |
-p directory-name
|
Specify the Genero Application Server directory. |
-f filename
|
Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used. |
|
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. |
Option | Description |
---|---|
-h
|
Displays help for the command. |
-q
|
Operates in silent mode |
-p directory-name
|
Specify the Genero Application Server directory. |
-f filename
|
Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used. |
|
Define or overwrite a resource. |
|
Target the dispatcher - used by session-related options to select the target dispatcher. |
--output-type
|
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 |
Option | Description |
---|---|
-h
|
Displays help for the command. |
-q
|
Operates in silent mode |
-p directory-name
|
Specify the Genero Application Server directory. |
-f filename
|
Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used. |
|
Define or overwrite a resource. |
--session
|
Monitor the status of a session. |
--service
|
Configure monitoring for a service. While you typically include both the
group and the service name using the format " |
--xml-output
|
Output result of command in XML format. |
--file filename
|
Output result of command in file |
Option | Description |
---|---|
-h
|
Displays help for the command. |
-q
|
Operates in silent mode |
-p directory-name
|
Specify the Genero Application Server directory. |
-f filename
|
Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used. |
|
Define or overwrite a resource. |
--session
|
Configure monitoring for a session. |
--service
|
Configure monitoring for a service. While you typically include both the
group and the service name using the format " |
--enable
|
Enable monitoring. If monitoring a service (with
--service option) that it is not yet deployed, the GAS notifies you of this with a
message that the configuration is saved to load once the service is available. For an example, see Enable and disable web service monitoring. |
--disable
|
Disable monitoring. |
--level
|
Set the monitoring level to one of the valid options: ALARM,
MIN*, MEDIUM, or HIGH. The default is MIN. Note: Levels are case sensitive. |
--set-alarm
|
Set alarm of given name and optional threshold (for example,
DVM_NOT_STARTED=1 ) |
--unset-alarm alarm-name
|
Remove the alarm of given name. |
--list-alarm
|
List all alarm names and types. |
--xml-output
|
Output result of command in XML format. |
--file filename
|
Output result of command in file |
Option | Description |
---|---|
-h
|
Displays help for the command. |
-q
|
Operates in silent mode |
-p directory-name
|
Specify the Genero Application Server directory. |
-f filename
|
Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used. |
|
Define or overwrite a resource. |
--session
|
Reset monitoring for a session. |
--service
|
Configure monitoring for a service. While you typically include both the
group and the service name using the format " |
--xml-output
|
Output result of command in XML format. |
--file filename
|
Output result of command in file |
Option | Description |
---|---|
-h
|
Displays help for the command. |
-q
|
Operates in silent mode |
-p directory-name
|
Specify the Genero Application Server directory. |
-f filename
|
Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used. |
|
Define or overwrite a resource. |
--xml-output
|
Output result of command in XML format. |
--file filename
|
Output result of command in file. For examples using the
fetch command, see Fetch monitoring data. |
Option | Description |
---|---|
-h
|
Displays help for the command. |
-q
|
Operates in silent mode |
-p directory-name
|
Specify the Genero Application Server directory. |
-f filename
|
Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used. |
|
Define or overwrite a resource. |
--all
|
Remove all monitoring data for all sessions using the --all option on its own. Or
remove all data older than a given number of days using the --all --days
num_days option.Note:
session_id is not required when you specify --all . |
--days num_days [ session_id ]
|
Remove monitoring data older then given number of days starting from today for a given session id.
This option can also be used with the option --all . For examples using the
clean command, see Remove monitoring data. |
--file filename
|
Output result of command in file |
Option | Description |
---|---|
-h
|
Displays help for the command. |
-q
|
Operates in silent mode |
-p directory-name
|
Specify the Genero Application Server directory. |
-f filename
|
Specify the configuration file to use. If not specified, the default configuration file, $FGLASDIR/etc/as.xcf, is used. |
|
Define or overwrite a resource. |
-d
|
Specify the target dispatcher. This option is mandatory as the preload command must be run when the dispatcher is not running. See Configure monitoring with commands file. |
--force
|
Force overwriting of existing configuration |
--directory
directory-name
|
Specify the command file directory location |
--file filename
|
Output result of command in file |
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
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
-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 onType
: identifies the type of session (service or application)Pid
: this is the process id numberGSID
: 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.
d98290172c8f7c0d861db329f1ce6597
" in the example. With the
option -f
you can specify the configuration file. With the -d
option you specify the dispatcher where the session is running.gasadmin session -k
d98290172c8f7c0d861db329f1ce6597 -f as1.xcf -d isapidispatch
-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.
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
--close-all-sessions
option to close all active sessions on the
dispatcher.Cleanup session
gasadmin session --cleanup-session -d <dispatcher>
-d
or --dispatcher
option is required to specify the dispatcher. The
dispatcher is specified as either httpdispatch, isapidispatch, or fastcgidispatch.If your GAS version is prior to 3.10, you need to use the following command:
gasadmin --session-cleanup -d <dispatcher>
Monitor session
--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 -d httpdispatch --monitor d98290172c8f7c0d861db329f1ce6597
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>
Deploy with gar example
-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. - 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
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
-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
-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
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
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
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
--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. 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