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.

VPUT


This command copies one or more variables from the EXECs function pool into one of the 

BMC AMI Ops Automation

 pools.

Note

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

Command

Parameters

VPUT

Variable name|(var1 ... varn)

[FROM(VariableName)]

[LOCAL|SHARED|PROFILE]

[USING(var1 ... varn)]

[ENCRYPT(xyz)]

TARGET(ssid)

The following table describes the parameters:

Parameter

Function

Notes

Variable name|(var1 ... varn)

The names of one or more variables to copy

If more than one variable is specified, the variable names must be enclosed in parentheses.

Each variable name can be up to 32 characters. The maximum length of the combined variable values is 252 bytes.

FROM

An optional keyword that you can use in conjunction with the VDCL command to map a string of characters into a list of individual variables

The list is created by IMFEXEC VDCL.

Pool identifier

The pool to which the designated variables should be placed

Identifier is one of the following pools:

USING

An optional keyword that, when used with BMC AMI OpsA variables, allows you to set the BMC AMI OpsA variables from the LOCAL variable pool

For example:

IMFEXEC VPUT (A B C)USING (X Y Z)

allows the BMC AMI OpsA variables A, B, and C be set to the TSO variable contained in X, Y, and Z.

ENCRYPT(xyz)

Specifies a character string that can be used for encrypting variable contents

This parameter must be used in conjunction with the DECRYPT parameter on an IMFEXEC VGET command at the same time. If this is not done, the contents of the data will not match.

The character string can be 2-255 characters long.

Enclose the character string in single quote marks if the string contains blanks.

Only individual variables can be encrypted. List variables cannot be encrypted.

Refer to VGET for information about the DECRYPT parameter.

TARGET

Allows you specify the BBI-SS PAS ID of another BBI-SS PAS

You can then VPUT variables from one BBI-SS PAS to another BBI-SS PAS that communicates with it.

The TARGET keyword can be used with IMFEXEC commands VDEL, VGET, and VPUT.

Condition codes are listed in the following table:

Value

Description

0

Command was executed successfully.

4

Variable did not previously exist in the designated pool.

This return code does not occur for sysplex variables. You will receive a RC of 0 whether or not the variable previously existed.

8

One of the following conditions is true:

  • Invalid syntax used.
  • When using VPUT to put the variable to the PROFILE pool, the PROFILE pool data set BBIVARS is full.
  • Node was not found in BBPARM member BBINOD00 (when TARGET is used).

12

One of the following conditions is true:

  • Q-type variable was specified and cannot be VPUT.
  • TARGET was not defined in BBPARM member BBIJNT00.

16

One of the following conditions is true:

  • Internal error occurred.
  • Node was not available and TARGET is used.

16

Sysplex variable name is too long (exceeds 15 characters)

20

One of the following conditions is true:

  • No variables are in list.
  • Variable name is invalid.
  • Variable overflow occurred.

When using the TARGET keyword to VPUT a variable to another target, there is a limit of (approximately) 7000 bytes of data that can be sent to another target. This includes both the variable name and variable value.

Example1

This example command saves the current value of ABENDS, ABENDCOUNT, and ABENDREASON in the shared pool.

/* REXX */
'IMFEXEC VPUT (ABENDS ABENDCOUNT ABENDREASON)'

CLIST example:

IMFEXEC VPUT (ABENDS ABENDCOUNT ABENDREASON)

Example 2

This example command saves the current value of ABENDS in the local pool.

/* REXX */
'IMFEXEC VPUT ABENDS LOCAL'

CLIST example:

IMFEXEC VPUT ABENDS LOCAL

Example 3

These examples show how to use the IMFEXEC VPUT ENCRYPT and IMFEXEC VGET DECRYPT parameters.

Both parameters specify ('DATASTREAM'), which ensures that when the variable ABC is decrypted, the contents of the variable will be accurate.

/* REXX */
ABC=SUBSTR(THIS IS A DATA ENCRYPTION EXAMPLE)
'IMFEXEC VPUT ABC SHARED ENCRYPT('DATASTREAM')'
'IMFEXEC VGET ABC SHARED DECRYPT('DATASTREAM')'

CLIST example:

SET ABC=&STR(THIS IS A DATA ENCRYPTION EXAMPLE)
IMFEXEC VPUT ABC SHARED ENCRYPT('DATASTREAM')
IMFEXEC VGET ABC SHARED DECRYPT('DATASTREAM')

 

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