Revision 0fb66bb1

b/doc/rapi.rst
220 220
    The numbers of nics used
221 221
  :pyeval:`constants.ISPEC_SPINDLE_USE`
222 222
    The numbers of virtual disk spindles used by this instance. They are
223
    not real, but useful for account the spindle usage on the residing
224
    node.
223
    not real in the sense of actual HDD spindles, but useful for
224
    accounting the spindle usage on the residing node
225 225
:pyeval:`constants.IPOLICY_DTS`
226 226
  A `list` of disk templates allowed for instances using this policy
227 227
:pyeval:`constants.IPOLICY_VCPU_RATIO`
......
388 388
                             rlib2._NODE_EVAC_RES1])
389 389

  
390 390
:pyeval:`rlib2._INST_CREATE_REQV1`
391
  Instance creation request data version 1 supported.
391
  Instance creation request data version 1 supported
392 392
:pyeval:`rlib2._INST_REINSTALL_REQV1`
393
  Instance reinstall supports body parameters.
393
  Instance reinstall supports body parameters
394 394
:pyeval:`rlib2._NODE_MIGRATE_REQV1`
395 395
  Whether migrating a node (``/2/nodes/[node_name]/migrate``) supports
396
  request body parameters.
396
  request body parameters
397 397
:pyeval:`rlib2._NODE_EVAC_RES1`
398 398
  Whether evacuating a node (``/2/nodes/[node_name]/evacuate``) returns
399 399
  a new-style result (see resource description)
......
449 449
(i.e ``?bulk=1``), the output contains detailed information about node
450 450
groups as a list.
451 451

  
452
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`
452
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
453 453

  
454 454
Example::
455 455

  
......
508 508
Returns information about a node group, similar to the bulk output from
509 509
the node group list.
510 510

  
511
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`
511
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
512 512

  
513 513
``DELETE``
514 514
~~~~~~~~~~
......
657 657
(i.e ``?bulk=1``), the output contains detailed information about
658 658
instances as a list.
659 659

  
660
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`
660
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
661 661

  
662 662
Example::
663 663

  
......
732 732
Returns information about an instance, similar to the bulk output from
733 733
the instance list.
734 734

  
735
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`
735
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
736 736

  
737 737
``DELETE``
738 738
~~~~~~~~~~
......
1120 1120
     ])
1121 1121

  
1122 1122
``instance``
1123
  Instance name.
1123
  Instance name
1124 1124
``kind``
1125 1125
  Console type, one of :pyeval:`constants.CONS_SSH`,
1126 1126
  :pyeval:`constants.CONS_VNC`, :pyeval:`constants.CONS_SPICE`
1127
  or :pyeval:`constants.CONS_MESSAGE`.
1127
  or :pyeval:`constants.CONS_MESSAGE`
1128 1128
``message``
1129
  Message to display (:pyeval:`constants.CONS_MESSAGE` type only).
1129
  Message to display (:pyeval:`constants.CONS_MESSAGE` type only)
1130 1130
``host``
1131 1131
  Host to connect to (:pyeval:`constants.CONS_SSH`,
1132
  :pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only).
1132
  :pyeval:`constants.CONS_VNC` or :pyeval:`constants.CONS_SPICE` only)
1133 1133
``port``
1134 1134
  TCP port to connect to (:pyeval:`constants.CONS_VNC` or
1135
  :pyeval:`constants.CONS_SPICE` only).
1135
  :pyeval:`constants.CONS_SPICE` only)
1136 1136
``user``
1137
  Username to use (:pyeval:`constants.CONS_SSH` only).
1137
  Username to use (:pyeval:`constants.CONS_SSH` only)
1138 1138
``command``
1139 1139
  Command to execute on machine (:pyeval:`constants.CONS_SSH` only)
1140 1140
``display``
1141
  VNC display number (:pyeval:`constants.CONS_VNC` only).
1141
  VNC display number (:pyeval:`constants.CONS_VNC` only)
1142 1142

  
1143 1143

  
1144 1144
``/2/instances/[instance_name]/tags``
......
1201 1201

  
1202 1202
Returned fields for bulk requests (unlike other bulk requests, these
1203 1203
fields are not the same as for per-job requests):
1204
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`
1204
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`.
1205 1205

  
1206 1206
``/2/jobs/[job_id]``
1207 1207
++++++++++++++++++++
......
1309 1309
dict:
1310 1310

  
1311 1311
``fields``
1312
  The job fields on which to watch for changes.
1312
  The job fields on which to watch for changes
1313 1313

  
1314 1314
``previous_job_info``
1315
  Previously received field values or None if not yet available.
1315
  Previously received field values or None if not yet available
