AOEXEC VGETL


This command copies one or more long variables from one of the 

BMC AMI Ops Automation

 pools into the TSO pool.

Note

This command supports the use of sysplex variables; see Using-sysplex-variables for more information about restrictions with sysplex variables (such as with wildcard characters and abbreviations) and other important information.

This variable operation only supports a subset of the functions available for the short variables. It ONLY affects and searches for long variables. If a short variable (created with VPUT instead of VPUTL) with the specified name exists, it is ignored.

The VGETL command is not supported under NetView.

Command

Parameters

AOEXEC VGETL

[POOL(SHARED|PROFILE)]

VAR(var1...var2...varn)

SS | SSID(subsystem identifier)

[AOOPTION | AOOPT(ANV, CAO, IAO, IIZ, MAO, QAO, or TSH)]

[TGTJNT()]

[TGTSS(target subsystem identifier)]

The following table describes the parameters.

Parameter

Function

Notes

POOL

Pool in which the designated variables reside

Valid values are one of the following pools:

SHARED is the default.

VAR(var1...var2...varn)

Name of one or more variables

Each variable name can be up to 30 characters.

You can use the wildcard characters plus sign (+) and asterisk (*). The plus sign represents one character and the asterisk represents multiple characters.

SS | SSID

Specifies the subsystem identifier of a local subsystem

Generic wildcard characters are supported for this keyword. You can specify 1 to 4 asterisks (*) or plus signs (+).

  • If you specify a single asterisk (*), any BBI-SS PAS found on the same LPAR might be used to process the EXEC. You can also specify SS(P*) and the EXEC can be processed by any BBI-SS PAS that begins with P.

  • You can use also the plus sign (+) to indicate a positional wildcard such as SS(+++P). In this example, the EXEC can be processed on any BBI-SS PAS that ends in P.

Use the AOOPTION parameter to further filter on the wildcard value. By specifying a value with AOOPTION, you can route the EXEC to the BMC AMI OpsA BBI-SS PAS that is running a product option or group of product options.

AOOPTION is mutually exclusive with TGTSS and TGTJNT, and it is ignored on a fully qualified SSID specified with SS or SSID parameter.

AOOPTION

Specifies the product options that must be active in the BMC AMI OpsA PAS. The following values are valid: ANV, CAO, IAO, IIZ, MAO, QAO, or TSH.

IIZ represents the BMC AMI OpsA BMC Impact Integration for z/OS product. The stand-alone BMC Impact Integration for z/OS product does not support AOAnywhere.

The specified product option must be active in the BMC AMI OpsA PAS.

The value specified with the AOOPTION parameter is valid only when the SSID parameter specifies a wildcard value.

Note

EXEC processing ignores the AOOPTION parameter when a non-wildcard SSID is specified in the SSID parameter.

AOOPTION cannot be specified if TGTSS or TGTJNT are also specified.

TGTJNT()

A JNT entry that identifies the SSID which processes this request

Use this parameter to specify a different target from the target system where the EXEC is invoked. The specified TGTJNT() should match a TARGET=(tgtname) parameter that is entered in BBPARM member BBIJNT00.

The EXEC is scheduled on the subsystem that corresponds to the subsystem that is specified by the SS | SSID parameter of the JNT entry. The specified TGTJNT() may also be an SSID with which the original subsystem communicates.

This keyword is mutually exclusive with the TGTSS() keyword.

Note

The target subsystem named in the TGTJNT entry must exist within the current sysplex.

TGTSS

If the TGTSS() keyword is specified, the subsystem specified by the SS | SSID() keyword is considered a router and the actual function is executed on the subsystem specified by TGTSS(). If TGTSS() is not specified, this subsystem is where the requested function is executed.

It must be in the same sysplex as the BBI-SS specified with the SSID() keyword, and both systems must have the same XCFGROUP specified in the BBPARM BBISSP xx.

Return codes are listed in the following table.

Return code value

Description

See AOEXEC-common-return-codes for a description of return code values that are common to all AOEXEC commands. This table lists additional return codes for this AOEXEC command.

8

No match found for one or more of the variable names containing a wildcard character.

16

Parse failed.

16

Variable name starts with numerics.

16

Variable name was too long.

16

Variable name was not alphanumeric.

16

Sysplex variable name is too long (exceeds 13 characters, the limit for long sysplex variable names).

53

Command is not supported under Netview.

Additional usage notes for the VAR parameter

The AOEXEC VGETL VAR(var1 and so on) command retrieves variables and stores the variables names in TSO variables VAR1 through VARnnnn, where nnnn is the last variable. The VARCT variable contains the value of nnnn). If a variable name contains a wildcard character but there are no matching names in the pool, that name is not stored to a VARnnnn variable.

