Pertinent ADARUN Parameters for Auditing

#### Search Results

Search

# Pertinent ADARUN Parameters for Auditing

This section describes the ADARUN settings pertinent to the Adabas Audit Server and Adabas nuclei (running with `ADARUN AUDITING=YES`).

- ALOGDEV Parameter: Multiple Audit Logs Device Type

- ALOGSIZE Parameter: Multiple Audit Log Size

- AUDITING Parameter: Enable Nucleus Auditing

- DUALALD Parameter: Dual Audit Log Device Type

- DUALALS Parameter: Dual Audit Log Size

- LAP Parameter: Adabas Auditing Pool Size

- LU Parameter: Length of Intermediate User Buffer Area

- NAB Parameter: Number of Attached Buffers

- NALOG Parameter: Number of Audit Log Data Sets

- NC Parameter: Number of Command Queue Elements

- NT Parameter: Number of Threads

- V64BIT Parameter: 64-Bit Virtual Storage Option

- ZIIP Parameter: Activate Usage of Adabas for zIIP

##### Quick Reference

Parameter | Use to | Adabas Audit Server | Adabas Nucleus
--- | --- | --- | ---
`ALOGDEV` | Specify the device type used for multiple audit log data sets. Note This parameter must be specified with the ALOGSIZE parameter. | Yes | No
`ALOGSIZE` | Specify the number of blocks available for each audit log in multiple audit log data sets. Note This parameter must be specified with the ALOGDEV parameter. | Yes | No
`AUDITING` | Enable auditing of Adabas nuclei. | No | Yes
`DUALALD` | Specify the device type to be used for dual audit logging. | Yes | No
`DUALALS` | Specify the number of blocks available for each dual audit log. | Yes | No
`LAP` | Specify the size of the Auditing Pool. | Yes | Yes
`LU` | Specify the length (in bytes) of the intermediate user buffer area. | Yes | Yes
`NAB` | Specify the number of attached buffers to be used during the session. | Yes | Yes
`NALOG` | Specify the maximum number of audit log data sets to be opened and logged in the PPT for the session. | Yes | No
`NC` | Specify the maximum number of command queue elements (CQEs). | Yes | Yes
`NT` | Specify the number of threads to be used during the session. | Yes | Yes
`V64BIT` | Specify whether virtual storage above the 2-gigabyte bar should be used. | Yes | Yes
`ZIIP` | Specify whether or not to activate Adabas for zIIP. | Yes | Yes

## ALOGDEV Parameter: Multiple Audit Logs Device Type

Parameter | Specify . . . | Possible Values | Default
--- | --- | --- | ---
`ALOGDEV` | The device type to be used for multiple audit logs. | See text | value of DEVICE parameter

The ALOGDEV parameter specifies the type of external storage device used for multiple audit logs.

Note
The ALOGDEV and ALOGSIZE parameters must be used together. If you specify one parameter, you must also specify the other parameter.

You must also specify the NALOG parameter to use multiple audit logs. If you specify a user exit, it must be UEX12.

Refer to the Adabas for Mainframes documentation > Reference > DBA Reference Summary > section Adabas Device Types and Blocks Sizes for information about the device types that Adabas supports.

All audit logging data sets must be formatted using the ADAFRM utility before they are used.

The maximum size of the data set depends on the limits of the operating system and on the requirements of the user.

#### Example

The following example runs the Adabas Audit Server with audit logging. It uses six audit log data sets and a device type 3390 for audit logging. The size of each audit log data set is 1500 blocks based on an allocation of 10 cylinders. Each cylinder of a 3390 device has 15 tracks, and each track can contain 10 blocks of audit log data. Thus, 10 cylinders = 10 x 15 x 10 = 1500 blocks.

    ADARUN PROG=ADANUC,LOGGING=YES,NALOG=6,ALOGDEV=3390,ALOGSIZE=1500

## ALOGSIZE Parameter: Multiple Audit Log Size

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
`ALOGSIZE` | The number of blocks available for each audit log. | 16 | 16777215 | none

The ALOGSIZE parameters specifies the number of blocks available for each audit log data set.

Note
The ALOGDEV and ALOGSIZE parameters must be used together. If you specify one parameter, you must also specify the other parameter.

You must also specify the NALOG parameter to use multiple audit logs. If you specify a user exit, it must be UEX12.

Refer to the Adabas for Mainframes documentation > Reference > DBA Reference Summary > section Adabas Device Types and Blocks Sizes for information about the device types that Adabas supports.

All audit logging data sets must be formatted using the ADAFRM utility before they are used.

