Previous page

Next page

Locate page in Contents

Print this page

get_realm

Summary:

Retrieves the list of the available Realms from the current Agent configuration.

Request specification:

Name

Min/Max

Type

Description

get_realm

1..1

none

 

Returns:

Name

Min/Max

Type

Description

realms

1..1

 

 

{

 

 

 

realm

1..[]

realmType

The list of the available realms. The appropriate data type will be used for a particular realm type (LDAP, System, etc.). See the subtypes of the realmType type for the available realm types.

}

 

 

 

Description:

The get_realm request can be executed without being logged in to Agent. It's purpose is to get the IDs of the available realms to use in the system/login call.

Example:

Input

<packet version="4.0.0">

<data>

<system>

<get_realm/>

</system>

</data>

</packet>

Output

<packet xmlns:ns3="http://www.swsoft.com/webservices/vzl/4.0.0/types" xmlns:ns1="http://www.swsoft.com/webservices/vzl/4.0.0/protocol" xmlns:ns2="http://www.swsoft.com/webservices/vzl/4.0.0/authm" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="8c46b82a5at18berf28" priority="0" version="4.0.0">

<origin>system</origin>

<target>vzclient4-2cbbe469-8f57-7f46-97fb-fd987231d957</target>

<data>

<system>

<realms>

<realm xsi:type="ns2:dir_realmType">

<login>

<name>Y249dnphZ2VudCxkYz1WWkw=</name>

<realm>3e761571-6607-1344-a064-a42679da8ed9</realm>

</login>

<builtin/>

<name>Virtuozzo Internal</name>

<type>1</type>

<id>3e761571-6607-1344-a064-a42679da8ed9</id>

<address>vzsveaddress</address>

<port>389</port>

<base_dn>dc=vzl</base_dn>

<default_dn>cn=users,dc=vzl</default_dn>

</realm>

<realm xsi:type="ns3:realmType">

<builtin/>

<name>System</name>

<type>0</type>

<id>00000000-0000-0000-0000-000000000000</id>

</realm>

<realm xsi:type="ns3:realmType">

<builtin/>

<name>Virtuozzo Container</name>

<type>1000</type>

<id>00000000-0000-0000-0100-000000000000</id>

</realm>

</realms>

</system>

</data>

</packet>

Please send us your feedback on this help page