Connect CDC SQData. SQDMon Utility Reference. Version 4.0

(1)

Connect CDC SQData

SQDMon Utility Reference

(2)

2 Connect CDC SQData SQDMon Utility Reference

Version 4.0

(3)

SQDMon Utility Reference

Introduction ... 4

SQDMON Utility Summary ... 5

Organization ... 6

Documentation Conventions ... 7

Utility Command Syntax ... 9

(4)

This document provides a reference to the functions and syntax of theSQDMON Utility. This remainder of this section:

· Summarizes features and functions of the SQDMON utility

(5)

Introduction

SQDMON Utility Summary

The SQDMON utility communicates with sqdaemons on both local and remote platforms to assess the overall status and configuration of the sqdaemon and to refresh its configuration following changes to sqdaemon configuration files. It is also used to start, stop and query information from agents running under the control of the daemon. Access to the sqdaemon by SQDMON is controlled by a public/private key authentication scheme described in detail in the Secure Communications Guide and by the local Access Control Configuration file used by the sqdaemon.

(6)

Organization

This document contains the following sections:

(7)

Introduction

Documentation Conventions

The following conventions are used in command and configuration syntax and examples in this document.

Convention Explanation Example

Regular type Items in regular type must be entered literally using either lowercase or uppercase letters. Items in Bold type are usually "commands" or "Actions". Note, uppercase is often used in "z/OS" objects for consistency just as lowercase is often used on other platforms where case may be either enforced or optional.

create

CCSID /directory //SYSOUT DD *

<variable> Items between < and > symbols represent variables. You must substitute an appropriate numeric or text value for the variable.

<file_name>

| Bar A vertical Bar indicates that a choice must be made among items in a list separated by bars.

'yes' | 'no' JSON | AVRO

[ ] Brackets Brackets indicate that item is optional. A choice may be made among multiple items contained in brackets.

[alias] OR [+ | -]

-- Double dash Double dashes "--" identify an option keyword. Some keywords may be abbreviated and preceded by a single dash "-". A double dash in some contexts can be used to indicate the start of a single line comment.

--service=<port> OR -s <port> OR --apply OR -- this is a comment

… Ellipsis An ellipsis indicates that the preceding argument or group of arguments may be repeated.

[expression…]

Sequence number

A sequence number indicates that a series of arguments or values may be specified. The sequence number itself must never be specified.

field2

' ' Single quotes Single quotation marks that appear in the syntax must be specified literally.

(8)

Utility Command Syntax

Each function performed by SQDMON has its own set of keywords and parameters. The following table summarizes the Actions that can be issued to the SQDMON Utility.

Action Description

inventory Display the list of agents defined to the sqdaemon and

their summary level status

reload Instruct the sqdaemon to reload its configuration files

display Display a detail level snapshot of a single agent"s status

start Instruct the sqdaemon to start an agent

stop Instruct the sqdaemon to stop an agent

Shutdown Instruct the sqdaemon to gracefully terminate itself

Syntax

The general Syntax for SQDMON is as follows

sqdmon action [url] format=<type>] [-s port_num | --service=port_num] [--identity=<path_to_nacl_id/nacl_id>] [--tls]

Note: sqdmon displays the result on stdout or it’s equivalent. When such a result is produced, its format depends on

(10)

inventory

Display the inventory of the agents and their current status under control of the sqdaemon listening on the host and port specified in argument.

Syntax

<%PREFIX_LC%>mon inventory url [,url ] [--format=xml | details] [-s port_num | --service=port_num] [--identity=<path_to_nacl_id/nacl_id>] [--tls]

Keyword and Parameter Descriptions

format=xml Produces an xml-formatted output, convenient for machine consumption whereas --format=details, the default, produces human readable output.

url Typically //host_name of the sqdaemon on that system. No host_name is required for "Localhost"

-s port_num | --service=port_num A port number is required for both "Localhost" and remote sqdaemons unless they are listening on the Connect CDC SQData default port number 2626.

