Start of change

DSNTWLMB tool

The DSNTWLMB tool provides a batch interface for defining, installing, and activating WLM environments. This tool is invoked by job DSNTIJRW to create the core DB2® WLM environments.

Authorization

If the RACF® facility class is active and a profile has been defined for the MVSADMIN.WLM.POLICY facility class, the user of this tool needs the following access:

  • ACCESS(READ) for action WLMINFO
    PERMIT MVSADMIN.WLM.POLICY CLASS(FACILITY) ID(user) ACCESS(READ)
  • ACCESS(UPDATE) for action ADD, ADD_ACTIVATE, ACTIVATE
    PERMIT MVSADMIN.WLM.POLICY CLASS(FACILITY) ID(user) ACCESS(UPDATE)

Parameter descriptions

The batch program accepts the following parameters:
ACTION(action-type)
Identifies the type of action that is to be performed. This parameter is required and it supports the following values:
ACTIVATE
The batch program activates a WLM service policy.
ADD
The batch program installs a new WLM application environment to an existing WLM service definition without activating a service policy. The new WLM application environment becomes available on the next activation of a WLM policy.
ADD_ACTIVATE
The batch program installs a new WLM application environment to an existing WLM service definition and activates a WLM service policy to enable the new WLM application environment.
WLMINFO
The batch program queries the existing WLM service definition and returns basic information.
POLICY(policy-ID)
Identifies the WLM service policy that is to be activated. This parameter is required if any of the following actions are specified:
  • ACTIVATE
  • ADD_ACTIVATE

The service policy ID can be 1 – 8 characters or "ACTIVE". If "ACTIVE" is specified as the policy ID, the current active service policy is used.

SYSIN parameters

If the specified action is ADD or ADD_ACTIVATE, additional input is required from SYSIN to provide details about the WLM environment that is to be installed. The additional information can be entered from the SYSIN DD statement. The parameters can be entered on one line (up to 72 characters per line) or multiple lines, and they should be separated by one or more spaces.

The following parameters are supported under SYSIN DD:

WLMNAME(name)
The defined name for an application environment. The name can be 1 – 32 characters and cannot begin with "SYS". This is a required parameter.
DESCRIPTION(description)
A 32 character area that describes the application environment. This parameter can be set to an empty value. For example:
DESCRIPTION()
PROCNAME(procedure-name)
Defines the JCL procedure that WLM uses to start server address spaces for the application environment. This is a required parameter.
STARTPARM(start-up-parameters)
Contains the parameters that WLM uses to start the JCL procedure. The parameters can be up to 115 characters, or it can be set to an empty value. If the parameters include the subsystem name, you can use the symbol &IWMSSNM to cause WLM to substitute the subsystem name instead of directly typing the subsystem name. This is useful because multiple instances of the subsystem with different names can use the application environment. For example:
STARTPARM(DB2SSN=&IWMSSNM,APPLENV=WLMENV1,NUMTCB=1)
WLMOPT(WLM_MANAGED|SINGLE_SERVER)
Tells WLM whether it should limit the number of server address spaces that are created. For a single system, the WLM_MANAGED option means that any number of servers can be created for the subsystem on the system where it is connected to Workload Manager. In a sysplex, WLM_MANAGED means that servers can be created for the subsystem on any number of systems in the sysplex. If multiple DB2 subsystems are on a system, WLM will create one server for each DB2 subsystem that calls the routines.

The SINGLE_SERVER option means that only one address space can exist per system. For DB2-supplied routines, you can set a limit of one address space per system if this limit is required by the routine. For example, if a server address space requires exclusive use of a resource, only a single address space can exist. Use this option if a stored procedure cannot execute concurrently in multiple address spaces. This option should be used if a stored procedure is to be run in debug mode and writes to a trace. A limit of one address space per sysplex does not apply to DB2-supplied routines.

This parameter can be set to an empty value and will default to WLM_MANAGED.

End of change