PASOE Management: trimming agents and agent sessions

The scl-agent-trim.cmd script is one of the https://consultingwerk.atlassian.net/wiki/spaces/SCL/pages/8094029 ; more details about running the script can be found at that link. It provides the ability to trim

  • all agents

  • a single agent

  • a single agent session within an agent

Optional termination options are supported for graceful or forced trimming.

Standard/common parameters

Name

Valid values

Notes

Name

Valid values

Notes

-s

Port number the instance is running on.

Required

-h

The hostname the instance is running on. May be a host name or IP address

  • Optional.

  • Default value = localhost

-a

The ABL application name

  • Optional but SHOULD be specified

  • Default value = root

-u

A username for connecting to the oemanager webapp

  • Optional.

  • Default value = tomcat

-p

The user’s password for connecting to the oemanager webapp

  • Optional.

  • Default value = tomcat

-debug

None.

  • Optional

  • Prints PROPATH on startup

Control parameters

Name

Valid values

Notes

Name

Valid values

Notes

-agentid

The PID of an agent

  • Optional. If NOT specified, all agents will be trimmed (except if -sessionid is specified

  • Values are expected as integers

-sessionid

The ID of an agent (ABL) session.

  • Optional.

  • If specified, the -agentid parameter MUST be specified

  • Values are expected as integers

Optional parameters

All of the parameters in the table below are optional. If not provided, default values are used (generally 0).

Name

Valid values

Notes

Name

Valid values

Notes

-terminateopt

0 , 1, 2

Terminate options, represented by the Consultingwerk.Studio.Pasoe.TerminationOptions enum. A non-zero value is used as the terminateOpt parameter on the request to trim an agent session.

-waitfinish

0 ..

Values are expected in milliseconds. A non-zero value is used as the waitToFinish parameter on the request on the request to trim an agent.

-waitstop

0 ..

Values are expected in milliseconds. A non-zero value is used as the waitAfterStopparameter on the request on the request to trim an agent.