Using ORBIT Web based services

ORBIT support services have web based XML interfaces. They are all written using the same framework and, therefore, have like syntax. Below is a list of available services and their corresponding arguments.

CMC

<serviceGroup name="cmc">
          <info>Controls nodes through their attached CMs</info>
          <service name="on">
            <info>Switch on a node at a specific coordinate</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="nodeSetOn">
            <info>Switch on a specified set of nodes</info>
            <args><arg name="nodes" value="set_of_nodes"/></args>
          </service>
          <service name="allOn">
            <info>Switch all nodes on</info>
          </service>
          <service name="off">
            <info>Switch on a node at a specific coordinate</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="offHard">
            <info>Switch off hard a node at a specific coordinate</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="allOffHard">
            <info>Switch all nodes off</info>
          </service>
          <service name="nodeSetOffHard">
            <info>Switch Off Hard a specified set of nodes</info>
            <args><arg name="nodes" value="set_of_nodes"/></args>
          </service>
          <service name="offSoft">
            <info>Switch off soft a node at a specific coordinate</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="allOffSoft">
            <info>Switch all nodes off</info>
          </service>
          <service name="nodeSetOffSoft">
            <info>Switch Off Soft a specified set of nodes</info>
            <args><arg name="nodes" value="set_of_nodes"/></args>
          </service>
          <service name="reset">
            <info>Reset a node at a specific coordinate</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="allReset">
            <info>Reset all nodes</info>
          </service>
          <service name="nodeSetReset">
            <info>Reset a specified set of nodes</info>
            <args><arg name="nodes" value="set_of_nodes"/></args>
          </service>
          <service name="identify">
            <info>Identify a node at a specific coordinate</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="allIdentify">
            <info>Identify all nodes</info>
          </service>
          <service name="nodeSetIdentify">
            <info>Identify a specified set of nodes</info>
            <args><arg name="nodes" value="set_of_nodes"/></args>
          </service>
          <service name="updateEnable">
            <info>UpdateEnable a node at a specific coordinate</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="nodeSetUpdateEnable">
            <info>Update Enable a specified set of nodes</info>
            <args><arg name="nodes" value="set_of_nodes"/></args>
          </service>
          <service name="updateDisable">
            <info>UpdateDisable a node at a specific coordinate</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="nodeSetUpdateDisable">
            <info>Update Disable a specified set of nodes</info>
            <args><arg name="nodes" value="set_of_nodes"/></args>
          </service>
          <service name="hostEnroll">
            <info>Host Enroll a node at a specific coordinate</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="allHostEnroll">
            <info>Host Enroll all nodes</info>
          </service>
          <service name="nodeSetHostEnroll">
            <info>Host Enroll a specified set of nodes</info>
            <args><arg name="nodes" value="set_of_nodes"/></args>
          </service>
          <service name="nodeStatus">
            <info>Return the status of a  node at a specific coordinate</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="setNodeInactive">
            <info>Set Inactive a Node from the Testbed</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="nodeSetNodeInactive">
            <info>Set Inactive a specified set of nodes</info>
            <args><arg name="nodes" value="set_of_nodes"/></args>
          </service>
          <service name="setNodeActive">
            <info>Set Active a Node from the Testbed</info>
            <args><arg name="x" value="x_coord"/></args>
            <args><arg name="y" value="y_coord"/></args>
          </service>
          <service name="nodeSetNodeActive">
            <info>Set Active a specified set of nodes</info>
            <args><arg name="nodes" value="set_of_nodes"/></args>
          </service>
          <service name="allStatus">
            <info>Returns the status of the entire Testbed</info>
          </service>
          <service name="getActiveNodes">
            <info>Get List of all Active Nodes from the Testbed</info>
          </service>
          <service name="getNodes">
            <info>Get all Nodes for a specified domain</info>
            <args><arg name="nodes" value="set_of_nodes"/></args>
          </service>
          <service name="getAllNodes">
            <info>Get List of all Nodes in the Testbed</info>
          </service>
        </serviceGroup>

Frisbee

<serviceGroup name="frisbee">
          <info>Serve node images via a frisbee server</info>
          <service name="getAddress">
            <info>Get the port number of a frisbee server serving a specified image</info>
            <args><arg name="img" value="imageName"/></args>
          </service>
          <service name="stop">
            <info>Stop serving a specified image</info>
            <args><arg name="img" value="imageName"/></args>
          </service>
          <service name="status">
            <info>Returns the status of either a specific daemon, or all of them</info>
            <args><arg name="img" value="imageName" optional="true"/></args>
          </service>
        </serviceGroup>

PXE

<serviceGroup name="pxe">
          <info>Serve node images via a pxe server</info>
          <service name="setBootImage">
            <info>Configure PXE to boot a node with a specific ip address into a specifif image</info>
            <args><arg name="img" value="imageName"/></args>
            <args><arg name="node" value="nodeName"/></args>
            <args><arg name="ip" value="ipAddress"/></args>
          </service>
          <service name="clearBootImage">
            <info>Configure PXE to boot a node into the image on its disk</info>
            <args><arg name="node" value="nodeName"/></args>
            <args><arg name="ip" value="ipAddress"/></args>
          </service>
          <service name="removeAllBootImages">
            <info>Configure PXE to boot all nodes into the image on their disks</info>
          </service>
          <service name="status">
            <info>Returns a list of IP addresses and their associated boot image</info>
          </service>
        </serviceGroup>

OML Collection Service

<serviceGroup name="oml">
          <info>Interface to OML collection server</info>
          <service name="start">
            <info>
              Start a collection server. The config information is expected
              to be in the body.
            </info>
          </service>
          <service name="stop">
            <info>Stop a specific collection service</info>
            <args><arg name="id" value="idReturnedByStart"/></args>
          </service>
          <service name="log">
            <info>Return the log file of the named service</info>
            <args><arg name="id" value="idReturnedByStart"/></args>
          </service>
          <service name="status">
            <info>Returning the status of the service</info>
          </service>
        </serviceGroup>