Synnefo » snf-ganeti » ganeti-local

PUT or POST?

------------

According to RFC2616 the main difference between PUT and POST is that

POST can create new resources but PUT can only create the resource the

URI was pointing to on the PUT request.

Unfortunately, due to historic reasons, the Ganeti RAPI library is not

consistent with this usage, so just use the methods as documented below

for each resource.

For more details have a look in the source code at

``lib/rapi/rlib2.py``.

Generic parameter types

-----------------------

A few generic refered parameter types and the values they allow.

``bool``

++++++++

A boolean option will accept ``1`` or ``0`` as numbers but not

i.e. ``True`` or ``False``.

The boolean *dry-run* argument, if provided and set, signals to Ganeti

that the job should not be executed, only the pre-execution checks will

be done.

If the optional bool *bulk* argument is provided and set to a true value

(i.e ``?bulk=1``), the output contains detailed information about

instances as a list.

If the optional bool *dry-run* argument is provided, the job will not be

actually executed, only the pre-execution checks will be done. Query-ing

the job result will return, in both dry-run and normal case, the list of

nodes selected for the instance.

The URI takes optional ``type=soft|hard|full`` and

``ignore_secondaries=0|1`` parameters.

``type`` defines the reboot type. ``soft`` is just a normal reboot,

without terminating the hypervisor. ``hard`` means full shutdown

(including terminating the hypervisor process) and startup again.

``full`` is like ``hard`` but also recreates the configuration from

ground up as if you would have done a ``gnt-instance shutdown`` and

``gnt-instance start`` on it.

``ignore_secondaries`` is a bool argument indicating if we start the

instance even if secondary disks are failing.

The URI takes an optional ``force=1|0`` parameter to start the

instance even if secondary disks are failing.

Either ``remote_node`` or ``iallocator`` needs to be defined when using

``mode=replace_new_secondary``.

``mode`` is a mandatory parameter. ``replace_auto`` tries to determine

the broken disk(s) on its own and replacing it.

Takes the bool parameter ``ignore_size``. When set ignore the recorded

parameters must be passed::

No parameters are required, but the bool parameter ``live`` can be set

to use live migration (if available).

It supports the bool ``force`` argument.