The maximum size of the data set depends on the limits of the operating system and on the requirements of the user.

#### Example

The following example runs the Adabas Audit Server with audit logging. It uses six audit log data sets and a device type 3390 for audit logging. The size of each audit log data set is 1500 blocks based on an allocation of 10 cylinders. Each cylinder of a 3390 device has 15 tracks, and each track can contain 10 blocks of audit log data. Thus, 10 cylinders = 10 x 15 x 10 = 1500 blocks.

    ADARUN PROG=ADANUC,LOGGING=YES,NALOG=6,ALOGDEV=3390,ALOGSIZE=1500

## AUDITING Parameter: Enable Nucleus Auditing

Parameter | Specify . . . | Possible Values | Default
--- | --- | --- | ---
`AUDITING` | Enables or disables Adabas nucleus auditing. | YES | NO | NO

The AUDITING parameter enables auditing on Adabas nuclei.

Note
Refer to the Adabas Auditing documentation > Installation chapter > Activating Auditing for Application Files for information on how to activate auditing for application files.

#### Example

    ADARUN PROG=ADANUC,AUDITING=YES

## DUALALD Parameter: Dual Audit Log Device Type

Parameter | Specify . . . | Possible Values | Default
--- | --- | --- | ---
`DUALALD` | The device type to be used for dual audit logs. | See text | value of DEVICE parameter

The DUALALD parameter specifies the type of external storage device used for dual audit logging.

DUALALD and DUALALS parameters must be used together; if you specify one parameter, you must also specify the other parameter. If you specify a user exit, it must be UEX2.

Refer to the Adabas for Mainframes documentation > Reference chapter > DBA Reference Summary > section Adabas Device Types and Blocks Sizes for information about the device types that Adabas supports.

Both dual audit logging data sets must be formatted using the ADAFRM utility before they are used.

The maximum size of the data set depends on the limits of the operating system and on the requirements of the user.

#### Example

The following example runs the Adabas Audit Server with audit logging and uses a device type 3390 for dual audit logging. The size of each audit log data set is 1500 blocks based on an allocation of 10 cylinders. Each cylinder of a 3390 device has 15 tracks, and each track can contain 10 blocks of audit log data. Thus, 10 cylinders = 10 x 15 x 10 = 1500 blocks.

    ADARUN PROG=ADANUC,LOGGING=YES,DUALALD=3390,DUALALS=1500

## DUALALS Parameter: Dual Audit Log Size

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
`DUALALS` | The number of blocks available for each dual audit log. | 16 | 16777215 | none

The DUALALS parameter specifies the number of blocks available for each dual audit log data set.

DUALALD and DUALALS parameters must be used together; if you specify one parameter, you must also specify the other parameter. If you specify a user exit, it must be UEX2.

Refer to the Adabas for Mainframes documentation > Reference chapter > DBA Reference Summary > section Adabas Device Types and Blocks Sizes for information about the device types that Adabas supports.

Both dual audit logging data sets must be formatted using the ADAFRM utility before they are used.

The maximum size of the data set depends on the limits of the operating system and on the requirements of the user.

#### Example

The following example runs the Adabas Audit Server with audit logging and uses a device type 3390 for dual audit logging. The size of each audit log data set is 1500 blocks based on an allocation of 10 cylinders. Each cylinder of a 3390 device has 15 tracks, and each track can contain 10 blocks of audit log data. Thus, 10 cylinders = 10 x 15 x 10 = 1500 blocks.

    ADARUN PROG=ADANUC,LOGGING=YES,DUALALD=3390,DUALALS=1500

## LAP Parameter: Adabas Auditing Pool Size

Parameter | Specify . . . | Possible Values | Default
--- | --- | --- | ---
`LAP` | The size of the Adabas Auditing pool. | minimum 20000 | 100000 (if `AUDITING=YES`) or 0 (if `AUDITING=NO`)

Notes:

