OPS/REXX Built-in Functions › OPSWLM Function

OPSWLM Function

The OPSWLM OPS/REXX function performs one of the following operations:

• Retrieves information about the state of a WLM scheduling environment available on a specified system. A scheduling environment is a group of some number of resources, each with a required state. If all of the resources are in the required state, then the scheduling environment is available. If any of the resources is not in the required state, then the scheduling environment is not available.
• Sets the status of a WLM scheduling environment resource.

Note: You can use the OPSWLM function in OPS/REXX or AOF rules.

OPSWLM has the following format:

var = OPSWLM('{func}','{name}'[,['arg3']])

func

Specifies the type of function that you want the OPSWLM function to perform.

Important! Always specify the func argument.

The only valid function codes for OPSWLM are:

I

Retrieves information about the state of a WLM scheduling environment. This function determines if a scheduling environment is available on a specified system. This function code can be used in any environment where OPS/REXX can be used. To get meaningful results, only specify the names of scheduling environments that are defined in the active service policy.

S

Sets the status of a WLM scheduling environment resource. This function code can only be used in real AOF rules. When used in AOF Test, no action is taken and a fixed result string is returned. To get meaningful results, only specify the names of scheduling resources that are defined in the active service policy on this system.

Q

Query. This function code is reserved for future use and must not be used.

name

The value that you specify for the required name argument depends on the function code:

• For function code I, specify the name of a WLM scheduling environment.
• For function code S, specify the name of a WLM scheduling environment resource.

arg3

The value that you specify for the arg3 argument depends on function codes I or S.

• For function code I, specify the name of the system on which you want to check the status of the WLM scheduling environment whose name you specified in the name argument. If you do not specify this argument, the local system name is used.

  In this context, system name refers to the z/OS SYSNAME parameter value as specified in logical parmlib member IEASYSxx. You can specify the name of any system that is part of the same sysplex as the system on which this function is executing.

  When you use the I function code, the following values can return:

  AVAIL

  The scheduling environment on the designated system is available.

  NOTAVAIL

  The scheduling environment on the designated system is not available.

  NOTSUPPT

  The system does not support scheduling environment services. This return code is set for unsupported versions of the operating system.

  NOTEXIST

  The named scheduling environment does not exist on the designated system.

  ERROR RC=nn RS=xxxxxxxxx

  The IBM IWMSEDES service returned an unexpected return code and reason code combination. This string contains the return code (in decimal) and reason code (in hexadecimal) from the IWMSEDES service. In addition, message OPx4280E is issued and contains similar information. Check the IBM documentation for the WLM IWMSEDES service and attempt to diagnose and correct the problem. If you are unable to resolve the problem, contact CA customer support and provide them with the AOF rule or OPS/REXX program and the exact contents of this value.

  For assistance, contact Customer Support at http://ca.com/support

  OPSDOWN

  The CA OPS/MVS main address space is not active.

  ABEND

  An abend occurred either in the OPSWLM function or in the product WLM service routine. Check the OPSLOG for message OPx9500S. The message indicates the abend code and the module name and offset where the abend occurred. For assistance, contact Customer Support at http://ca.com/support.

• For function code S, specify the state to which you want the WLM scheduling environment resource to be set. The only allowable values are ON, OFF, and RESET.

  Important! Always specify this argument.

  When you use the S function code, the following values can return:

  OK

  This string indicates that the state of the designated WLM scheduling environment resource was set as directed.

  NOTSUPPT

  The system does not support scheduling environment services. This return code is set for unsupported releases of the operating system.

  NOTEXIST

  The named resource does not exist. Check the name argument. If the specified resource name is correct, check whether the resource is defined in the active WLM service policy.

  ERROR RC=nn RS=xxxxxxxxx

  The IBM IWMSESET service returned an unexpected return code and reason code combination. This string contains the return code (in decimal) and reason code (in hexadecimal) from the IWMSESET service. In addition, message OPx4280E is issued and contains similar information. Check the IBM documentation for the WLM IWMSESET service and attempt to diagnose and correct the problem. If you are unable to resolve the problem, contact CA customer support at http://ca.com/support and provide them with the AOF rule or OPS/REXX program and the exact contents of this value.

  OPSDOWN

  The CA OPS/MVS main address space is not active.

  ABEND

  An abend occurred either in the OPSWLM function or in the product WLM service routine. Check the OPSLOG for message OPx9500S. The message indicates the abend code and the module name and offset where the abend occurred. For assistance, contact customer support at http://ca.com/support

  AOF_TEST

  The Set function code was used in AOF Test.

Note: A syntax error (for example, using an invalid function code) in the function call statement causes an OPS/REXX error 40, Incorrect Call to Routine.