Revision fcdb582d

b/.gitignore
73 73
/man/*.[0-9]
74 74
/man/*.html
75 75
/man/*.in
76
/man/*.gen
76 77
/man/footer.man
77 78

  
78 79
# tools
b/Makefile.am
450 450

  
451 451
manrst = $(patsubst %.7,%.rst,$(patsubst %.8,%.rst,$(man_MANS)))
452 452
manhtml = $(patsubst %.rst,%.html,$(manrst))
453
mangen = $(patsubst %.rst,%.gen,$(manrst))
453 454
maninput = \
454 455
	$(patsubst %.7,%.7.in,$(patsubst %.8,%.8.in,$(man_MANS))) \
455 456
	$(patsubst %.html,%.html.in,$(manhtml)) \
456
	man/footer.man man/footer.html
457
	man/footer.man man/footer.html $(mangen)
457 458

  
458 459
TEST_FILES = \
459 460
	test/data/bdev-drbd-8.0.txt \
......
630 631
	  { echo 'pandoc' not found during configure; exit 1; }
631 632
	$(PANDOC) -f rst -t html -o $@ $<
632 633

  
633
man/%.7.in man/%.8.in: man/%.rst man/footer.man
634
man/%.gen: man/%.rst lib/query.py lib/build/sphinx_ext.py
635
	PYTHONPATH=. $(RUN_IN_TEMPDIR) $(CURDIR)/$(DOCPP) < $< > $@
636

  
637
man/%.7.in man/%.8.in: man/%.gen man/footer.man
634 638
	@test -n "$(PANDOC)" || \
635 639
	  { echo 'pandoc' not found during configure; exit 1; }
636 640
	set -o pipefail ; \
......
638 642
	  sed -e 's/\\@/@/g' > $@
639 643
	if test -n "$(MAN_HAS_WARNINGS)"; then $(CHECK_MAN) $@; fi
640 644

  
641
man/%.html.in: man/%.rst man/footer.html
645
man/%.html.in: man/%.gen man/footer.html
642 646
	@test -n "$(PANDOC)" || \
643 647
	  { echo 'pandoc' not found during configure; exit 1; }
644 648
	set -o pipefail ; \
b/man/gnt-debug.rst
109 109
The ``-o`` option takes a comma-separated list of output fields.
110 110
The available fields and their meaning are:
111 111

  
112
name
113
    Lock name
114

  
115
mode
116
    Mode in which the lock is currently acquired (exclusive or shared)
117

  
118
owner
119
    Current lock owner(s)
120

  
121
pending
122
    Threads waiting for the lock
123

  
112
@QUERY_FIELDS_LOCK@
124 113

  
125 114
If the value of the option starts with the character ``+``, the new
126 115
fields will be added to the default list. This allows to quickly
b/man/gnt-group.rst
113 113

  
114 114
The available fields and their meaning are:
115 115

  
116
name
117
    the group name
118

  
119
uuid
120
    the group's UUID
121

  
122
node_cnt
123
    the number of nodes in the node group
124

  
125
node_list
126
    the list of nodes that belong to this group
127

  
128
pinst_cnt
129
    the number of primary instances in the group (i.e., the number of
130
    primary instances nodes in this group have)
131

  
132
pinst_list
133
    the list of primary instances in the group
134

  
135
alloc_policy
136
    the current allocation policy for the group
137

  
138
ctime
139
    the creation time of the group; note that this field contains spaces
140
    and as such it's harder to parse
141

  
142
    if this attribute is not present (e.g. when upgrading from older
143
    versions), then "N/A" will be shown instead
144

  
145
mtime
146
    the last modification time of the group; note that this field
147
    contains spaces and as such it's harder to parse
148

  
149
serial_no
150
    the so called 'serial number' of the group; this is a numeric field
151
    that is incremented each time the node is modified, and it can be
152
    used to detect modifications
116
@QUERY_FIELDS_GROUP@
153 117

  
154 118
If no group names are given, then all groups are included. Otherwise,
155 119
only the named groups will be listed.
b/man/gnt-instance.rst
648 648
The ``-o`` option takes a comma-separated list of output fields.
649 649
The available fields and their meaning are:
650 650

  
651

  
652
name
653
    the instance name
654

  
655
os
656
    the OS of the instance
657

  
658
pnode
659
    the primary node of the instance
660

  
661
snodes
662
    comma-separated list of secondary nodes for the instance; usually
663
    this will be just one node
664

  
665
admin\_state
666
    the desired state of the instance (either "yes" or "no" denoting
667
    the instance should run or not)
668

  
669
disk\_template
670
    the disk template of the instance
671

  
672
oper\_state
673
    the actual state of the instance; can be one of the values
674
    "running", "stopped", "(node down)"
675

  
676
status
677
    combined form of ``admin_state`` and ``oper_stat``; this can be one of:
678
    ``ERROR_nodedown`` if the node of the instance is down, ``ERROR_down`` if
679
    the instance should run but is down, ``ERROR_up`` if the instance should be
680
    stopped but is actually running, ``ERROR_wrongnode`` if the instance is
681
    running but not on the primary, ``ADMIN_down`` if the instance has been
682
    stopped (and is stopped) and ``running`` if the instance is set to be
683
    running (and is running)
684

  
685
oper\_ram
686
    the actual memory usage of the instance as seen by the hypervisor
687

  
688
oper\_vcpus
689
    the actual number of VCPUs the instance is using as seen by the
690
    hypervisor
691

  
692
ip
693
    the ip address Ganeti recognizes as associated with the first
694
    instance interface
695

  
696
mac
697
    the first instance interface MAC address
698

  
699
nic\_mode
700
    the mode of the first instance NIC (routed or bridged)
701

  
702
nic\_link
703
    the link of the first instance NIC
704

  
705
sda\_size
706
    the size of the instance's first disk
707

  
708
sdb\_size
709
    the size of the instance's second disk, if any
710

  
711
vcpus
712
    the number of VCPUs allocated to the instance
713

  
714
tags
715
    comma-separated list of the instances's tags
716

  
717
serial\_no
718
    the so called 'serial number' of the instance; this is a numeric
719
    field that is incremented each time the instance is modified, and
720
    it can be used to track modifications
721

  
722
ctime
723
    the creation time of the instance; note that this field contains
724
    spaces and as such it's harder to parse
725

  
726
    if this attribute is not present (e.g. when upgrading from older
727
    versions), then "N/A" will be shown instead
728

  
729
mtime
730
    the last modification time of the instance; note that this field
731
    contains spaces and as such it's harder to parse
732

  
733
    if this attribute is not present (e.g. when upgrading from older
734
    versions), then "N/A" will be shown instead
735

  
736
uuid
737
    Show the UUID of the instance (generated automatically by Ganeti)
738

  
739
network\_port
740
    If the instance has a network port assigned to it (e.g. for VNC
741
    connections), this will be shown, otherwise - will be displayed.
742

  
743
beparams
744
    A text format of the entire beparams for the instance. It's more
745
    useful to select individual fields from this dictionary, see
746
    below.
747

  
748
disk.count
749
    The number of instance disks.
750

  
751
disk.size/N
752
    The size of the instance's Nth disk. This is a more generic form of
753
    the sda\_size and sdb\_size fields.
754

  
755
disk.sizes
756
    A comma-separated list of the disk sizes for this instance.
757

  
758
disk\_usage
759
    The total disk space used by this instance on each of its nodes.
760
    This is not the instance-visible disk size, but the actual disk
761
    "cost" of the instance.
762

  
763
nic.mac/N
764
    The MAC of the Nth instance NIC.
765

  
766
nic.ip/N
767
    The IP address of the Nth instance NIC.
768

  
769
nic.mode/N
770
    The mode of the Nth instance NIC
771

  
772
nic.link/N
773
    The link of the Nth instance NIC
774

  
775
nic.macs
776
    A comma-separated list of all the MACs of the instance's NICs.
777

  
778
nic.ips
779
    A comma-separated list of all the IP addresses of the instance's
780
    NICs.
781

  
782
nic.modes
783
    A comma-separated list of all the modes of the instance's NICs.
784

  
785
nic.links
786
    A comma-separated list of all the link parameters of the instance's
787
    NICs.
788

  
789
nic.count
790
    The number of instance nics.
791

  
792
hv/*NAME*
793
    The value of the hypervisor parameter called *NAME*. For details of
794
    what hypervisor parameters exist and their meaning, see the **add**
795
    command.
796

  
797
be/memory
798
    The configured memory for the instance.
799

  
800
be/vcpus
801
    The configured number of VCPUs for the instance.
802

  
803
be/auto\_balance
804
    Whether the instance is considered in N+1 checks.
805

  
651
@QUERY_FIELDS_INSTANCE@
806 652

  
807 653
If the value of the option starts with the character ``+``, the new
808 654
field(s) will be added to the default list. This allows to quickly
b/man/gnt-node.rst
175 175
The ``-o`` option takes a comma-separated list of output fields.
176 176
The available fields and their meaning are:
177 177

  
178

  
179
name
180
    the node name
181

  
182
pinst_cnt
183
    the number of instances having this node as primary
184

  
185
pinst_list
186
    the list of instances having this node as primary, comma separated
187

  
188
sinst_cnt
189
    the number of instances having this node as a secondary node
190

  
191
sinst_list
192
    the list of instances having this node as a secondary node, comma
193
    separated
194

  
195
pip
196
    the primary ip of this node (used for cluster communication)
197

  
198
sip
199
    the secondary ip of this node (used for data replication in dual-ip
200
    clusters, see gnt-cluster(8)
201

  
202
dtotal
203
    total disk space in the volume group used for instance disk
204
    allocations
205

  
206
dfree
207
    available disk space in the volume group
208

  
209
mtotal
210
    total memory on the physical node
211

  
212
mnode
213
    the memory used by the node itself
214

  
215
mfree
216
    memory available for instance allocations
217

  
218
bootid
219
    the node bootid value; this is a linux specific feature that
220
    assigns a new UUID to the node at each boot and can be use to
221
    detect node reboots (by tracking changes in this value)
222

  
223
tags
224
    comma-separated list of the node's tags
225

  
226
serial_no
227
    the so called 'serial number' of the node; this is a numeric field
228
    that is incremented each time the node is modified, and it can be
229
    used to detect modifications
230

  
231
ctime
232
    the creation time of the node; note that this field contains spaces
233
    and as such it's harder to parse
234

  
235
    if this attribute is not present (e.g. when upgrading from older
236
    versions), then "N/A" will be shown instead
237

  
238
mtime
239
    the last modification time of the node; note that this field
240
    contains spaces and as such it's harder to parse
241

  
242
    if this attribute is not present (e.g. when upgrading from older
243
    versions), then "N/A" will be shown instead
244

  
245
uuid
246
    Show the UUID of the node (generated automatically by Ganeti)
247

  
248
ctotal
249
    the toal number of logical processors
250

  
251
cnodes
252
    the number of NUMA domains on the node, if the hypervisor can
253
    export this information
254

  
255
csockets
256
    the number of physical CPU sockets, if the hypervisor can export
257
    this information
258

  
259
master_candidate
260
    whether the node is a master candidate or not
261

  
262
drained
263
    whether the node is drained or not; the cluster still communicates
264
    with drained nodes but excludes them from allocation operations
265

  
266
offline
267
    whether the node is offline or not; if offline, the cluster does
268
    not communicate with offline nodes; useful for nodes that are not
269
    reachable in order to avoid delays
270

  
271
role
272
    A condensed version of the node flags; this field will output a
273
    one-character field, with the following possible values:
274

  
275
    - *M* for the master node
276

  
277
    - *C* for a master candidate
278

  
279
    - *R* for a regular node
280

  
281
    - *D* for a drained node
282

  
283
    - *O* for an offline node
284

  
285
master_capable
286
    whether the node can become a master candidate
287

  
288
vm_capable
289
    whether the node can host instances
290

  
291
group
292
    the name of the node's group, if known (the query is done without
293
    locking, so data consistency is not guaranteed)
294

  
295
group.uuid
296
    the UUID of the node's group
297

  
178
@QUERY_FIELDS_NODE@
298 179

  
299 180
If the value of the option starts with the character ``+``, the new
300 181
fields will be added to the default list. This allows to quickly

Also available in: Unified diff