Examples

The PROFILE pool is searched for a long variable with the name of X. If found, it is placed into the TSO pool and assigned to the variable Y.

REXX EXEC example:

"AOEXEC VGETL VAR(X) POOL(PROFILE) SSID(RE61)"
Y=X

CLIST example:

AOEXEC VGETL VAR(X) POOL(PROFILE) SSID(RE61)
SET Y=X

The following example shows the AOEXEC VGETL command using a wildcard character:

"AOEXEC  VGETL VAR(CICS*_FILES) SSID(JB73)"
say 'CICSPRD1_FILES:' CICSPRD1_FILES
say 'CICSPRD2_FILES:' CICSPRD2_FILES
say 'CICSPRD3_FILES:' CICSPRD1_FILES
say 'CICSPRD4_FILES:' CICSPRD4_FILES
say 'CICSPRD5_FILES:' CICSPRD5_FILES

Sample output:
CICSPRD1_FILES: CICSPRD1.WEBAPP1.FILE1 CICSPRD1.WEBAPP1.FILE2 CICSPRD1.WEBAPP1.FILE3 ...
CICSPRD2_FILES: CICSPRD2.WEBAPP2.FILE1 CICSPRD2.WEBAPP2.FILE2 CICSPRD2.WEBAPP2.FILE3 ...
CICSPRD3_FILES: CICSPRD3.WEBAPP3.FILE1 CICSPRD3.WEBAPP3.FILE2 CICSPRD3.WEBAPP3.FILE3 ...
CICSPRD4_FILES: CICSPRD4.WEBAPP4.FILE1 CICSPRD4.WEBAPP4.FILE2 CICSPRD4.WEBAPP4.FILE3 ...
CICSPRD5_FILES: CICSPRD5.WEBAPP5.FILE1 CICSPRD5.WEBAPP5.FILE2 CICSPRD5.WEBAPP5.FILE3 ...

The following example shows the AOEXEC VGETL command using a wildcard character and how the command retrieves and displays VARnnnn TSO variables:

/* REXX */                                                              
PARSE UPPER ARG EXECNAME FILLER                                         
                                                                       
/* -------------------------------------------------------------- */    
/* Issue the AOEXEC VGETL service                                 */    
/* -------------------------------------------------------------- */    
"AOEXEC VGETL VAR(K* GARY) POOL(SHARED) SSID(KMZ2) TGTSS(KMZ2)"
VGETL_IMFRC = IMFRC                                                     
                                                                       
/* -------------------------------------------------------------- */    
/* Report on:                                                     */    
/* - IMFRC from AOEXEC VGETL                                      */    
/* - VARCT (number of variable names processed by VGETL)          */    
/* -------------------------------------------------------------- */    
"IMFEXEC MSG '+'"                                                    
"IMFEXEC MSG '+ "LEFT('IMFRC for VGETL',15)" is "VGETL_IMFRC"'"
"IMFEXEC MSG '+ "LEFT('VARCT',15)" is "VARCT"'"
"IMFEXEC MSG '+'"
                                                                       
/* -------------------------------------------------------------- */    
/* Report on:                                                     */    
/* - Variable values returned from AOEXEC VGETL                   */    
/* - Variable names processed by AOEXEC VGETL                     */    
/* -------------------------------------------------------------- */    
DO N = 1 TO VARCT
  "IMFEXEC MSG '+ "LEFT('VAR'||N,15)||,
   " is ''"VALUE(LEFT(VAR||N,LENGTH(VAR||N)))"'''"
  "IMFEXEC MSG '+ "LEFT('it contains',18)||" ''"||,
    VALUE(LEFT(VALUE(VAR||N),LENGTH(VALUE(VAR||N))))"'''"
  "IMFEXEC MSG '+'"
END                                                        
                                                                       
/* -------------------------------------------------------------- */    
/* Indicate the end of the EXEC and then return to the caller.    */    
/* -------------------------------------------------------------- */    
"IMFEXEC MSG '+ End of EXEC'"
                                                                       
"IMFEXEC EXIT CODE(0)"

Sample output:

+                                  
+ IMFRC for VGETL is 0000          
+ VARCT           is 4             
+                                  
+ VAR1            is 'KSYSNAME'    
+ it contains        'SJSC'        
+                                  
+ VAR2            is 'KSMFID'      
+ it contains        'SJSC'        
+                                  
+ VAR3            is 'KQMFID'      
+ it contains        'KMZ2'        
+                                  
+ VAR4            is 'GARY'        
+ it contains        'SPONGEBOB'   
+                                  
+ End of EXEC

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*