OPS/REXX Built-in Functions › OPSCPF Function

OPSCPF Function

The OPSCPF function returns information about the z/OS Command Prefix Facility (CPF). It may be used in any environment (that is, AOF rules or OPS/REXX programs).

Various z/OS subsystems define command prefixes to simplify the process of issuing commands and to provide a mechanism for issuing commands on other systems in a sysplex without requiring the use of the z/OS ROUTE command. The z/OS ROUTE command returns data that is similar to the data the z/OS DISPLAY OPDATA command returns. However, you can use the OPSCPF function synchronously in rules or OPS/REXX programs without waiting for a response.

This function has the following format:

var = OPSCPF({func[,pfx]}[,owner][,system])

func

Defines the type of call you want the OPSCPF function to make. Currently, the only valid function call is I, for inquiry about information retrieval. You must always specify the func argument. This argument is not case sensitive.

pfx

(Optional) Includes one to eight characters that are matched against the defined CPF prefixes. If the pfx matches any of the defined CPF prefixes (using the length of pfx for the comparison), those prefixes are returned. If the pfx argument is omitted, all CPF information is returned. This argument is not case sensitive.

owner

(Optional) Contains one to eight characters that are matched against the owner of the CPF entry. If the owner argument matches any of the defined CPF owner prefixes (using the length of owner for the comparison), those CPF records are returned. If the owner argument is omitted, all CPF information is returned. Note that the owner does not necessarily correspond to the jobname that created the CPF entry. This argument is not case sensitive.

system

(Optional) Contains one to eight characters that are matched against the system on which the CPF entry was defined. If the system argument matches the prefix of the system name on which the CPF entry was defined (using the length of system for the comparison), those CPF records are returned. If the system argument is omitted, all CPF information is returned. This argument is not case sensitive.