AOEXEC VLSTL


This command retrieves a long variable from the specified pool and places it into the TSO pool. 

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). 


Important

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

The VLSTL command is not supported under NetView.

Command

Parameters

AOEXEC VLSTL

[POOL(SHARED|PROFILE)]

VAR(var)

SS | SSID(subsystem identifier)

[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

Name of one variable

Only one variable can specified and the name must be enclosed in parentheses.

The variable name can be up to 30 characters.

The variable name can be a pattern; for example:

(A+B*)

where the following wildcards are supported:

  • plus sign (+): matches any one character
  • asterisk (*): matches zero to any number of 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.

12

Variable pool does not exist.

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).

20

Variable name was not specified.

53

Command is not supported under Netview.

Examples

This EXEC lists all long variables in the SHARED pool and writes their names to the terminal.

/* REXX */
"AOEXEC VLSTL VAR(*) POOL(SHARED) SSID(RE61)"
say lcnt
do i=1 to lcnt
  name = value('line'i)
  say name
end

CLIST example:

PROC 0
AOEXEC VLSTL VAR(*) POOL(SHARED) SSID(RE61)
WRITE &LCNT
SET I = 1
DO WHILE &I LE &LCNT
  SET NAME = &&&STR(LINE)&I
  WRITE &NAME
  SET I=&I+1
END

The following EXEC lists all variable names that are one character long in the SHARED pool.  The values associated with those variable names will be written to the Journal.

/* REXX */
"AOEXEC VLSTL VAR(+) POOL(SHARED) SSID(RJI1)"                    
                                                               
SAY 'IMFRC IS 'IMFRC' FOR VLST'                                 
SAY 'LCNT IS 'LCNT                                              
                                                               
DO I = 1 TO LCNT                                                
  CONTENTS=VALUE('LINE'I)                                       
  "IMFEXEC MSG '+ LINE"I" CONTAINS VARIABLE NAME "CONTENTS"'"   
END     
EXIT 0                                                                                             

CLIST example:

PROC 0
                                                     
AOEXEC VLSTL VAR(+) POOL(SHARED) SSID(RJI1)            
                                                       
    SET RC = &LASTCC                                    
    IF &RC > 0 THEN EXIT                                
    SET N = 1                                           
    DO WHILE (&N LE &LCNT)                              
      SET VARNAME = LINE&N                              
      SET CONTENTS = &&&VARNAME                         
      AOEXEC VGET VAR(&CONTENTS) POOL(SHARED) SSID(RJI1)
      WRITE &&&CONTENTS                                 
       SET N = &N + 1                                   
   END                                                  

The following EXEC lists all variable names that are two characters long in the SHARED pool.  The values associated with those variable names will be written to the Journal.

/* REXX */
"AOEXEC VLSTL VAR(++) POOL(SHARED) SSID(RJI1)"                    
                                                               
SAY 'IMFRC IS 'IMFRC' FOR VLST'                                 
SAY 'LCNT IS 'LCNT                                              
                                                               
DO I = 1 TO LCNT                                                
  CONTENTS=VALUE('LINE'I)                                       
  "IMFEXEC MSG '+ LINE"I" CONTAINS VARIABLE NAME "CONTENTS"'"   
END     
EXIT 0                                                                                             

CLIST example:

PROC 0
                                                     
AOEXEC VLSTL VAR(++) POOL(SHARED) SSID(RJI1)            
                                                       
    SET RC = &LASTCC                                    
    IF &RC > 0 THEN EXIT                                
    SET N = 1                                           
    DO WHILE (&N LE &LCNT)                              
      SET VARNAME = LINE&N                              
      SET CONTENTS = &&&VARNAME                         
      AOEXEC VGET VAR(&CONTENTS) POOL(SHARED) SSID(RJI1)
      WRITE &&&CONTENTS                                 
       SET N = &N + 1                                   
   END                                                  

The following EXEC retrieves all the variables that begin with RETRY. The last character could be any character and the variable names and their associated values will be written to the Journal.

/* REXX */
"AOEXEC VLSTL VAR(RETRY+) POOL(SHARED) SSID(RJI1)"                
                                                             
SAY 'IMFRC IS 'IMFRC' FOR VLST'                               
SAY 'LCNT IS 'LCNT                                            
                                                             
DO I = 1 TO LCNT                                              
  CONTENTS=VALUE('LINE'I)                                     
  "IMFEXEC MSG '+ LINE"I" CONTAINS VARIABLE NAME "CONTENTS"'"
END                                                           
EXIT 0                                     

CLIST example:

PROC 0
                                                     
AOEXEC VLSTL VAR(RETRY+) POOL(SHARED) SSID(RJI1)            
                                                       
    SET RC = &LASTCC                                    
    IF &RC > 0 THEN EXIT                                
    SET N = 1                                           
    DO WHILE (&N LE &LCNT)                              
      SET VARNAME = LINE&N                              
      SET CONTENTS = &&&VARNAME                         
      AOEXEC VGET VAR(&CONTENTS) POOL(SHARED) SSID(RJI1)
      WRITE &&&CONTENTS                                 
       SET N = &N + 1                                   
   END                                                  

The following EXEC retrieves all the variables that begin with RETRY. The last two characters could be any two characters and the variable names with their associated values will be written to the Journal.

/* REXX */
"AOEXEC VLSTL VAR(RETRY++) POOL(SHARED) SSID(RJI1)"                
                                                             
SAY 'IMFRC IS 'IMFRC' FOR VLST'                               
SAY 'LCNT IS 'LCNT                                            
                                                             
DO I = 1 TO LCNT                                              
  CONTENTS=VALUE('LINE'I)                                     
  "IMFEXEC MSG '+ LINE"I" CONTAINS VARIABLE NAME "CONTENTS"'"
END                                                           
EXIT 0                                     

CLIST example:

PROC 0
                                                     
AOEXEC VLSTL VAR(RETRY++) POOL(SHARED) SSID(RJI1)            
                                                       
    SET RC = &LASTCC                                    
    IF &RC > 0 THEN EXIT                                
    SET N = 1                                           
    DO WHILE (&N LE &LCNT)                              
      SET VARNAME = LINE&N                              
      SET CONTENTS = &&&VARNAME                         
      AOEXEC VGET VAR(&CONTENTS) POOL(SHARED) SSID(RJI1)
      WRITE &&&CONTENTS                                 
       SET N = &N + 1                                   
   END                                                  

 

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