1. The LAP parameter should be specified for an Adabas nucleus running with ADARUN parameter `AUDITING=YES`. In addition, the Auditing pool will be allocated in 64-bit virtual storage when an Adabas nucleus runs with ADARUN parameters `AUDITING=YES` and `V64BIT=YES`.
2. The LAP parameter should be specified for an Adabas Audit Server.
3. The LAP parameter values in the Adabas nucleus and the Adabas Audit Server may be different.
4. Software AG recommends setting LAP to a relatively large value (e.g. `LAP=40M` or greater). To determine what this setting should be for your site, you could run Adabas in a test environment with auditing turned on, simulate the activity in the production environment on this test system, and use the Adabas DRES operator command to view the current and high-water mark of auditing pool usage.
5. If an Adabas nucleus with `AUDITING=YES` is run with `V64BIT=YES` and `LARGEPAGE=G64`, the allocation request for the Auditing pool will be rounded up to the nearest multiple of two gigabytes. Any difference between the specified size and the allocated size will remain unused. For this reason, we recommend that if `LARGEPAGE=G64`, you specify the LAP value as a multiple of two gigabytes to avoid leaving a potentially large amount of allocated storage unused. If `LARGEPAGE=G64` is specified and 2GB large pages are not available for allocation, the specified size will be rounded up to the nearest multiple of one megabyte, and the storage will not be backed by large pages. A console message will report on this case.

#### Example

    ADARUN PROG=ADANUC,AUDITING=YES,LAP=50000K

## LU Parameter: Length of Intermediate User Buffer Area

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
`LU` | the size of the intermediate user buffer area. | none | none (see note 1) | 65535 (see note 2)

The LU parameter is optional. The size specified must be large enough to accommodate all Adabas control information (204 bytes), all user buffers (format, record, search, value, ISN) that may be required for any given Adabas command, plus any user information passed from Adabas link routines to nucleus user exits. If the ADALNK has user exits, the addresses of the ACB and each buffer passed will be stored in this space. Also, if the ADALNK has declared LUSIZE and has user exits, this buffer size plus 64 bytes will also be stored in this space.

If the multifetch/prefetch option or a utility that needs large record/ISN buffers is to be used during the session, the setting of LU must be large enough to contain the buffers needed.

Notes:

1. An error occurs if the LU parameter specifies a value greater than the byte count implied by the NAB (number of attached buffers) parameter. On z/OS systems, LU cannot exceed a value greater than that produced by the following calculation: NABvalue x 4096.
2. Due to the length of the record buffer of the utilities that need the nucleus (e.g., ADAULD) the default value is set to 65,535. If the value of LU is less than 65,535 for an Adabas session, a response code will occur when such a utility is running.
3. The ADACHK utility can use large record buffer lengths when making nucleus calls to verify spanned Data Storage records or an index structure with many levels. If this is the case, the settings of your LU and NAB ADARUN parameters may need to be increased.

The LU parameter syntax is:

    LU={ n | 65535 }

#### Specific Product Recommendations

For an Adabas Audit Server, the LU parameter must be greater than or equal to 167,000.

In addition, if audit data is sent through Entire Net-Work from one or more Adabas nuclei to an Adabas Audit Server, the Entire Net-Work LU parameter must be greater than or equal to the LU parameter setting for the Adabas Audit Server itself (greater than or equal to 167,000).

#### Example

The following example runs the Adabas Audit Server with an Adabas intermediate user buffer area of 200,000 bytes.

    ADARUN PROG=ADANUC,LU=200000

## NAB Parameter: Number of Attached Buffers

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
`NAB` | the number of attached buffers to be used. | 1 | varies, depending on the amount of available virtual storage | 16

The NAB parameter defines the number of attached buffers to be used during the session. An attached buffer is an internal buffer used for interregion communication. It is required in all environments. Adabas allocates an attached buffer pool with a size equal to the value of NAB multiplied by 4096 bytes.

Notes:

1. The allocation for buffers in the attached buffer pool is done in 256-byte slots. This means that each allocation is rounded to a multiple of 256. For example, if a size of 300 bytes is needed, the allocated space is 512 bytes.
2. You may specify as many attached buffers as fit into the available virtual storage.
3. In environments running in 31-bit addressing mode, the attached buffer pool space is allocated above the 16-MB line.
4. The ADACHK utility can use large record buffer lengths when making nucleus calls to verify spanned Data Storage records or an index structure with many levels. If this is the case, the settings of your LU and NAB ADARUN parameters may need to be increased.

The NAB parameter syntax is:

    NAB={ n | 16 }

#### Specific Product Recommendations

1. For an Adabas Audit Server, set parameter NAB to a value greater than or equal to:

       41 * 10 * the-number-of-Adabas-nuclei-sending-data-to-the-Adabas-Audit-Server

   For example, if one Adabas nucleus will be sending data to the Adabas Audit Server, set the NAB parameter greater than or equal to 410 (e.g. `NAB=420`).

2. If data is sent through Entire Net-Work from one or more Adabas nuclei to an Adabas Audit Server, the Entire Net-Work NAB parameter must also be set to a value greater than or equal to:

       41 * 10 * the-number-of-Adabas-nuclei-sending-data-to-the-Adabas-Audit-Server

