Previous page

Next page

Locate page in Contents

Print this page

get_list

Summary:

Retrieves a list of servers from a Virtuozzo group.

Request specification:

Name

Min/Max

Type

Description

get_list

 

 

 

{

 

 

 

count

0..1

int

Maximum number of servers to include in the list. Omit the element to retrieve all available servers.

type

0..1

string

Types of servers to retrieve:

generic -- physical servers.

virtuozzo -- Virtuozzo Containers.

Omit the element to retrieve the servers of all known types.

status

0..[]

env_statusType

Retrieve only the servers with the specified status.

options

0..1

 

Additional search options.

{

 

 

 

hostname

0..1

string

Hostname.

ip

0..1

ip_type

IP address.

}

 

 

 

}

 

 

 

Returns:

Name

Min/Max

Type

Description

eid

0..[]

eid_type

The list of Server IDs.

Description:

The call retrieves a list of IDs of the servers from a Virtuozzo group. Use the provided options to specify a search criteria to retrieve only the servers that you need. The call must be executed on the Master Node.

Example 1:

The following example retrieves a list of the physical servers, including Master Node and all Slave Nodes.

Input

<packet version="4.0.0" id="2">

<target>server_group</target>

<data>

<server_group>

<get_list>

<type>generic</type>

</get_list>

</server_group>

</data>

</packet>

Output

<?xml version="1.0" encoding="UTF-8"?><ns1:packet xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/server_group" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="17c45d1c4f4t99rd54" time="2007-02-12T07:35:39+0000" priority="0" version="4.0.0">

<ns1:origin>server_group</ns1:origin>

<ns1:target>vzclient3</ns1:target>

<ns1:dst>

<ns1:director>gend</ns1:director>

</ns1:dst>

<ns1:data>

<ns2:server_group>

<ns2:eid>89e27960-97b8-461f-902f-557b4b16784b</ns2:eid>

<ns2:eid>72145bf0-7562-43d4-b707-cc33d37e3f10</ns2:eid>

</ns2:server_group>

</ns1:data>

<ns1:src>

<ns1:director>gend</ns1:director>

</ns1:src>

</ns1:packet>

Example 2:

The following example retrieves a list of all servers, including physical servers and Virtuozzo Containers.

Input

<packet version="4.0.0" id="2">

<target>server_group</target>

<data>

<server_group>

<get_list/>

</server_group>

</data>

</packet>

Output

<?xml version="1.0" encoding="UTF-8"?><ns1:packet xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/server_group" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="14c45d1c7cbt7e87r538" time="2007-02-12T05:13:48+0000" priority="0" version="4.0.0">

<ns1:origin>server_group</ns1:origin>

<ns1:target>vzclient4</ns1:target>

<ns1:dst>

<ns1:director>gend</ns1:director>

</ns1:dst>

<ns1:data>

<ns2:server_group>

<ns2:eid>89e27960-97b8-461f-902f-557b4b16784b</ns2:eid>

<ns2:eid>3288bb6b-8a49-4230-b565-6ad5521182aa</ns2:eid>

<ns2:eid>57c2cd6c-c02b-4645-bdb5-e883ea005896</ns2:eid>

<ns2:eid>72145bf0-7562-43d4-b707-cc33d37e3f10</ns2:eid>

</ns2:server_group>

</ns1:data>

<ns1:src>

<ns1:director>gend</ns1:director>

</ns1:src>

</ns1:packet>

Please send us your feedback on this help page