Operational Parameters

The operational parameters enable you to customize base functions of the data collector.
caidb220
Db2 Connection Parameters
The following parameters control connection to the monitored Db2 subsystem:
  • DB2-LOCATION='
    xxxxxxxxxxxxxxxx
    '
    Specifies a description of the monitored Db2 subsystem. The location name must be specified in quotes ('). Up to 16 characters are allowed. This location name is the same as specified in the APPLS statement of the data collector RAF and user interface parameters, so that the user interface can find this data collector locally and remotely.
    Default:
    lparssid
    , where
    lpar
    is the z/OS LPAR name and
    ssid
    is the Db2 subsystem name.
  • DB2VER=
    rr.v
    (Optional) Specifies the version of the Db2 subsystem. This value is used for processing IQL requests during the data collector startup when the Db2 subsystem is not active. When the data collector connects to the active subsystem, the Db2 version of that subsystem overrides the DB2VER specification.
    The data collector uses this parameter to pass the Db2 version to
    SYSVIEW for Db2
    query language (IQL) parser for customization of the online and history displays. If the setting is incorrect, data for an incorrect release might appear or data for a correct release might be missing.
    Examples:
    9.1, 10.1, 11.1, 12.1
  • DBSUB=
    db2name
    Specifies the name of the Db2 subsystem to be reported on.
    Specify a fictitious Db2 subsystem name when you specify DC-HISTORY-MODE=YES to designate a history-only data collector.
    DBSUB is optional when you specify DC-HISTORY-MODE=NO.
    Limits:
    1 to 4 characters
  • DBWAIT=[YES|
    NO
    |ON|OFF]
    Specifies whether to wait for a Db2 startup when Db2 is inactive at the data collector start. ON and OFF are synonyms for YES and NO. If Db2 is inactive and DBWAIT=NO is specified, the data collector immediately terminates.
    Default:
    NO
    Default in sample SYSPARMS member:
    YES
  • DC-DB2-STOP-MODE=[
    PRIM
    |SECO]
    Specifies whether a data collector terminates its Db2 threads immediately upon being posted that Db2 is terminating. The hierarchy is as follows:
    • One primary data collector which behaves in the current manner by waiting until all other Db2 threads except its own terminate before terminating its threads.
    • One or more secondary data collectors that terminate their threads immediately.
    Default:
    PRIM
    The mode can also be specified by EXEC PARM, as STOPM=P or STOPM=S. When you specify the mode on the EXEC statement, this SYSPARM value is ignored.
  • DC-HISTORY-MODE=[YES|
    NO
    ]
    Allows the data collector to start up in History-Only mode. In this mode, a data collector can only browse the history datasets. To start up a data collector in History-Only mode, ensure that the DBSUB parameter does
    not
    point to any subsystem that exists on your system.
    Setting up DC-HISTORY-MODE=YES overrides the values of the following system parameters:
    • HISTORY, DBWAIT, and NONSTOP are set to YES
    • HISTORY-SQLTEXT is set to NO
    Default:
    NO
    The mode can also be specified by EXEC PARM, as HISTM=Y or HISTM=N. When you specify the mode on the EXEC statement, this SYSPARM value is ignored.
  • DC-GROUP=
    xxxxxxxx
    Specifies an installation-specific data sharing group name for the data collectors which are monitoring a specific Db2 data sharing group. The name that is specified must be unique among all XCF groups specified.
    Default:
    XDBGDC
    vv
    where
    vv
    equals the
    SYSVIEW for Db2
    release number.
  • NONSTOP=[YES|
    NO
    ]
    Specifies whether the data collector stays active when Db2 is stopped.
    SYSVIEW for Db2
    prevents Db2 from coming up when the system does not have usable USER LX entries. This action occurs because Db2 does not free up the USER LX entries that it used during the previous cycle when other address spaces once connected to it are still active. For example, the data collector. Db2 uses a new set of USER LX entries at every start.
    The length of time the data collector, PC Owner, and Global Subsystem jobs can run safely without causing a problem is controlled by:
    • The number of USER LX entries that are defined to the system.
    • How frequently Db2 is cycled while
      SYSVIEW for Db2
      is running.
    Default:
    NO
    Default in sample SYSPARMS member:
    YES
DC Job Parameters
The following parameters control data collector job execution:
  • DBGSNAP-DSN='
    dsn
    '
    Specifies the name of the ABEND dump data set to allocate for snap dumps. This parameter is used when you specify FULLDUMP=NO. For a SYSOUT class, specify a single SYSOUT character. If a single character is specified, it is assumed to be a SYSOUT class. Otherwise, is assumed to be a data set name.
    Default:
    A SYSOUT class of '*'
  • DEFAULT-CONSOLE-DEV='
    xxx
    '
    Specifies the device address of the console that the data collector is to use. If this parameter is not specified, the data collector defaults to the master console, if available. If no master console is available in a SYSPLEX environment, this parameter can be used to specify an alternative display console.
  • FULLDUMP=[YES|NO|
    SVC
    ]
    Specifies the type of dump that is requested for an ABEND:
    • SVC
      —An SVC dump
    • YES
      —A full ABEND dump. This option has been deprecated. If you specify FULLDUMP=YES, it is processed as FULLDUMP=SVC.
    • NO
      —A summary SNAP dump. If you specify this option, allocate a data set DBGSNAP for the SNAP dump.
    Default:
    SVC
    Default in sample SYSPARMS member:
    SVC
    This value can also be specified on the EXEC PARM statement as FDUMP=YES, FDUMP=NO, or FDUMP=SVC. When you specify this value on the EXEC statement, the SYSPARM value is ignored.
  • REGION=-1|0|
    nnn
    Specifies the data collector virtual storage region limit value in megabytes. This value can override the default REGION value for the address space. The following values are valid:
    • -1
      If supplied, honors the REGION parameter on the EXEC JCL statement.
    • 0
      Specifies no region limit (not recommended)
    • nnn
      Specifies a minimal region limit for the data collector task to use. This value overrides the default address space REGION value only in case it is higher. Specify a value of 64 or higher.
    The default value is the higher of 128 or the address space region limit. That is, the default value ensures that the data collector has a minimum region limit of 128 MB.
  • ZIIP-USE=[
    YES
    |NO|SRB]
    Specifies whether the data collector uses zIIP processing. The following data collector functions can run on a zIIP processor:
    • IFI trace record processing for READA collected trace records.
    • Processing history records to satisfy an online user history request.
    • Exceptions Processor execution
    The following values are valid:
    • YES
      —Uses zIIP processing.
      If the zIIP processors are not available, an informational message is issued and processing continues with the execution on central processors.
    • SRB
      —Uses SRB mode, but does not use zIIP.
      ZIIP-USE=SRB is only used as a migration aid in non-zIIP environments to determine how much CPU can be offloaded to any available zIIP processors. The output of the DCCPU command estimates the zIIP savings that you can achieve once you have migrated to a processor with zIIP engines.
    • NO
      —Does not use zIIP or SRB
    Default:
    YES
DC Processing Parameters
The following parameters control data collector internal processing:
  • DATA-SHARING=[YES|
    NO
    ]
    If set to YES, enables the data sharing of the specific IQL statements in requests. These statements can be found in several IQL requests surrounded by #IF DATASHR and #IFEND IQL statements.
    Default:
    NO
  • DEBUG-LEVEL=
    n
    or
    AGENT-DEBUG
    =n
    Specifies the value for the level of debugging messages to be written to the DBGPRINT. The value can range from 1 to 6.
    Use values higher than 3 to see debugging messages that are related to the SNMP trap and email sending. Setting this parameter to 1 disables most messages that are related to the Xnet processing.
    Default:
    3
  • DISPLAY-ACTIVE-CHILD=[YES|
    NO
    ]
    Specifies if the Db2 parallel child threads appear on the Active Threads panel when the Variation field is set to Active.
    Default:
    NO
  • DISPLAYSQL=[YES|
    NO
    ]
    Specifies whether to extract the last SQL statement text from control blocks if the thread is not in Db2 when the display request is made. If YES is specified, an incorrect SQL statement can be displayed if the area pointed to has been reused. If NO is specified, the SQL statement text is shown only when the thread is in Db2.
    Default:
    NO
    Default in sample SYSPARMS member:
    YES
  • MAXUTASKS=
    nn
    Specifies the maximum number of user interface tasks that this data collector can attach. A user interface task is any task for data collector processing of
    SYSVIEW for Db2
    commands that are issued by a user. For example, display or start request.
    Limits:
    2 - 16
    Default:
    10
    Default in sample SYSPARMS member:
    6
  • NUMUTASKS=
    nn
    Specifies the number of users that can simultaneously execute
    SYSVIEW for Db2
    commands from the user interface.
    Default:
    3
    Limits:
    2 - 16
  • OBID-DSN='
    dsn
    '
    Specifies the name of a sequential or partitioned data set with a member that contains the DBID/OBID name translations that were built using the OBID Translation Utility (IDB2OBI).
    Set up a batch job that periodically updates the OBID translation file and refreshes the file in the data collector using the OBID command.
  • SMTP-SYSOUT=
    a
    Specifies the SYSOUT class of the SMTP server.
    Default:
    B
  • SMTP-WRITER=
    writer
    Specifies the writer name of the SMTP server.
    Default:
    SMTP
    The following table shows the default settings for SMTP-SYSOUT and SMTP-WRITER:
    SMTP-SYSOUT
    SMTP-WRITER
    Class used
    Writer Used
    omitted
    omitted
    B
    SMTP
    omitted
    defined
    *
    as defined
    defined
    omitted
    as defined
    no writer name
    defined
    defined
    as defined
    as defined
  • SMTP-TEMPLATE-DSN='
    dsname(member)
    '
    Specifies the name of the partitioned data set and its member that contains the HTML template for outgoing emails. For the syntax of the template, see Customize HTML Emails. The post-install creates a sample template in the
    high-level
    .SOURCE(NSIEHTML) member. If no template data set is specified, HTML is generated from the internal template.
    If you specify an HTML TEMPLATE for a destination group, you must also specify the data collector system parameter SMTP-TEMPLATE-DSN. The partitioned data set specified in the SMTP-TEMPLATE-DSN parameter is used to find the HTML template member.
  • THREAD-GROUPS-DSN='
    dsname(member)
    '
    Specifies the name of the partitioned data set and its member that contains the thread group definitions. For the definitions syntax, see Define Thread Groups.
    Specify this SYSPARM to generate (1044) APM-APPL-SUM records. If you specify an empty file, this system parameter is disabled.
  • XMANAGER-CHECK=[
    WARN
    |FAIL|QUIET]
    Specifies the data collector action when the connection to Xmanager cannot be established.
    • WARN
      Issues the following message to the JESLOG and DBGPRINT destinations:
      DBG02196W FAILED TO CONNECT TO XMANID=XXXX, OPERATION CONTINUES DUE TO XMANAGER-CHECK=WARN
      Processing continues.
    • FAIL
      Issues the following message to the JESLOG and DBGPRINT destinations:
      DBG02197E FAILED TO CONNECT TO XMANAGER, PARMLIB XMANID=XXXX
      The data collector terminates.
      Two connection attempts with a 10-second delay let Xmanager initialize when it is started together with the data collector.
    • QUIET
      Issues the following message to the DBGPRINT destination:
      DBG02195I FAILED TO CONNECT TO XMANID=XXXX, OPERATION CONTINUES DUE TO XMANAGER-CHECK=QUIET
      Processing continues.
    Default:
    WARN
    System parameter XMANAGER-CHECK will become obsolete in the future. The value will be overridden by FAIL and the data collector connection to Xmanager will be required.
  • ZDM-PREFIX=
    xxxx
    Specifies the first four characters of the CCS Data Mover instance identifier, which is an eight-character composite of the ZDM-PREFIX and DBSUB system parameter values. The identifier uniquely identifies the
    SYSVIEW for Db2
    data collector in the CA Mainframe Operational Intelligence infrastructure.
    If a data collector with the duplicate identifier attempts to connect to CSS Data Mover, the connection is rejected and the data collector connection task is halted. To resume the connection, use the data collector's CSS Data Mover Transfer Control START command or restart the data collector.
    This parameter can include underscore characters to ensure a total length of four alphanumeric characters.
    Default:
    The first four characters of the SYSPLEX name
Global Subsystem Parameters
The following parameters control connection to the Global Subsystem:
  • CALL-GSS=[
    YES
    |NO|ASYNC]
    Specifies whether calls are made to GSS for execution of IMODs, or for logging exceptions, utility phase executions, and Db2 commands. If GSS is not installed, available, or typically used, specify NO to reduce the overhead by eliminating the GSS call and subsequent error processing when GSS is not available. When GSS becomes available, change the parameter to ASYNC or YES and restart the data collector.
    The preferred setting for CALL-GSS is ASYNC. If ASYNC is specified, calls to IMOD $DBGL_ILOGMSG to log exceptions to the GSS ILOG and calls to IMOD IDB2MEXC to log exceptions to the System Condition Monitor, are done asynchronously. If the number of logged exceptions is high, this option can overload the GSS task. If you are logging thousands of exceptions per hour, set the CALL-GSS to YES and change your exception definitions to reduce the number of loggings.
    Default:
    YES
  • DCMSGS=[
    YES
    |NO]
    Specifies whether Message Handler calls the GSS to log console messages that are issued by this data collector for the later review.
    Default:
    YES
    Default in sample SYSPARMS member:
    NO
  • MSSUB=ISRV
    Specifies the MVS subsystem name for the Global Subsystem IMOD facility. If you changed this name when you installed the MVS subsystem names for GSS, also change the MSSUB= value here.
    Default in sample SYSPARMS member:
    ISRV
Migration Aid Parameters
The following migration aid parameters can be used in migrating new releases of the data collector and PC owner. These parameters limit the functionality of the NONSTOP parameter.
If you try to terminate Db2 with two data collectors attached, Db2 does not terminate as both nonstop data collectors are waiting until only its threads are active. Data collectors must be stopped until only one remains active.
  • PCSSID=
    xxxx
    Specifies a unique z/OS subsystem ID for the PC Owner with which the data collector is to operate in conjunction.
    Default:
    None (the data collector looks for a default PC SSID of DBGI).
  • TESTVER=
    xxxx
    Specifies a 1-4 character identifier for a separate unique data collector, which can be started on the same Db2 subsystem as another data collector.
    Default:
    R20
PARMLIB/XMAN/XNET Parameters
The following parameters are used to locate connection plan names and Xnet and Xmanager address spaces:
  • ENV=
    nn
    Specifies the environmental suffix value that determines which parmlib members to use. The parmlib members control which plan names and Xmanager task to use. If SUFFIX is also coded, the ENV parameter is used instead.
    If you specify a non-numeric value, include the value in single quotation marks. For example, 'XX'.
  • SUFFIX=
    nn
    Specifies the suffix value to use when reading parmlib members. The parmlib members control which plan names and Xmanager task to use. If ENV is also coded, the ENV parameter is used instead.
    Default:
    00
    If you specify a non-numeric value, include the value in single quotation marks. For example, 'XX'.
  • XNETAGT=[YES|
    NO
    ]
    Specifies whether the XNET agent subtask is attached and enabled. The XNET agent permits the transfer of
    SYSVIEW for Db2
    data to a remote XNET application, such as
    SYSVIEW
    , CA Cross-Enterprise Application Performance Management, or DBM Data Service.
    This option also controls the setting of the #IF XNETAGT IQL variable. If set to YES, the XNETAGT IQL variable has a
    true
    setting. This #IF IQL variable controls whether the online and history IQL requests used for XNET applications are started during the data collector initialization.
    Default:
    NO
  • XNETID='
    xxx
    '
    Specifies a string of characters to identify uniquely the
    SYSVIEW for Db2
    data collector. If you do not specify a value, a default string is generated (uses the data collector job name and Db2 subsystem ID).
    Limits:
    Up to 16 characters
OPS/MVS
Parameters
The following parameters control integration with
OPS/MVS
:
  • CA-OPS-HEARTBEAT-INTERVAL=
    x
    Controls
    OPS/MVS
    event notification (heartbeat) processing. The OPSEVENT service is used to signal the heartbeat and status information to System State Manager (SSM), which is a component of
    OPS/MVS
    . Status updates are provided on
    SYSVIEW for Db2
    events at a specified interval.
    Specify CA-OPS-HEARTBEAT-INTERVAL=0 to turn off this processing.
    Limits:
    0 to 30 minutes
    Default:
    5 minutes
    For more information about OPSEVENT, see the section
    Using General Facilities
    in the
    Common Information documentation. For more information about SSM, see the
    OPS/MVS
    documentation.
  • CALL-OPS=[
    YES
    |NO]
    Specifies whether to invoke
    OPS/MVS
    to issue an API event. If this system parameter is enabled, the API can be invoked for exceptions or IQL destination output. Specify NO, if
    OPS/MVS
    is not installed or is not typically used. If you start using
    OPS/MVS
    , change the value to YES and restart the data collector.
    Default:
    YES
    For more information about reporting exception events through the
    OPS/MVS
    interface, see Exception Action to Notify CA OPS/MVS.