## NALOG Parameter: Number of Audit Log Data Sets

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
`NALOG` | the maximum number of audit log data sets to be opened and logged in the PPT. | 2 | 8 | 0

This parameter specifies the maximum number of audit log data sets to be opened and logged in the parallel participant table (PPT) for the current Audit Server. Valid values are 0 (the default) and 2-8. Other values produce a parameter error. A zero value disables the parameter.

If more than the number of log data sets specified in the NALOG parameter are allocated in the startup JCL, only the number specified in the NALOG parameter are opened and logged; any additional allocated data sets are activated using the dynamic allocation process.

NALOG must be specified with a nonzero value in conjunction with the ALOGDEV, ALOGSIZE, and UEX12 parameters.

NALOG is not valid if DUALALD, DUALALS, or UEX2 are specified.

UEX2 and UEX12 are mutually exclusive.

If a nonzero NALOG, ALOGDEV, and ALOGSIZE are specified, but `LOGGING=NO`, Adabas attempts to open and log the number of data sets specified by NALOG; however, no logging occurs until the LOGGING parameter has been set to YES using either an operator command or Adabas Online System.

#### Example

The following example runs the Adabas Audit Server with audit logging. It uses six audit log data sets and a device type 3390 for audit logging. The size of each audit log data set is 1500 blocks based on an allocation of 10 cylinders. Each cylinder of a 3390 device has 15 tracks, and each track can contain 10 blocks of audit log data. Thus, 10 cylinders = 10 x 15 x 10 = 1500 blocks.

    ADARUN PROG=ADANUC,LOGGING=YES,NALOG=6,ALOGDEV=3390,ALOGSIZE=1500

## NC Parameter: Number of Command Queue Elements

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
`NC` | the maximum number of command queue elements. | 20 | 32767 | 200

The number of command queue elements (CQEs) established for an Adabas nucleus session determines the maximum number of Adabas commands that may be queued or be in process at any one time during the session.

Each call from the Adabas nucleus is assigned a CQE. The CQE is released when the user receives the results of the command, the Adabas Review hub has processed the command, or the user has been timed out. 192 bytes are required for each CQE.

Software AG recommends that you set NC high enough to allow one command per active user for possible synchronization during execution of the online SAVE database function of the ADASAV utility.

The Adabas session statistics or Adabas Online System can be used to tune this parameter for the next session.

For more information about the space requirements of the Command Queue for Adabas Review, refer to the Adabas Review Concepts Manual >Concepts and Facilities > Adabas Review Processing and Components > Storage Requirements.

#### Specific Product Recommendations

1. For an Adabas Audit Server, set parameter NC to a value greater than or equal to:

       10 * the-number-of-Adabas-nuclei-sending-data-to-the-Adabas-Audit-Server

   For example, if one Adabas nucleus will be sending data to the Adabas Audit Server, set the NC parameter greater than or equal to 10 (e.g. `NC=20`).

2. If data is sent through Entire Net-Work from one or more Adabas nuclei to an Adabas Audit Server, the Entire Net-Work NC parameter must also be set to a value greater than or equal to:

       10 * the-number-of-Adabas-nuclei-sending-data-to-the-Adabas-Audit-Server

#### Example

Run the Adabas nucleus with a maximum of 500 elements in the command queue.

    ADARUN PROG=ADANUC,NC=500

## NT Parameter: Number of Threads

Parameter | Specify . . . | Minimum | Maximum | Default
--- | --- | --- | --- | ---
`NT` | the number of user threads to be used during the Adabas session. | 4 | 250 | 5

A thread is used to execute a single command for any user (access or update). Each thread requires 8192 bytes.

In environments running in 31-bit addressing mode, the threads are allocated above the 16-megabyte line.

The Adabas session statistics or Adabas Online System can be used to tune this parameter for the next session.

#### Specific Product Recommendations

For an Adabas Audit Server, the NT parameter must be greater than or equal to 15.

#### Example

The following example runs the Adabas Audit Server with 20 user threads.

    ADARUN PROG=ADANUC,NT=20

## V64BIT Parameter: 64-Bit Virtual Storage Option

Parameter | Specify . . . | Possible Values | Default
--- | --- | --- | ---
`V64bit` | whether or not the Adabas nucleus should use virtual storage above the two-gigabyte bar (64-bit virtual storage). For the nucleus to use 64-bit virtual storage, the operating system must also support 64-bit virtual storage. | YES | NO | NO

