Summary:
Contains a server status information.
Type specification:
Name |
Min/Max |
Type |
Description |
|
|
|
The server state code. |
|
|
|
The server transition code. |
Description:
A server can be either in a stable state (running, stopped, etc.) or it can be in transition to another stable state (starting, stopping, etc.). The available states and transitions can be retrieved from the Agent vocabulary. The vocabulary category for states is states
. The vocabulary category for transitions is transitions
. The following examples show how to retrieve the list states and transitions from the vocabulary.
Example:
Retrieving the list of states from the vocabulary.
Input
<packet version="4.0.0">
<data>
<system>
<get_vocabulary>
<name>generic</name>
<category>states</category>
</get_vocabulary>
</system>
</data>
</packet>
Output
<packet xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/system" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="11c47025a2dt1649r29c" priority="0" version="4.0.0">
<origin>gend</origin>
<target>vzclient2-4fce28dd-0cd3-1345-bb94-3192b940fb90</target>
<dst>
<director>gend</director>
</dst>
<data>
<system>
<vocabulary>
<name>generic</name>
<parameter>
<id>0</id>
<category>states</category>
<name>unknown</name>
</parameter>
<parameter>
<id>1</id>
<category>states</category>
<name>unexist</name>
</parameter>
<parameter>
<id>2</id>
<category>states</category>
<name>config</name>
</parameter>
<parameter>
<id>3</id>
<category>states</category>
<name>down</name>
</parameter>
<parameter>
<id>4</id>
<category>states</category>
<name>mounted</name>
</parameter>
<parameter>
<id>5</id>
<category>states</category>
<name>suspended</name>
</parameter>
<parameter>
<id>6</id>
<category>states</category>
<name>running</name>
</parameter>
<parameter>
<id>7</id>
<category>states</category>
<name>repairing</name>
</parameter>
<parameter>
<id>8</id>
<category>states</category>
<name>license violation</name>
</parameter>
</vocabulary>
</system>
</data>
</packet>
Example:
Retrieving the list of transitions from the vocabulary.
Input
<packet version="4.0.0">
<data>
<system>
<get_vocabulary>
<name>generic</name>
<category>transitions</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" id="12c47025aadt6df1r29c" priority="0" version="4.0.0">
<origin>gend</origin>
<target>vzclient2-4fce28dd-0cd3-1345-bb94-3192b940fb90</target>
<dst>
<director>gend</director>
</dst>
<data>
<system>
<vocabulary>
<name>generic</name>
<parameter>
<id>0</id>
<category>transitions</category>
<name>none</name>
</parameter>
<parameter>
<id>1</id>
<category>transitions</category>
<name>unknown</name>
</parameter>
<parameter>
<id>2</id>
<category>transitions</category>
<name>creating</name>
</parameter>
<parameter>
<id>3</id>
<category>transitions</category>
<name>mounting</name>
</parameter>
<parameter>
<id>4</id>
<category>transitions</category>
<name>starting</name>
</parameter>
<parameter>
<id>5</id>
<category>transitions</category>
<name>stopping</name>
</parameter>
<parameter>
<id>6</id>
<category>transitions</category>
<name>unmounting</name>
</parameter>
<parameter>
<id>7</id>
<category>transitions</category>
<name>destroying</name>
</parameter>
<parameter>
<id>8</id>
<category>transitions</category>
<name>moving</name>
</parameter>
<parameter>
<id>9</id>
<category>transitions</category>
<name>cloning</name>
</parameter>
<parameter>
<id>10</id>
<category>transitions</category>
<name>migrating</name>
</parameter>
<parameter>
<id>11</id>
<category>transitions</category>
<name>starting-repair</name>
</parameter>
<parameter>
<id>12</id>
<category>transitions</category>
<name>stopping-repair</name>
</parameter>
<parameter>
<id>13</id>
<category>transitions</category>
<name>setting</name>
</parameter>
<parameter>
<id>14</id>
<category>transitions</category>
<name>updating</name>
</parameter>
<parameter>
<id>15</id>
<category>transitions</category>
<name>backing-up</name>
</parameter>
<parameter>
<id>16</id>
<category>transitions</category>
<name>restoring</name>
</parameter>
<parameter>
<id>17</id>
<category>transitions</category>
<name>reinstalling</name>
</parameter>
<parameter>
<id>18</id>
<category>transitions</category>
<name>suspending</name>
</parameter>
<parameter>
<id>19</id>
<category>transitions</category>
<name>resuming</name>
</parameter>
<parameter>
<id>20</id>
<category>transitions</category>
<name>restarting</name>
</parameter>
</vocabulary>
</system>
</data>
</packet>