[Previous] [Contents]

# 6. Outside interaction

## 6.1. Protocol

HTTP-report is used for transfer of the information through a network utilizing any Internet browser (without additional unique software is applied) with support format of data XML/XSLT or another software, focused for work with WEB-service. tv3 will process following inquiries:

GET:

/filter – structure of the filter and current statistics

/statistic – statistics of rules. The non-treelike structure consisting is provided, it contains the following fields: "id" of a rule, "path", fields "sent" and "recv". Some parameters are supported:

The compact form of result record:

/statistic?compact=Y

Conditions for inquiry interested statistic rules:

/statistic?path=local/users/*&sent=gt098834&recv=gt843243

/statistic?path=services/external/*&sent=gt098834&br=Y

The parameter "path" sets a mask that will be compared to fields "path" rules. Parameters "sent" and "recv" set conditions for values of fields "sent" and "recv" of the filter. Suffixes "gt" (more) and "lt" (less) can be applied. The parameter br=Y specifies, that it is necessary to include the enclosed rules of the rules corresponding inquiry in result of inquiry processing.

/status – some data about a current condition and a configuration tv3.

/observer – tracking of the packets getting in the chosen rule. First it is necessary to choose a traced rule inquiry/observer? id=N, where N - id rules. The information on the several last packets that have got in the chosen rule (a direction of transfer, the address of a source and the receiver the length of a packet) will come back to the subsequent inquiries without parameter. For a stop of tracking of packets it is necessary to execute Inquiry /observer? id =-1. The rights of the administrator are necessary to complete this inquiry.

POST:

/filter – set the new filter of packets. The filter should be transferred with use "content-type multipart/form-data" and a name of a file "filter.xml". The administrator rights are necessary to complete this inquiry.

DELETE:

/statistic - clear (zeroing) statistic. There could be conditions of select of rules that statistics should be cleared (see GET /statistic).

You can learn more details to familiarize with work of inquiries if you see the script <tv3 directory>\REXX\read.cmd .

## 6.2. The network interface

For the user on the desktop, tv3 is a web-server to that it is possible to address the Internet-browser capable to process XML/XSLT data (for example, one of set mozilla).

## 6.3. The PIPE-interface

The mechanism of inter-program interaction pipe is used for simple access to management and reading of a condition tv3. The standard http-report is supported through the pipe-interface. It allows to build REXX-scripts easily for management tv3 and receptions of the information for the further processing.

There are utilities written on standard REXX in structure of a package tv3:

setfilter.cmd – installation of the new filter;
reader.cmd – reception of the filter, statistic and clear statistic.

Each of them gives out the information on use at start without parameters.

[Previous] [Contents]