IBM Tivoli Monitoring > Version 6.3 Fix Pack 2 > Administrator's Guide > Agent-based services > Agent Service Interface > Agent Service Interface - Service Interface Request

IBM Tivoli Monitoring, Version 6.3 Fix Pack 2


Agent Service Interface request - Attribute group report

Use <REPORT> in a Service Interface Request to get a report of the attribute group specified in the TABLENAME attribute, such as UNIXOS or NTPROCESS.


Request input


Agent Service Interface <REPORT> request

Tag Description
<REPORT> Enter begin and end REPORT tags to retrieve application table data for the table specified.
<SQLTABLE> SQLTABLE begin and end tags enclose the TABLENAME tagging pair to identify the SQL table definition set.
<TABLENAME> The TABLENAME begin and end tags enclose the table name to report. This is the name as it appears bracketed by begin and end tags. If you are not sure what the spelling is of the table, you can find it in the tabl field of the agent .atr file, located in the <install_dir>/TMAITM6/ATTRLIB directory.
<OUTPUT> Optional. Use OUTPUT begin and end tags and their subordinate tags to filter and refine the report.
<COLUMN> Define selected column name bracketed by begin and end tags.
<FILTER> Define output data rows filter criteria with begin and end tags. The filter follows the same syntax as the private situation <CRITERIA> element. See Private situation XML specification.

Sample request 1: Report all attributes in the UNIX OS table

    <REPORT>
     <SQLTABLE>
      <TABLENAME>UNIXOS</TABLENAME>
     </SQLTABLE>
    </REPORT>

Sample request 2: Summary report of the Windows Process attribute group with a filter and columns specified

The request is for the values in the _Total row.

    <REPORT>
     <SQLTABLE>
      <TABLENAME>NTPROCESS</TABLENAME>
       <OUTPUT>
        <COLUMN>ORIGINNODE</COLUMN>
        <COLUMN>TIMESTAMP</COLUMN>
        <COLUMN>INSTCNAME</COLUMN>
        <COLUMN>IDPROCESS</COLUMN>
        <COLUMN>PCTPRCSTME</COLUMN>
        <COLUMN>THREADCNT</COLUMN>
        <COLUMN>WRKINGSET</COLUMN>
       </OUTPUT>
      <FILTER>
      <![CDATA[ *VALUE INSTCNAME  *EQ _Total]]>
      </FILTER>
     </SQLTABLE>
    </REPORT>


Report output


Agent Service Interface <REPORT> request output.

Output tag Description
<REPORTDATA> Identify output report data set.
<ROWCOUNT> Output table row count.
<ROW> Identify an output row data.
<NAME> Define output column name enclosed by begin and end tags.
<DATA> Specify output column data value enclosed by begin and end tags.

Numeric output

The report does not format numeric values; they remain unformatted.

For example, if you were to get a report containing an attribute with a scale factor of 2, a value of 7 for that attribute would show in a table view in the Tivoli Enterprise Portal as 0.07. You can look up the scale factor, shown as scal in the attribute definition, in the attribute file:
<install_dir>\TMAITM6\ATTRLIB\kpc.atr
<install_dir>/platform/<pc>/tables/ATTRLIB/kpc.atr, where platform is the operating system and pc is the product code.

Enumerated values are also unformatted, so values shown in the report as 1 and 2, for example, would show their text equivalent (such as Started and Stopped) in the portal client. Enumerated attributes are defined in the kpc.atr attribute file: vale for the display value; vali for the unformatted value.

