In the following list of OPSINFO functions, functions marked with one asterisk (*) are valid only for JES2 users, and functions marked with two asterisks (**) are valid only for JES3 users. All other functions operate in both JES environments.
Returns ACCOUNT information for the current address space. Multiple accounting fields are returned separated by blanks.
Returns the value ACTIVE when the current REXX code is executing in the AOF Test environment, otherwise returns INACTIVE. Use this function to check whether a rule is executing in AOF Test.
Returns the job ID in one of the following formats:
Note: OPSINFO('JOBID') returns the same information but in a slightly different format.
Returns a value indicating the architecture level:
Returns the z/OS Address Space Identifier (ASID) number of the address space in which the CA OPS/MVS program issuing this function call is running. The value returned is two characters whose binary value is the ASID.
Returns the eight-byte binary value result of doing a STORE CLOCK on the CPU at the moment the function is called.
Returns a string containing the model number of the central processing complex (CPC) that this program is executing on. This value is related to the value returned by OPSINFO ('CPUMODEL'), but is in more meaningful format. For example, it returns the value R75 on an IBM 9672-R75, whereas the CPUMODEL value is 77. In cases of older processors where this information is unavailable, the value returned is identical to that returned by OPSINFO ('CPUMODEL').
Returns a string containing the dynamic model number of the central processing complex (CPC) on which this program is executing. The value returned by this function is usually the same as that returned by OPSINFO('CPCMODEL'), but it will be different in the following cases:
Notes:
Returns the count of zAAPs (zSeries Application Assist Processors) currently online.
Returns the count of zIIPs (zSeries Integrated Information Processors) currently online.
Returns the count of regular central processors (CPs) currently online.
Returns the six-character CPU identifier of the CPU where the OPS/REXX program or rule is running.
Returns the two-character CPU sub-model code of the CPU where the OPS/REXX program or rule is running. When running under VM this function returns the value FF.
Returns the configured CPU count. This value represents the number of CPUs that are in the configured state. A CPU is in the configured state when it is in the configuration and available for executing programs.
Returns the count of regular CPs and zAAPs (zSeries Application Assist Processors) and zIIPs (zSeries Integrated Information Processors) currently online.
Returns the reserved CPU count. This value represents the number of CPUs that are in the reserved state. A CPU is in the reserved state when it is in the configuration, is not available to be used to execute programs, and cannot be made available by issuing instructions to place it in the configured state.
Note: It may be possible to place a reserved CPU in the standby or configured state by means of manual actions.
Returns the standby CPU count. This value represents the number of CPUs that are in the standby state. A CPU is in the standby state when it is in the configuration, is not available to be used to execute programs, and can be made available by issuing instructions to place it in the configured state.
Returns the total basic CPU count. This value represents the total number of CPUs in the configuration. This number includes all CPUs in the configured state, the standby state, or the reserved state.
Note: CPUSTOTAL = CPUSCONFIG + CPUSSTANDBY + CPUSRESERVED
Returns the four-character CPU type (for instance, 9672) of the CPU where the OPS/REXX program or rule is running.
Returns the level of DFP running on the system where the OPSINFO function call was executed; in the form r.r, where r.r is the release number (for example, 3.3).
Returns the version of DFSMS in the form r.r, (for example, 1.5). If DFSMS is not installed, this OPSINFO function returns the string N/A. If you have installed DFSMS, the OPSINFO('DFPVERSION') function always returns the same value.
Returns the type of event the rule is processing, such as MSG or DOM. This function is intended for use in external OPS/REXX functions that may be called by more than one kind of rule.
When you use this function outside the rule environment (for example, in an OPS/REXX program in a server), it always returns the string NONE.
This function returns one of these values:
Returns the JES2 execution node ID. Under some conditions, the EXECNODEID function returns a 15-character string *NOT-AVAILABLE* instead of data. If the primary job entry subsystem is not JES2 or JES2 is not active when this function is called, the string NOT-AVAILABLE is returned.
Returns the name of the program specified on the EXEC PGM=progname JCL statement for the current step.
Returns the name of the exit in which the AOF captured the event that triggered this rule. This function returns one of these values:
A common use of OPSINFO('EXITTYPE') is to prevent processing a single message more than once in the IMS or JES3 environments.
Returns a string indicating the mode in which Global Resource Serialization (GRS) is executing. This function returns one of these values:
Returns the name of the processor configuration.
Returns the IMS identifier (IMSID) associated with the address space where the OPS/REXX program is running. NONE is returned if the address space is not an IMS Control Region, a DLISAS Region, a DBRC address space, a Message Processing Region, or a Batch Message Processing Region.
IMSID is of greatest interest to AOF message rules. For example, canceling an IMS BMP is dangerous because doing so can bring down all of IMS. A rule can use the OPSINFO function to:
Note: This function is available only if the IOF is licensed, installed, and active at your site. If the IOF is not installed or is inactive, this function always returns the string NONE.
The type of IMS region for the address space in which the current REXX program or rule is running. The possibilities are:
OPSINFO cannot determine if the address space is using batch DL/I facilities independent of any Control Region (even if using database- or block-level sharing through DBRC/IRLM).
Note: This function is available only if the IOF is licensed, installed, and active at your site. If the IOF is not installed or is inactive, this function always returns the three-character string NON.
Returns the name of the input device for a job. The input device can be an internal reader, a card reader, a remote workstation, or even a line connected to an NJE system. This variable enables you to specify installation policy based on where a job comes from: for example, to prevent a job that came in from LNE1 from exceeding the output limit. Under some conditions, the INPUTDEV function returns a 15-character string *NOT-AVAILABLE* instead of data. If the primary job entry subsystem is not JES2 or JES2 is not active when this function is called, the string NOT-AVAILABLE is returned.
Returns the date when z/OS was last IPLed (for example, 20030428 for April 28, 2003), in standard OPS/REXX date format S.
Returns the device number of the DASD volume from which the last IPL was performed, (for example, 9C01). This device number can have four hexadecimal digits.
Returns the time when z/OS was last IPLed (for example, 13:30:10 for 1:30 P.M. plus 10 seconds), in standard OPS/REXX time format N.
Returns a value representing how the system was last IPLed. This value is one of the following:
Returns the volume serial of the DASD volume from which the last IPL was performed, (for example, SYSRES).
Returns the value ACTIVE when ISPF is active in the current environment otherwise returns NOT ACTIVE. Use this function to check whether ISPF services can be used in the current OPS/REXX program.
Returns a 64-byte hexadecimal string containing data obtained from the consecutive four byte fields in the JES2 JCT ($JCT), starting at fields JCTUSER0 through JCTUSERF. This information is available to the installation and can be accessed in a CA OPS/MVS rule. Under some conditions, the JCTUSER function returns a 15-character string *NOT-AVAILABLE* instead of data. If the primary job entry subsystem is not JES2 or JES2 is not active when this function is called, the string NOT-AVAILABLE is returned.
Returns the name of the Primary Job Entry Subsystem. Typically, this value is either JES2 or JES3, but it can be any subsystem name that you have assigned to the primary JES (JES5, JES9, and so on). Contrast with the description of OPSINFO('JESTYPE').
Returns one of these values:
Available only in rules, the JES3SPOOL keyword obtains information about the prefix character JES3 is placing in front of each console message.
The OPSINFO('JES3SPOOL') function returns one of these values:
The last three conditions listed above correspond to separate message prefix characters.
Returns the ID of the JES on which CA OPS/MVS is active. For systems running JES2, this value is the SMF ID of the current z/OS system. For those running JES3, it is the MP name.
Returns a value that indicates whether the primary JES subsystem is a JES2 or JES3 subsystem. The returned value is always either JES2 or JES3, regardless of the actual subsystem name. For example, if the primary JES is called JES9 but it is a JES2 subsystem, the following values are returned:
OPSINFO('JES') = 'JES9'
OPSINFO('JESTYPE') = 'JES2'
Note: The value returned by OPSINFO('JESTYPE') may not be valid when the primary JES is not active in the system (for example, immediately following an IPL).
Returns the current job class. If used in a JES3 environment, this function returns the eight-character JES3 job class.
Returns the JES job identifier of the current home address space. This variable has one of the following formats:
If you are using this function in a message rule, then for more information see the description of the MSG.JOBID variable in the chapter “Coding Each AOF Rule Type” in the AOF Rules User Guide.
Returns the JOBNAME associated with the address space where the OPS/REXX program is running. For a message rule being processed in the z/OS SS09 exit, OPS/REXX returns the job name of the issuer of the WTO that triggered the rule. This means that for a reissued message that originated on another system the job name is the one that actually issued the WTO on the originating system.
Returns the LPAR configured CPU count. This value represents the number of logical CPUs for this level-2 configuration that are in the configured state. A logical CPU is in the configured state when it is in the level-2 configuration and is available to be used to execute programs.
Returns the LPAR reserved CPU count. This value represents the number of CPUs for this level-2 configuration that are in the reserved state. A logical CPU is in the reserved state when it is in the level-2 configuration, is not available to be used to execute programs, and cannot be made available by issuing instructions to place it in the configured state. (It may be possible to place the reserved CPU in the standby or configured state through manual actions.)
Returns the LPAR standby CPU count. This value represents the number of logical CPUs for this level-2 configuration that are in the standby state. A logical CPU is in the standby state when it is in the level-2 configuration, is not available to be used to execute programs, and can be made available by issuing instructions to place it in the configured state.
Returns the total LPAR CPU count. This value represents the total number of logical CPUs that are provided for this level-2 configuration. This number includes all of the logical CPUs that are in the configured state, the standby state, or the reserved state.
Note: LCPUSTOTAL = LCPUSCONFIG + LCPUSSTANDBY + LCPUSRESERVED
Returns the logical channel subsystem ID as a hexadecimal number. There are four logical channel subsystems in one processor. Each processor can have up to 1024 CHPIDs
Returns the leap seconds value in seconds. Use this value in conjunction with the OPSINFO('TIMEZONE') value to convert a GMT time to local time.
Note: Civil time is occasionally adjusted by one second increments to ensure that the difference between a uniform time scale defined by atomic clocks does not differ from the Earth's rotational time by more than 0.9 seconds. Coordinated Universal Time (UTC), an atomic time, is the basis for civil time.
Returns the eight-character IPL Load Parameter string specified on the service console when the system was last IPLed. For older versions of z/OS, OPS/REXX returns a zero length string.
Returns the first console name that has master authority on the local system. If there is no console that has master authority on the local system, the function returns the name of the sysplex master console. When a no consoles condition exists in the system, this function returns a null string.
Returns the LPAR name of the processor configuration. Returns a null string if not in LPAR mode.
Returns the LPAR number as a hexadecimal number. This number distinguishes the configuration from all other level-2 configurations provided by the same LPAR hypervisor.
Returns the REXX program name or the ruleset.rulename of the rule that invoked the currently executing REXX program. When the main program or rule is still executing, the returned value is the same as the value of OPSINFO('PROGRAM'). For example, suppose that program A calls program B, which, in turn, calls program C. The values returned to these programs would be as follows:
Returns the character string that was passed to CA OPS/MVS from the PARM field on its EXEC card when CA OPS/MVS was started. This string can contain up to 100 characters.
Returns the maximum number of lines that can be placed in the REXX External Data Queue (EDQ) at any one time for the current OPS/REXX program or rule (for example, 3000).
Returns the name of the module that triggered the AOF event. For example, in a message rule it returns the name of the module (program) that issued the WTO. When used in an OPS/REXX program running in a TSO address space or in a server it returns the name of a CA OPS/MVS module.
Use the following table to match products to modules:
|
Product |
Module |
Environment |
|---|---|---|
|
SDSF |
ISFMAIN |
TSO or batch |
|
TSOOPER |
OPER |
Command issued by TSO OPER |
|
MCS |
IEAVMQWR |
Command issued from an MCS console |
|
RCS |
BDNRCSCH |
Command or message issued by CA Remote Console |
|
MIC |
MIMCNSCH |
Command or message from CA MIC |
|
OPS/MVS |
OPSAEX |
Event created by a CA OPS/MVS command processor |
|
NetView |
DSIOST |
NetView |
|
NetView |
DSIPPT |
NetView |
Returns the string that contains the default system setting for the current OPS/REXX program. The current default system is set through the ADDRESS OPSCTL MSF DEFAULT SYSTEM(xxxx) host command.
Returns the value of the SYSID parameter. For details, see the description of the SYSID parameter in the Parameter Reference.
Returns the message class of a job. You can use it to determine output requirements for various printers. Under some conditions, the MSGCLASS function returns a 15-character string *NOT-AVAILABLE* instead of data. If the primary job entry subsystem is not JES2 or JES2 is not active when this function is called, the string NOT-AVAILABLE is returned.
Returns the name of the current MCS master console. When a no consoles condition exists in the system, this function returns a null string.
Returns the level of z/OS on which the OPSINFO function call was executed in the form version.release.modification level.
Returns the TSO user identifier who is notified when the job completes. This enables automation developers to send TSO user messages concerning their jobs. Under some conditions, the NOTIFYID function returns a 15-character string *NOT-AVAILABLE* instead of data.
Returns the current status of the OMVS kernel ('READY' or 'NOT READY').
Returns a string containing the OPSLOG message number associated with the current event. The result string always contains zeros when used in a non-AOF rule environment. This function is useful when used in conjunction with the OPSLOG( ) OPS/REXX function.
The result string contains zeros under the following conditions:
Returns the originating node of a job. You can use it to implement a security policy for your system, or (in combination with the Multi-System Facility) to inform users about the status of their jobs. Under some conditions, the ORIGINNODE function returns a 15-character string *NOT-AVAILABLE* instead of data. If the primary job entry subsystem is not JES2 or JES2 is not active when this function is called, the string NOT-AVAILABLE is returned.
Returns the Performance Group Number (PGN) of the currently executing address space. This value is always 0 when the system is running in GOAL mode.
Returns the value of the PRODUCTNAME parameter. For details, see the description of the PRODUCTNAME parameter in the Parameter Reference.
Returns the number of times that the current CA OPS/MVS subsystem has been started since the last time an IPL of z/OS occurred, or 0 if the subsystem has not been started since the last IPL.
When used in an OPS/REXX program, this function returns a valid value even if the CA OPS/MVS subsystem being queried is inactive.
Note: The only time that you can absolutely infer that the CA OPS/MVS product is down from using this function is if it returns 0. If it returns any other value, CA OPS/MVS could be either up or down. For example, a value of 1 could mean that it is either up or down but that it has been started once since the last IPL. To determine if a particular product subsystem is active, check if the RC value set by this command is 0:
ADDRESS AOF “SUBSYS ssid”
Returns the one of the following values:
Only rules can invoke this function. It returns a null string when a REXX program tries to invoke it. Typically, you might use this function:
Returns the name of the CA OPS/MVS started task or job, or INACTIVE if the product is not active.
In any environment other than a rule running under the CA OPS/MVS Automated Operations Facility (AOF), OPSINFO('PROGRAM') returns the name of the member from which OPS/REXX read the REXX program. If the OPS/REXX program was run from a sequential data set, which is rare, then OPSINFO('PROGRAM') returns a null string. In the AOF environment, OPSINFO('PROGRAM') returns ruleset.rule.
Returns the programmer information associated with the current address space. In the AOF environment, except when running in a server, the information returned is for the address space that triggered the AOF event.
Returns the size, in kilobytes, of the actual real storage online.
(Synonym for OPSINFO ('VERSION'). Returns an eight-byte string that provides the release and service pack number of the CA OPS/MVS product. The format of this string is rr.rr where rr.rr is the release number.
Thus, when using the OPSINFO('RELEASE') function to differentiate between code that may run on multiple versions of the CA OPS/MVS product, take into account that the modification level changes with each maintenance tape.
For example, to check for code that can run only with r11.5, use this function:
if SUBSTR(OPSINFO(“RELEASE”),1,6)==”11.06.” then . . .
To check for code that can run with r11.6 or higher levels, use this function:
if SUBSTR(OPSINFO(“RELEASE”),1,6)>=”11.06.” then . . .
Returns the room number associated with the output of the current address space. Under some conditions, the ROOM function returns a 15-character string *NOT-AVAILABLE* instead of data. If the primary job entry subsystem is not JES2, or JES2 is not active when this function is called, the string NOT-AVAILABLE is returned.
Returns the WLM service class name, up to a maximum of 8 characters. If the name does not exist, then N/A is returned.
Returns the SMF identifier that your site has assigned to the z/OS image on which CA OPS/MVS is running. z/OS gets this value at IPL time from the appropriate SMFPRMnn member of the Logical Parmlib Concatenation.
Returns a value indicating whether the SSM subtask has been requested to terminate. This value should be checked periodically by the AOF request rule called by the SSM subtask to determine if immediate exit from the rule is required.
The function returns one of these values:
Returns the current status of the System State Manager task. Possible values are:
Returns the name of the relational table that System State Manager is currently using or would use if it were active. Possible values are:
Returns the stepname or alternate task ID of the current address space. For example, if you issue the command S CICS.CICSA, the stepname for that address space is CICSA.
Returns the user ID that submitted the current job. If the primary job entry subsystem is not JES2, or JES2 is not active when this function is called, the string NOT-AVAILABLE is returned.
Returns the four-character z/OS subsystem name that CA OPS/MVS is using. The CA OPS/MVS product obtains this value from the first four characters of the PARM field on the EXEC statement in the JCL procedure used for CA OPS/MVS. The default subsystem name is OPSS.
Returns the one- or two-byte shorthand notation for the system name from the IEASYMxx member in the Logical Parmlib Concatenation.
Returns the system name. Global Resource Serialization (GRS) uses this name to identify different systems in a GRS complex/sysplex. z/OS gets this value at IPL time from the SYSNAME parameter in the IEASYSxx member in the Logical Parmlib Concatenation.
Returns a string containing the z/OS name, version, release, modification level, and FMID. For example, on a z/OS V1R5 system, the following string is returned:
z/OS 01.05.00 HBB7708
Returns the z/OS sysplex name from the COUPLExx or LOADxx members in the Logical Parmlib Concatenation.
Returns the value ACTIVE when TMP is active in the current environment, otherwise returns NOT ACTIVE. Use this function to check whether TSO services can be used in the current OPS/REXX program.
Returns the time zone offset from GMT in seconds. Use this value in conjunction with the OPSINFO('LEAPSECONDS') value to convert a GMT time to local time.
Note: This value may be a negative number.
Returns the TSO/E release level in the form v.rr.m (for example, 2.06.0). If TSO/E is not installed, this function returns the value N/A.
Returns the effective numeric USS group ID. An effective group ID may be different from the real group ID of the user that created the process. Effective group ID is the group ID used for security checks. Authorized programs are allowed to change their group ID when required. If this ID is unavailable or undefined, this function returns the value N/A.
Returns the effective numeric USS user ID. An effective user ID may be different from the real user ID of the user that created the process. Effective user ID is the group ID used for security checks. Authorized programs are allowed to change their user ID when required. If this ID is unavailable or undefined, this function returns the value N/A.
Returns the real numeric USS group ID. The real numeric USS group ID is the original group ID of the user that created the process. If this ID is unavailable or undefined, this function returns the value N/A.
Returns the numeric process USS group ID. The process group ID is the group ID of the main process that created the current process. If this ID is unavailable or undefined, this function returns the value N/A.
Returns the UNIX System Services process ID number (PID), in decimal format, for the current z/OS task. The primary use of this function it to capture the PID from long‑running USS processes that issue messages resulting in AOF message events. Possible values are:
Important! This number is not the same as the PID of the parent process when UNIX services fork or spawn are used to issue a message. These UNIX services may generate a short-term process resulting in a message that triggers an AOF message event.
Returns the parent process USS ID for the current z/OS task. The parent process ID is the process ID of the process that created the current process. If this ID is unavailable or undefined, this function returns the value N/A.
Returns the USS real user ID for the current z/OS task. The real USS user ID is the original user ID of the user that created the current process. If this ID is unavailable or undefined, this function returns the value N/A.
(Synonym for OPSINFO('RELEASE'). Returns an eight-byte string that provides the release number of the product. The format of this string is rr.rr, where rr.rr is the release number.
Thus, when using the OPSINFO('VERSION') function to differentiate between code that may run on multiple versions, take into account that the modification level changes with each maintenance tape.
For example, to check for code that can run only with r11.5, use this function:
if SUBSTR(OPSINFO(“VERSION”),1,6)==”11.05.” then . . .
To check for code that can run with r11.5 or higher levels, use this function:
if SUBSTR(OPSINFO(“VERSION”),1,6)>=”11.05.” then . . .
Returns the VM user ID of the virtual machine on which this z/OS image is a guest. Returns a null string if z/OS is not running under VM.
Returns the size in bytes of the REXX work space for the current OPS/REXX program or rule. The REXX work space is used to contain REXX variables (for example, 1572864).
| Copyright © 2012 CA. All rights reserved. | Tell Technical Publications how we can improve this information |