Revision 0897dc97 doc/rapi.rst

b/doc/rapi.rst
332 332
  Instance reinstall supports body parameters.
333 333

  
334 334

  
335
``/2/groups``
336
+++++++++++++
337

  
338
The groups resource.
339

  
340
It supports the following commands: ``GET``.
341

  
342
``GET``
343
~~~~~~~
344

  
345
Returns a list of all existing node groups.
346

  
347
Example::
348

  
349
    [
350
      {
351
        "name": "group1",
352
        "uri": "\/2\/groups\/group1"
353
      },
354
      {
355
        "name": "group2",
356
        "uri": "\/2\/groups\/group2"
357
      }
358
    ]
359

  
360
If the optional bool *bulk* argument is provided and set to a true value
361
(i.e ``?bulk=1``), the output contains detailed information about node
362
groups as a list.
363

  
364
Example::
365

  
366
    [
367
      {
368
        "name": "group1",
369
        "node_cnt": 2,
370
        "node_list": [
371
          "node1.example.com",
372
          "node2.example.com"
373
        ],
374
        "uuid": "0d7d407c-262e-49af-881a-6a430034bf43"
375
      },
376
      {
377
        "name": "group2",
378
        "node_cnt": 1,
379
        "node_list": [
380
          "node3.example.com"
381
        ],
382
        "uuid": "f5a277e7-68f9-44d3-a378-4b25ecb5df5c"
383
      }
384
    ]
385

  
386
``/2/groups/[group_name]``
387
+++++++++++++++++++++++++++++++++
388

  
389
Returns information about a node group.
390

  
391
It supports the following commands: ``GET``.
392

  
393

  
335 394
``/2/instances``
336 395
++++++++++++++++
337 396

  

Also available in: Unified diff