Sample output 1: UNIX OS output from a simple <REPORT> request

    <REPORTDATA><SQLTABLE><TABLENAME>UNIXOS</TABLENAME>
     <ROWCOUNT>1</ROWCOUNT><ROW><COLUMN><NAME>ORIGINNODE</NAME>
     <DATA><![CDATA[fvaix26:KUX]]></DATA></COLUMN><COLUMN>
     <NAME>SAMPLENO</NAME><DATA>0</DATA></COLUMN><COLUMN> 
     <NAME>ROWNO</NAME><DATA>0</DATA></COLUMN><COLUMN><NAME>TIMESTAMP</NAME>
     <DATA><![CDATA[1090629105627000]]></DATA></COLUMN><COLUMN>
     <NAME>SYSTEMTYPE</NAME><DATA><![CDATA[AIX]]></DATA> </COLUMN><COLUMN>
     <NAME>SYSTEMVERS</NAME><DATA><![CDATA[5.3]]> </DATA></COLUMN><COLUMN>
     <NAME>TOTREALMEM</NAME><DATA>3915776</DATA> </COLUMN><COLUMN>
     <NAME>TOTVIRTMEM</NAME><DATA>8634368</DATA> </COLUMN><COLUMN>
     <NAME>SYSUPTIME</NAME><DATA>6633819</DATA> </COLUMN><COLUMN>
     <NAME>NOUSRSESS</NAME><DATA>1</DATA> </COLUMN><COLUMN>
     <NAME>NOSYSPROCS</NAME><DATA>112</DATA> </COLUMN><COLUMN>
     <NAME>NETADDR</NAME>
      <DATA><![CDATA[9.42.11.174]]> </DATA></COLUMN><COLUMN>
     <NAME>UNIXUSRCPU</NAME><DATA>1</DATA> </COLUMN><COLUMN>
     <NAME>UNIXSYSCPU</NAME><DATA>1</DATA> </COLUMN><COLUMN>
     <NAME>UNIXIDLCPU</NAME><DATA>98</DATA> </COLUMN><COLUMN>
     <NAME>UNIXWAITIO</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>VMINRUNQ</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>VMINPGWAIT</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>VMPGFAULTS</NAME><DATA>1538</DATA> </COLUMN><COLUMN>
     <NAME>VMPGRCLM</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>VMPGIN</NAME><DATA>2</DATA></COLUMN> <COLUMN>
     <NAME>VMPGOUT</NAME><DATA>1</DATA></COLUMN> <COLUMN>
     <NAME>VMPGSIN</NAME><DATA>1</DATA></COLUMN> <COLUMN>
     <NAME>VMPGSOUT</NAME><DATA>0</DATA></COLUMN> <COLUMN>
     <NAME>VMFREEMEM</NAME><DATA>7614492</DATA></COLUMN> <COLUMN>
     <NAME>VMFREESWAP</NAME><DATA>1019876</DATA> </COLUMN><COLUMN>
     <NAME>PSWITCH</NAME><DATA>5357</DATA> </COLUMN><COLUMN>
     <NAME>SYSCALL</NAME><DATA>42598</DATA> </COLUMN><COLUMN>
     <NAME>SYSFORK</NAME><DATA>337</DATA> </COLUMN><COLUMN>
     <NAME>SYSEXEC</NAME><DATA>274</DATA> </COLUMN><COLUMN>
     <NAME>BREAD</NAME><DATA>0</DATA></COLUMN> <COLUMN>
     <NAME>BWRITE</NAME><DATA>0</DATA></COLUMN><COLUMN> 
     <NAME>LREAD</NAME><DATA>0</DATA></COLUMN><COLUMN>
     <NAME>LWRITE</NAME> <DATA>0</DATA></COLUMN><COLUMN>
     <NAME>PHREAD</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>PHWRITE</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>RCVINT</NAME><DATA>-1</DATA> </COLUMN><COLUMN>
     <NAME>XMTINT</NAME><DATA>-1</DATA> </COLUMN><COLUMN>
     <NAME>MDMINT</NAME><DATA>-1</DATA> </COLUMN><COLUMN>
     <NAME>NETCONNECT</NAME><DATA>-1</DATA> </COLUMN><COLUMN>
     <NAME>NETSOCKET</NAME><DATA>-1</DATA> </COLUMN><COLUMN>
     <NAME>NETLOAD1</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>NETLOAD2</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>NETLOAD3</NAME><DATA>2</DATA> </COLUMN><COLUMN>
     <NAME>MEMFREE</NAME><DATA>108812</DATA> </COLUMN><COLUMN>
     <NAME>MEMUSED</NAME><DATA>3806964</DATA> </COLUMN><COLUMN>
     <NAME>VMSCAN</NAME><DATA>0</DATA></COLUMN> <COLUMN>
     <NAME>VMUSEDPRC</NAME><DATA>119</DATA></COLUMN> <COLUMN>
     <NAME>VMFREEPRC</NAME><DATA>881</DATA></COLUMN> <COLUMN>
     <NAME>CPUBUSY</NAME><DATA>2</DATA></COLUMN> <COLUMN>
     <NAME>SYSREAD</NAME><DATA>5694</DATA></COLUMN> <COLUMN>
     <NAME>SYSWRITE</NAME><DATA>749</DATA></COLUMN> <COLUMN>
     <NAME>NSYSTHRD</NAME><DATA>-1</DATA></COLUMN> <COLUMN>
     <NAME>PRUNABLE</NAME><DATA>112</DATA></COLUMN> <COLUMN>
     <NAME>PRUNNING</NAME><DATA>-1</DATA></COLUMN> <COLUMN>
     <NAME>PSLEEPING</NAME><DATA>0</DATA></COLUMN> <COLUMN>
     <NAME>PIDLE</NAME><DATA>0</DATA></COLUMN><COLUMN> 
     <NAME>PZOMBIE</NAME><DATA>0</DATA></COLUMN><COLUMN> 
     <NAME>PSTOPPED</NAME><DATA>0</DATA></COLUMN><COLUMN> 
     <NAME>THRDRUNQ</NAME><DATA>-1</DATA></COLUMN><COLUMN> 
     <NAME>THRDWAIT</NAME><DATA>-1</DATA></COLUMN><COLUMN> 
     <NAME>BOOTTIME</NAME>
      <DATA><![CDATA[1090413161248000]]> </DATA></COLUMN><COLUMN>
     <NAME>PENDIOWT</NAME><DATA>-1</DATA> </COLUMN><COLUMN>
     <NAME>STARTIO</NAME><DATA>-1</DATA> </COLUMN><COLUMN>
     <NAME>DEVINT</NAME><DATA>-1</DATA> </COLUMN><COLUMN>
     <NAME>UPTIME</NAME>
      <DATA><![CDATA[076d18:43:39]]> </DATA></COLUMN><COLUMN>
     <NAME>ZATTRIB</NAME><DATA><![CDATA[ ]]> </DATA></COLUMN><COLUMN>
     <NAME>ZVALUE</NAME><DATA><![CDATA[ ]]> </DATA></COLUMN><COLUMN>
     <NAME>SWAPFREE</NAME><DATA>7436</DATA> </COLUMN><COLUMN>
     <NAME>PGINRATE</NAME><DATA>9</DATA> </COLUMN><COLUMN>
     <NAME>PGOUTRATE</NAME><DATA>6</DATA> </COLUMN><COLUMN>
     <NAME>PGSCANRATE</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>AVPGINS1</NAME><DATA>1</DATA> </COLUMN><COLUMN>
     <NAME>AVPGINS5</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>AVPGINS15</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>AVPGINS60</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>AVPGOUT1</NAME><DATA>3</DATA> </COLUMN><COLUMN>
     <NAME>AVPGOUT5</NAME><DATA>3</DATA> </COLUMN><COLUMN>
     <NAME>AVPGOUT15</NAME><DATA>3</DATA> </COLUMN><COLUMN>
     <NAME>AVPGOUT60</NAME><DATA>3</DATA> </COLUMN><COLUMN>
     <NAME>AVPGSCAN1</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>AVPGSCAN5</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>AVPGSCAN15</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>AVPGSCAN60</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>AVPRRUNQ60</NAME><DATA>0</DATA> </COLUMN><COLUMN>
     <NAME>NETADDR6</NAME>
      <DATA><![CDATA[No DNS Entry]]> </DATA></COLUMN><COLUMN>
     <NAME>ZID</NAME><DATA>-1</DATA> </COLUMN><COLUMN>
     <NAME>ZONE</NAME><DATA><![CDATA[-1]]> </DATA></COLUMN>
    </ROW></SQLTABLE>
    </REPORTDATA> 

