Previous page

Next page

Locate page in Contents

Print this page

start_monitor

Summary:

Starts the process monitor.

Request specification:

Name

Min/Max

Type

Description

start_monitor

 

 

 

{

 

 

 

period

1..1

int

Reporting period in seconds.

key

0..1

string

Parameter to order the result set by. A list of the parameters can be retrieved from the Agent vocabulary. The category name is ps. See the example of how to get the list of parameters below.

limit

0..1

int

Maximum number of processes to include in the report.

descending

0..1

 

If present, the list will be ordered in descending order.

}

 

 

 

Returns:

Name

Min/Max

Type

Description

ps_info

1..1

ps_infoType

Processes information.

Description:

The call starts the process monitor on the server. The monitor sends the collected data back to the client at the specified time intervals until the client stops the monitor or disconnects from Agent. Only one process monitor can be running for a given connection.

To retrieve the list of the available process parameters from the Agent vocabulary, use the following request:

Input

<packet version="4.0.0">

<data>

<system>

<get_vocabulary>

<category>ps</category>

</get_vocabulary>

</system>

</data>

</packet>

Output

<?xml version="1.0" encoding="UTF-8"?><packet xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/system" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="4.0.0" priority="0" id="6c479f579et2cd6r6c0">

<origin>gend</origin>

<target>vzclient26-ca7c47e9-0aa6-904e-b1d8-851090716227</target>

<dst>

<director>gend</director>

</dst>

<data>

<system>

<vocabulary>

<name>generic</name>

<parameter>

<id>pid</id>

<category>ps</category>

<type>int</type>

<short>PID</short>

<long>The identifier of the process.</long>

<search/>

</parameter>

<parameter>

<id>user</id>

<category>ps</category>

<type>string</type>

<short>User</short>

<long>The user who has launched the process.</long>

<search/>

</parameter>

<parameter>

<id>pri</id>

<category>ps</category>

<type>int</type>

<short>Pri</short>

<long>The kernel scheduling priority for the process.</long>

</parameter>

<parameter>

<id>ni</id>

<category>ps</category>

<type>int</type>

<short>Nice</short>

<long>The 'nice' parameter value defining the overall scheduling priority for the process. The less the 'nice' value, the higher the process priority.</long>

</parameter>

<parameter>

<id>rss</id>

<category>ps</category>

<type>int</type>

<short>RSS</short>

<long>The total amount of physical memory used by the process, in kilobytes.</long>

</parameter>

<parameter>

<id>stat</id>

<category>ps</category>

<type>string</type>

<short>Stat</short>

<long>The process current status. Can be 'R' (running), 'S' (sleeping, waiting for 'wake-up call'), 'D' (uninterruptable sleep), 'Z' (zombie, waiting for parent process), 'T' (stopped or traced). Sometimes the second symbol may appear: 'W' (process swapping), 'N' ('niced' process), 'L' (process has pages locked into memory). If the &lt; sign is displayed after the status, it means that this information was returned by the Parallels Agent software which, in turn, got this information from the 'ps' tool.</long>

</parameter>

<parameter>

<id>%cpu</id>

<category>ps</category>

<type>float</type>

<short>%CPU</short>

<long>The CPU time, in percent, used by the process.</long>

</parameter>

<parameter>

<id>%mem</id>

<category>ps</category>

<type>float</type>

<short>%MEM</short>

<long>The amount of physical memory, in megabytes, used by the process.</long>

</parameter>

<parameter>

<id>time</id>

<category>ps</category>

<type>string</type>

<short>Time</short>

<long>The total CPU time the process has used since its launching. If the cumulative mode is on, this time also includes the CPU time used by the process children that have already died.</long>

</parameter>

<parameter>

<id>command</id>

<category>ps</category>

<type>string</type>

<short>Command</short>

<long>The command that invoked the process.</long>

<search/>

</parameter>

</vocabulary>

</system>

</data>

</packet>

Please send us your feedback on this help page