Newer version of documentation BMC provides a newer version of the documentation for this version of the product. As a result, BMC no longer accepts comments in this space.BMC recommends upgrading to the latest version of the product. To see documentation for that version, see bao8301.

AOEXEC VLST


This command lists variable names defined in the 

BMC AMI Ops Automation

 pools.

It returns a list (of up to 99,999) variable names in LOCAL variables LINE1 through LINEn and sets LCNT to the number of LINEs.

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.

Command

Parameters

AOEXEC VLST

[POOL(SHARED|PROFILE)]

SS | SSID(subsystem identifier)

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

[TGTJNT()]

[TGTSS(target susbsystem identifier)]

VAR(variable name)

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:

  • PROFILE

SHARED is the default.

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 is the subsystem 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.

When the AOEXEC command originates in a NetView EXEC, the router and local BMC AMI OpsA PAS must have an active, valid BMC AMI Ops Automation Access NV key.

VAR

Name of one variable

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

The variable name can be 1-30 characters alphanumeric conforming to TSO coding conventions.

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

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

20

Variable name was not specified.

Example

The following EXEC uses the AOEXEC VLST command to retrieve all the variables that begin with RETRY and then reports the number of retries. Variables LINE1 through LINE xx (where xx is LNCT) will contain the number of found variables.

REXX EXEC example:

/* REXX */
"AOEXEC VLST VAR(RETRY*) POOL(SHARED) SSID(RE61)"
if rc = 8 then exit
do i=1 to lcnt
  contents=value('LINE'I)
  "AOEXEC VGET VAR('contents') SSID(RE61)"
  contents=value(contents)
  count=left(contents,6)
  nod=substr(contents,7)
  say 'Terminal : 'nod' Retries: 'count
END

CLIST example:

AOEXEC VLST VAR(RETRY*) POOL(SHARED) SSID(RE61)
SET RC = &LASTCC
IF &RC = 8 THEN EXIT
SET N = 1
DO WHILE (&N LE &LCNT)
  SET VARNAME = LINE&N
  SET CONTENTS = &&&VARNAME
  AOEXEC VGET VAR(&CONTENTS) POOL(SHARED) SSID(RE61)
  SET CONTENTS =&&&CONTENTS
  SET END1 = &LENGTH(&CONTENTS)
  SET COUNT = &SUBSTR(1:6,&CONTENTS)
  SET NOD = &SUBSTR(7:&END1,&CONTENTS)
  WRITE TERMINAL: &NOD RETRIES: &COUNT
  SET N = &N + 1
END
AOEXEC VDEL VAR(RETRY*) POOL(SHARED) SSID(RE61)

 

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