Sample output 2: Report with a filter and columns specified

This is the output from the sample request of Windows Process attributes in the _Total row.

    <REPORTDATA>
     <STATUS>0</STATUS>
     <SQLTABLE>
      <TABLENAME>NTPROCESS</TABLENAME>
      <ROWCOUNT>1</ROWCOUNT>
      <ROW>
       <COLUMN>
        <NAME>ORIGINNODE</NAME>
        <DATA>Primary:DYANG7:NT</DATA>
       </COLUMN>
       <COLUMN>
        <NAME>TIMESTAMP</NAME>
        <DATA>1090303122813634</DATA>
       </COLUMN>
       <COLUMN>
        <NAME>INSTCNAME</NAME>
        <DATA>_Total</DATA>
       </COLUMN>
       <COLUMN>
        <NAME>PCTPRCSTME</NAME>
        <DATA>99</DATA>
       </COLUMN>
       <COLUMN>
        <NAME>IDPROCESS</NAME>
        <DATA>0</DATA>
       </COLUMN>
       <COLUMN>
        <NAME>THREADCNT</NAME>
        <DATA>1057</DATA>
       </COLUMN>
       <COLUMN>
        <NAME>WRKINGSET</NAME>
        <DATA>1088495616</DATA>
       </COLUMN>
      </ROW>
     </SQLTABLE>
    </REPORTDATA>


Parent topic:

Agent Service Interface - Service Interface Request

+

Search Tips   |   Advanced Search