.. _server_generate_config:

Server Generate
===============

What is the Server Generate?
----------------------------

The ``Server Generate`` cron job that generates a default server config json.
The job requires the type of scheduler and the path to the scheduler.

For a brand new d3VIEW server, both arguments
:option:`scheduler-type` and :option:`scheduler-bin-path` must be specified.
The server generation will create a json file which can be loaded into the
d3VIEW hpc administration screen to create a new HPC Server.

How to run
----------

The ``Server Import`` cron job should be manually invoked by using ``Lucy``.
The most basic command is::

  $ lucy server generate PBS /opt/torque/bin

:program:`lucy` :program:`server` :program:`generate`
:option:`scheduler-type`
:option:`scheduler-bin-path`

Arguments
---------

+--------------------------------+-----------------------------+
| Parameter name                 | When required               |
+================================+=============================+
+--------------------------------+-----------------------------+
|:option:`scheduler-type`        | **Always required**         |
+--------------------------------+-----------------------------+
|:option:`scheduler-bin-path`    | **Always required**         |
+--------------------------------+-----------------------------+
|:option:`-log-file`             |                             |
+--------------------------------+-----------------------------+

.. option:: scheduler-type

   This is the type of scheduler that is used when importing directly from
   a scheduler. Supported types include: [ ``pbs``, ``pbspro``, ``pbs+maui`` ]

.. option:: scheduler-bin-path

   This is the path to the scheduler binaries that is used when importing
   directly from a scheduler.