=============================
JobManager (hwx.inspire.core)
=============================

--------------
Public Methods
--------------

  +--------------------------------------------------------------------+
  | addServer_ (self, serverId, host, port=22, **kwds)                 |
  +--------------------------------------------------------------------+
  | removeServer_ (self, serverId)                                     |
  +--------------------------------------------------------------------+
  | useServer_ (self, serverId, username, password, parallelRun=False) |
  +--------------------------------------------------------------------+

--------------
Method Details
--------------

.. _addServer:
.. method:: addServer(self, serverId, host, port=22, **kwds)

Registers a remote server.

:param serverId: The unique identifier for the server.
:type serverId: str
:param host: The name or IP address of the remote host.
:type host: str
:param port: The port number on the remote host that accepts this service.
:type port: int


.. _removeServer:
.. method:: removeServer(self, serverId)

Ensures that a server configured with the given identifier is not registered.

:param serverId: The unique identifier for the server.
:type serverId: str


.. _useServer:
.. method:: useServer(self, serverId, username, password, parallelRun=False)

A context manager to use for running an analysis on specified server.

:param serverId: The unique identifier for the server.
:type serverId: str
:param username: The authentication name on the remote host.
:type username: str
:param password: The authentication word on the remote host.
:type password: str
:param parallelRun: If True, Analysis will run in parallel.
:type parallelRun: bool