--identity=<path_to_nacl_id/nacl_id> The location of the user's private key. Only required if it is not in the default location, the .nacl directory under the user's home directory.

--tls - Specifies that a secure TLS connection will be made to zOS (ONLY) Daemon, Capture and Publisher components already configured to run under IBM's Application Transparent Transport Layer Security (AT-TLS).

(11)

Utility Command Syntax

reload

Instructs the sqdaemon to reload or refresh the contents of its configuration files loaded into memory when the sqdaemon was started.

Syntax

sqdmon reload url [ ,url ] [-s port_num | --service=port_num ] [--identity=<path_to_nacl_id/nacl_id>]

url Typically //host_name of the sqdaemon on that system. No host_name is required for "Localhost"

(12)

display

Instructs the sqdaemon to display information about the state of the agents (capture/publisher or engine agents only) identified in the arguments. For engine agents this includes datastore level statistics.

Syntax

<%PREFIX_LC%>mon display [ --format=xml | details ] url [ ,url ] [-s port_num | --service=port_num ] [--identity=<path_to_nacl_id/nacl_id>] [--tls]

format=xml Produces an xml-formatted output, convenient for machine consumption whereas --format=details, the default, produces human readable output.

url Typically //host_name/agent_name as defined in the sqdagents.cfg file of the sqdaemon on that host system. No host_name is required for "Localhost"

--tls - Specifies that a secure TLS connection will be made to zOS (ONLY) Daemon, Capture and Publisher components already configured to run under IBM's Application Transparent Transport Layer Security (AT-TLS).

(13)

Utility Command Syntax

start

Instructs the sqdaemon to "start" the Engine (only) agents identified in the url arguments.

Syntax

sqdmon start url [ ,url ] [-s port_num | --service=port_num ] [--identity=<path_to_nacl_id/nacl_id>]

(14)

stop

Instructs the sqdaemon to "stop" the Engine (only) agents identified in the url arguments.

Syntax

sqdmon stop url [ ,url ] [-s port_num | --service=port_num ] [--identity=<path_to_nacl_id/nacl_id>]

(15)

Utility Command Syntax

Shutdown

Instructs the sqdaemon to gracefully terminate itself.

Syntax

<%PREFIX_LC%>mon shutdown [-s port_num | --service=port_num ] [--identity=<path_to_nacl_id/nacl_id>]

url Typically //host_name No host_name is required for "Localhost"

(16)

The utility can be executed on z/OS with JCL similar to sample member SQDMON included in the distribution, as in the sample below:

//*--- //* EXECUTES SQDATA DAEMON CONTROL PROGRAM - SQDMON //*--- //* NOTE: PARMS MUST BE ENTERED IN LOWER CASE //*--- //JOBLIB DD DISP=SHR,DSN=SQDATA.V400.LOADLIB //* //SQDMON EXEC PGM=SQDMON //SQDPUBL DD DSN=SQDATA.NACL.PUBLIC,DISP=SHR //SQDPKEY DD DSN=SQDATA.NACL.PRIVATE,DISP=SHR //SYSOUT DD SYSOUT=* //SQDLOG DD SYSOUT=* //*SQDLOG8 DD DUMMY //SQDPARMS DD * inventory //<host_name> -s 2626

The syntax for Open Systems and Windows are identical and can be run at the command prompt or in a script:

sqdmon inventory //<host_name> -s 2626

(17)

Operational Considerations

sqdmon can only perform start and stop functions on the AIX, linux and Windows platforms.

(18)

C

Controller Daemon 5

D

display 12

I

inventory 10

J

JCL 16

L

linux 17

P

public/private key authentic 5

(19)

2 Bl ue Hi l l Pl a za Pea rl Ri ver, NY 10965 USA

preci s el y.com

Connect CDC SQData. SQDMon Utility Reference. Version 4.0