Currently, the following storage areas will be allocated above the two-gigabyte bar in an Adabas nucleus:

- the flush I/O pool (see ADARUN parameter LFIOP)

- the PLOG protection I/O buffers (see ADARUN parameter NPLOGBUFFERS)

- the Work part 1 protection I/O buffers (see ADARUN parameter NWORK1BUFFERS)

- the cast-out directory buffer, in cluster environments (automatically derived from the attributes of the global cache space for Adabas Cluster or Adabas Parallel Services)

The use of 64-bit virtual storage will help alleviate virtual storage constraints below the two gigabyte bar in installations that use large amounts of virtual storage in Adabas nucleus sessions (for example, nucleus sessions with ADARUN parameter settings of `LBP=1200M` and `LFIOP=200M`).

Value | Meaning
--- | ---
YES | The Adabas nucleus will use 64-bit virtual storage (storage above the two-gigabyte bar).
NO | The default setting. The Adabas nucleus will not use 64-bit virtual storage.

Note
Users in z/OS environments should note that virtual storage above the two-gigabyte bar (64-bit virtual storage) is shown in dumps to SVCDUMP or SYSMDUMP, but not in dumps to MPMDUMP, SYSABEND, or SYSUDUMP. Therefore, we recommend that you use the SVCDUMP in the JCL of an Adabas nucleus running with `ADARUN V64BIT=YES` to ensure that 64-bit virtual storage is shown in any SVC dumps that are produced. If, for some reason, you do not want to produce SVC dumps, we recommend that you use SYSMDUMP to ensure 64-bit virtual storage is shown in a dump of the Adabas nucleus address space.

#### Specific Product Recommendations

The Auditing pool (LAP) will be allocated in 64-bit virtual storage when an Adabas nucleus runs with ADARUN parameters `AUDITING=YES` and `V64BIT=YES`.

#### Example

The following example indicates that the Adabas nucleus will make use of virtual storage above the two-gigabyte bar and should use 1M large pages.

    ADARUN PROG=ADANUC,LARGEPAGE=YES,V64BIT=YES

## ZIIP Parameter: Activate Usage of Adabas for zIIP

The ZIIP parameter controls whether Adabas activates Adabas for zIIP (AZPAD).

Note
Adabas for zIIP requires its own license file (AZPAD) in addition to the standard Adabas license file. If the AZPAD license file is missing or found invalid, Adabas will start, but will run as if `ZIIP=NO` had been specified.

Parameter | Specify . . . | Possible Values | Default
--- | --- | --- | ---
`ZIIP` | whether or not to activate Adabas for zIIP. | YES | NO | NO

Value | Meaning
--- | ---
YES | Usage of Adabas for zIIP is enabled. Adabas offloads CPU time from the general processors to System z Integrated Information Processors (zIIP). The purpose of this configuration is to reduce the CPU consumption on the general processors.
NO | The default setting. Usage of Adabas for zIIP is disabled. Adabas runs without the option to offload CPU time to zIIPs.

#### Dynamic Modification

If Adabas was started with `ZIIP=YES`, the setting of the ZIIP parameter can be changed at runtime – that is, set to 'NO' and subsequently back to 'YES' – using the from the operator console, the ZIIP function, or the Modify Parameters menu of Adabas Online System. If Adabas was started with `ZIIP=NO`, the setting of the ZIIP parameter cannot be changed to 'YES' later in this session. ZIIP may be set differently for different nuclei in a cluster. It is a local, modifiable parameter.

#### Specific Product Recommendations

The Adabas Audit Server and Adabas nuclei running with `ADARUN AUDITING=YES` support the use of Adabas for zIIP subject to the availability of the appropriate license file (AZPAD).

#### Example

The following example activates the use of Adabas for zIIP.

    ADARUN PROG=ADANUC,ZIIP=YES

### On this page

- ALOGDEV Parameter: Multiple Audit Logs Device Type
- ALOGSIZE Parameter: Multiple Audit Log Size
- AUDITING Parameter: Enable Nucleus Auditing
- DUALALD Parameter: Dual Audit Log Device Type
- DUALALS Parameter: Dual Audit Log Size
- LAP Parameter: Adabas Auditing Pool Size
- LU Parameter: Length of Intermediate User Buffer Area
- NAB Parameter: Number of Attached Buffers
- NALOG Parameter: Number of Audit Log Data Sets
- NC Parameter: Number of Command Queue Elements
- NT Parameter: Number of Threads
- V64BIT Parameter: 64-Bit Virtual Storage Option
- ZIIP Parameter: Activate Usage of Adabas for zIIP