OMF Main Page » Design Documents » AM API »
List of all services available for the AM inventory class of service¶
1 <services>
2
3 <serviceGroup name="inventory" prefix="/inventory">
4 <info>Service to retrieve information about nodes or testbeds from the Inventory Database</info>
5
6 <service name="getAllDeviceAliases">
7 <info>Get list of device aliases defined in the inventory</info>
8 <args>
9 <arg isRequired="true" name="domain" value="domain">
10 <info>domain for the alias list</info>
11 </arg>
12 </args>
13 </service>
14
15 <service name="getAllMacAddresses">
16 <info>Get the MAC addresses of all the interfaces on a given node on a given domain</info>
17 <args>
18 <arg isRequired="true" name="y" value="ycoord">
19 <info>y coordinates of location</info>
20 </arg>
21 <arg isRequired="true" name="domain" value="domain">
22 <info>testbed/domain for this given node</info>
23 </arg>
24 <arg isRequired="true" name="x" value="xcoord">
25 <info>x coordinates of location</info>
26 </arg>
27 </args>
28 </service>
29
30 <service name="getAllNodesWithAliasDevice">
31 <info>Get list of nodes that have devices with the human readable alias (tag)</info>
32 <args>
33 <arg isRequired="true" name="domain" value="domain">
34 <info>domain for this node list</info>
35 </arg>
36 <arg isRequired="true" name="alias" value="alias">
37 <info>Device alias (tag)</info>
38 </arg>
39 </args>
40 </service>
41
42 <service name="getAllNodesWithOui">
43 <info>Get list of nodes that have network cards with given OUI (first 3 bytes) on a given domain</info>
44 <args>
45 <arg isRequired="true" name="oui" value="oui">
46 <info>First three bytes of the OUI as B1:B2:B3</info>
47 </arg>
48 <arg isRequired="true" name="domain" value="domain">
49 <info>domain for this node list</info>
50 </arg>
51 </args>
52 </service>
53
54 <service name="getAllWirelessDevices">
55 <info>Get list of wireless devices on a given node in a given domain.</info>
56 <args>
57 <arg isRequired="true" name="y" value="ycoord">
58 <info>y coordinate of given node</info>
59 </arg>
60 <arg isRequired="true" name="domain" value="domain">
61 <info>domain of given node</info>
62 </arg>
63 <arg isRequired="true" name="x" value="xcoord">
64 <info>x coordinate of given node</info>
65 </arg>
66 </args>
67 </service>
68
69 <service name="getConfig">
70 <info>Get all Specific Configuration Parameters for a given Testbed</info>
71 <args>
72 <arg isRequired="true" name="domain" value="domain">
73 <info>domain for which we want to retrieve the config parameters.</info>
74 </arg>
75 </args>
76 </service>
77
78 <service name="getControlIP">
79 <info>Get the Control IP address of a given node for a given domain</info>
80 <args>
81 <arg isRequired="true" name="y" value="ycoord">
82 <info>y coordinates of location</info>
83 </arg>
84 <arg isRequired="true" name="domain" value="domain">
85 <info>testbed/domain for this given node</info>
86 </arg>
87 <arg isRequired="true" name="x" value="xcoord">
88 <info>x coordinates of location</info>
89 </arg>
90 </args>
91 </service>
92
93 <service name="getMacAddress">
94 <info>Get the MAC address of a given interface on a given node for a given domain</info>
95 <args>
96 <arg isRequired="true" name="y" value="ycoord">
97 <info>y coordinates of location</info>
98 </arg>
99 <arg isRequired="true" name="domain" value="domain">
100 <info>testbed/domain for this given node</info>
101 </arg>
102 <arg isRequired="true" name="ifname" value="interfaceName">
103 <info>name of the interface (e.g. ath0).</info>
104 </arg>
105 <arg isRequired="true" name="x" value="xcoord">
106 <info>x coordinates of location</info>
107 </arg>
108 </args>
109 </service>
110
111 </serviceGroup>
112
113 </services>