1316 1316

  
1317 1317
``previous_log_serial``
1318 1318
  Highest log serial number received so far or None if not yet
1319
  available.
1319
  available
1320 1320

  
1321 1321
Returns None if no changes have been detected and a dict with two keys,
1322 1322
``job_info`` and ``log_entries`` otherwise.
......
1351 1351
(i.e ``?bulk=1``), the output contains detailed information about nodes
1352 1352
as a list.
1353 1353

  
1354
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`
1354
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`.
1355 1355

  
1356 1356
Example::
1357 1357

  
......
1378 1378

  
1379 1379
It supports the following commands: ``GET``.
1380 1380

  
1381
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`
1381
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`.
1382 1382

  
1383 1383
``/2/nodes/[node_name]/powercycle``
1384 1384
+++++++++++++++++++++++++++++++++++
b/lib/opcodes.py
869 869
    ("reserved_lvs", None, ht.TMaybeListOf(ht.TNonEmptyString),
870 870
     "List of reserved LVs"),
871 871
    ("hidden_os", None, _TestClusterOsList,
872
     "Modify list of hidden operating systems. Each modification must have"
873
     " two items, the operation and the OS name. The operation can be"
874
     " ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)),
872
     "Modify list of hidden operating systems: each modification must have"
873
     " two items, the operation and the OS name; the operation can be"
874
     " ``%s`` or ``%s``" % (constants.DDM_ADD, constants.DDM_REMOVE)),
875 875
    ("blacklisted_os", None, _TestClusterOsList,
876
     "Modify list of blacklisted operating systems. Each modification must have"
877
     " two items, the operation and the OS name. The operation can be"
878
     " ``%s`` or ``%s``." % (constants.DDM_ADD, constants.DDM_REMOVE)),
876
     "Modify list of blacklisted operating systems: each modification must"
877
     " have two items, the operation and the OS name; the operation can be"
878
     " ``%s`` or ``%s``" % (constants.DDM_ADD, constants.DDM_REMOVE)),
879 879
    ("use_external_mip_script", None, ht.TMaybeBool,
880 880
     "Whether to use an external master IP address setup script"),
881 881
    ]
......
1500 1500
    _PForceVariant,
1501 1501
    _PIgnoreIpolicy,
1502 1502
    ("nics", ht.EmptyList, TestNicModifications,
1503
     "List of NIC changes. Each item is of the form ``(op, index, settings)``."
1504
     " ``op`` is one of ``%s``, ``%s`` or ``%s``. ``index`` can be either -1 to"
1505
     " refer to the last position, or a zero-based index number. A deprecated"
1506
     " version of this parameter used the form ``(op, settings)``, where "
1507
     " ``op`` can be ``%s`` to add a new NIC with the specified settings,"
1508
     " ``%s`` to remove the last NIC or a number to modify the settings"
1509
     " of the NIC with that index." %
1503
     "List of NIC changes: each item is of the form ``(op, index, settings)``,"
1504
     " ``op`` is one of ``%s``, ``%s`` or ``%s``, ``index`` can be either -1"
1505
     " to refer to the last position, or a zero-based index number; a"
1506
     " deprecated version of this parameter used the form ``(op, settings)``,"
1507
     " where ``op`` can be ``%s`` to add a new NIC with the specified"
1508
     " settings, ``%s`` to remove the last NIC or a number to modify the"
1509
     " settings of the NIC with that index" %
1510 1510
     (constants.DDM_ADD, constants.DDM_MODIFY, constants.DDM_REMOVE,
1511 1511
      constants.DDM_ADD, constants.DDM_REMOVE)),
1512 1512
    ("disks", ht.EmptyList, TestDiskModifications,
1513
     "List of disk changes. See ``nics``."),
1513
     "List of disk changes; see ``nics``"),
1514 1514
    ("beparams", ht.EmptyDict, ht.TDict, "Per-instance backend parameters"),
1515 1515
    ("runtime_mem", None, ht.TMaybeStrictPositiveInt, "New runtime memory"),
1516 1516
    ("hvparams", ht.EmptyDict, ht.TDict,
......
1520 1520
    ("remote_node", None, ht.TMaybeString,
1521 1521
     "Secondary node (used when changing disk template)"),
1522 1522
    ("os_name", None, ht.TMaybeString,
1523
     "Change instance's OS name. Does not reinstall the instance."),
1523
     "Change the instance's OS without reinstalling the instance"),
1524 1524
    ("osparams", None, ht.TMaybeDict, "Per-instance OS parameters"),
1525 1525
    ("wait_for_sync", True, ht.TBool,
1526 1526
     "Whether to wait for the disk to synchronize, when changing template"),

Also available in: Unified diff