Summary:
Retrieves the Agent vocabulary data. The call parameters can be used to perform selective retrieval of the vocabulary entries.
Request specification:
Name |
Min/Max |
Type |
Description |
|
|
|
|
|
|
|
|
|
|
|
The name of the plug-in. There's a separate section in the vocabulary for every Agent plug-in. By specifying the plug-in name here, you will limit the search to that section only. |
|
|
|
The name of the parameter in the vocabulary. if you know the name of the parameter that you are looking for, you may specify it here. The information will be retrieved for that parameter only. If the |
|
|
|
The name of the category in the vocabulary. If specified, the search will be limited to that category only. |
|
|
|
|
Returns:
Name |
Min/Max |
Type |
Description |
|
|
The requested Agent vocabulary data. If none of the input parameters were specified in the request, this data structure will contain the entire vocabulary. |
Description:
The main purpose of the Agent vocabulary is to make the most common server specific information independent from a particular Agent implementation.
Example:
Retrieving the counters
category parameters from the generic
section of the vocabulary. This query will return the names of the performance counters used for server monitoring.
Input
<packet version="4.0.0">
<data>
<system>
<get_vocabulary>
<name>generic</name>
<category>counters</category>
</get_vocabulary>
</system>
</data>
</packet>
Output
<?xml version="1.0" encoding="UTF-8"?><ns1:packet xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/system" xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="12c46713b39t5af1r81c" priority="0" version="4.0.0">
<ns1:origin>gend</ns1:origin>
<ns1:target>vzclient3-638a2a56-e689-c340-877d-bd0470f2448c</ns1:target>
<ns1:dst>
<ns1:director>gend</ns1:director>
</ns1:dst>
<ns1:data>
<ns1:system>
<ns2:vocabulary>
<ns2:name>generic</ns2:name>
<ns2:category>
<id>counters_cpu</id>
<category>generic</category>
<category>counters</category>
<short>CPU usage</short>
<long>Hardware Node CPU related parameters</long>
</ns2:category>
<ns2:category>
<id>counters_disk</id>
<category>generic</category>
<category>counters</category>
<short>Disk usage</short>
<long>Disk usage related parametres</long>
</ns2:category>
<ns2:category>
<id>counters_memory</id>
<category>generic</category>
<category>counters</category>
<short>Memory usage</short>
<long>Memory usage related parametres</long>
</ns2:category>
<ns2:category>
<id>counters_net</id>
<category>generic</category>
<category>counters</category>
<short>Network usage</short>
<long>Network usage related parametres</long>
</ns2:category>
<ns2:category>
<id>counters_loadavg</id>
<category>generic</category>
<category>counters</category>
<short>Load average</short>
<long>CPU usage related parametres</long>
</ns2:category>
<ns2:category>
<id>counters_process</id>
<category>generic</category>
<category>counters</category>
<short>Process info</short>
<long>Process info related parametres</long>
</ns2:category>
<ns2:category>
<id>counters_system</id>
<category>generic</category>
<category>counters</category>
<short>System info</short>
<long>System info related parametres</long>
</ns2:category>
</ns2:vocabulary>
</ns1:system>
</ns1:data>
</ns1:packet>