Moab Web Services Overview

Welcome to the Moab Web Services Administrator Guide 10.1.0.1

March 2025

Moab Web Services (MWS) is a component of Moab HPC Suite that enables programmatic interaction with Moab Workload Manager via a RESTful interface. MWS lets you create and interact with Moab HPC Suite objects and properties such as jobs, nodes, virtual machines, and reservations. MWS is the preferred method for those wanting to create custom user interfaces for Moab HPC Suite.

MWS communicates with the Moab Workload Manager (Moab HPC Suite) server using the same wire protocol as the Moab HPC Suite command-line interface. By publishing a standard interface into Moab HPC Suite's intelligence, MWS significantly reduces the amount of work required to integrate Moab HPC Suite into your solution.

If you are a Moab HPC Suite administrator, for conceptual information about Moab HPC Suite, see the Moab Workload Manager Administrator Guide.

This guide assumes Moab Web Services (MWS) has already been installed. See the Moab HPC Suite Installation and Configuration Guide for installation instructions, including troubleshooting the installation.

The following sections will help you quickly get started using MWS:

  • Chapter 1: Moab Web Services Setup: Contains instructions in order to get MWS configured and secured correctly.
  • Chapter 2: Access Control: Contains information describing how to manage access control in MWS.
  • Chapter 3: About the API: Describes how to use RESTful web services, explains the JSON data format used for all communications with MWS, describes global URL parameters used in MWS calls, and contains other helpful information for using the Moab Web Services API.
  • Chapter 4: Resources: Contains MWS resources and the HTTP methods defined on them.
  • Chapter 5: Reporting Framework: Provides an overview of the framework and the concepts related to it and works through an example report (CPU Utilization) with details regarding which web services to use and with what data.
  • Chapter 6: About Moab Web Services Plugins: Describes MWS plugins, their use, and their creation in Moab Web Services.

  • Chapter 7: Plugin Types: Describes these plugin types - Power Management.

  • Chapter 8: References: Contains client code samples and information about configuration settings; also provides field information for each MWS resource object.