SEE ALSO
--------
-Ganeti overview and specifications: **ganeti**(7) (general overview),
-**ganeti-os-interface**(7) (guest OS definitions),
-**ganeti-extstorage-interface**(7) (external storage providers).
-
-Ganeti commands: **gnt-cluster**(8) (cluster-wide commands),
-**gnt-job**(8) (job-related commands), **gnt-node**(8) (node-related
-commands), **gnt-instance**(8) (instance commands), **gnt-os**(8) (guest
-OS commands), **gnt-storage**(8) (storage commands), **gnt-group**(8)
-(node group commands), **gnt-backup**(8) (instance import/export
-commands), **gnt-debug**(8) (debug commands).
-
-Ganeti daemons: **ganeti-watcher**(8) (automatic instance restarter),
-**ganeti-cleaner**(8) (job queue cleaner), **ganeti-noded**(8) (node
-daemon), **ganeti-masterd**(8) (master daemon), **ganeti-rapi**(8)
+Ganeti overview and specifications: **ganeti**\(7) (general overview),
+**ganeti-os-interface**\(7) (guest OS definitions),
+**ganeti-extstorage-interface**\(7) (external storage providers).
+
+Ganeti commands: **gnt-cluster**\(8) (cluster-wide commands),
+**gnt-job**\(8) (job-related commands), **gnt-node**\(8) (node-related
+commands), **gnt-instance**\(8) (instance commands), **gnt-os**\(8) (guest
+OS commands), **gnt-storage**\(8) (storage commands), **gnt-group**\(8)
+(node group commands), **gnt-backup**\(8) (instance import/export
+commands), **gnt-debug**\(8) (debug commands).
+
+Ganeti daemons: **ganeti-watcher**\(8) (automatic instance restarter),
+**ganeti-cleaner**\(8) (job queue cleaner), **ganeti-noded**\(8) (node
+daemon), **ganeti-masterd**\(8) (master daemon), **ganeti-rapi**\(8)
(remote API daemon).
-Ganeti htools: **htools**(1) (generic binary), **hbal**(1) (cluster
-balancer), **hspace**(1) (capacity calculation), **hail**(1) (IAllocator
-plugin), **hscan**(1) (data gatherer from remote clusters), **hinfo**(1)
-(cluster information printer), **mon-collector**(7) (data collectors
+Ganeti htools: **htools**\(1) (generic binary), **hbal**\(1) (cluster
+balancer), **hspace**\(1) (capacity calculation), **hail**\(1) (IAllocator
+plugin), **hscan**\(1) (data gatherer from remote clusters), **hinfo**\(1)
+(cluster information printer), **mon-collector**\(7) (data collectors
interface).
COPYRIGHT
SEE ALSO
--------
-**dsh**(1), **cssh**(1)
+**dsh**\(1), **cssh**\(1)
.. vim: set textwidth=72 :
.. Local Variables:
By default, in order to be able to support features such as node
powercycling even on systems with a very damaged root disk,
-**ganeti-noded** locks itself in RAM using **mlockall**(2). You can
+**ganeti-noded** locks itself in RAM using **mlockall**\(2). You can
disable this feature by passing in the ``--no-mlock`` to the daemon.
For testing purposes, you can give the ``-f`` option and the
In Ganeti 2.0, the architecture of the cluster is a little more
complicated than in 1.2. The cluster is coordinated by a master daemon
-(**ganeti-masterd**(8)), running on the master node. Each node runs
+(**ganeti-masterd**\(8)), running on the master node. Each node runs
(as before) a node daemon, and the master has the RAPI daemon running
too.
*!~*
Logically negated from *=~*
*=\**
- Globbing, see **glob**(7), though only * and ? are supported
+ Globbing, see **glob**\(7), though only * and ? are supported
*!\**
Logically negated from *=\**
*in*, *not in*
---------------------------
All Ganeti daemons re-open the log file(s) when sent a SIGHUP signal.
-**logrotate**(8) can be used to rotate Ganeti's log files.
+**logrotate**\(8) can be used to rotate Ganeti's log files.
.. vim: set textwidth=72 :
.. Local Variables:
that for any non-zero exit code, the backup is considered invalid,
and retried.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
in bridged and openvswitch mode specifies the interface to attach
this NIC to, in routed mode it's intended to differentiate between
different routing tables/instance groups (but the meaning is
- dependent on the network script in use, see **gnt-cluster**(8) for
+ dependent on the network script in use, see **gnt-cluster**\(8) for
more details)
Of these ``mode`` and ``link`` are nic parameters, and inherit their
affect the hypervisor, backend and NIC parameters, both read from
the export file and passed in via the command line.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example for identical instance import::
**command** [-n *node*] [-g *group*] [-M] {*command*}
Executes a command on all nodes. This command is designed for simple
-usage. For more complex use cases the commands **dsh(1)** or **cssh(1)**
+usage. For more complex use cases the commands **dsh**\(1) or **cssh**\(1)
should be used instead.
If the option ``-n`` is not given, the command will be executed on all
hypervisor specific parameters for the cluster. The format of this
option is the name of the hypervisor, followed by a colon and a
comma-separated list of key=value pairs. The keys available for each
-hypervisors are detailed in the gnt-instance(8) man page, in the
+hypervisors are detailed in the **gnt-instance**\(8) man page, in the
**add** command plus the following parameters which are only
configurable globally (at cluster level):
list of key-value pairs. These parameters can only be specified at
cluster and node group level; the cluster-level parameter are inherited
by the node group at the moment of its creation, and can be further
-modified at node group level using the **gnt-group**(8) command.
+modified at node group level using the **gnt-group**\(8) command.
The following is the list of disk parameters available for the **drbd**
template, with measurement units specified in square brackets at the end
will be blank, which means that relevant operations will require the
administrator to manually specify either an instance allocator, or a
set of nodes. If the option is not specified but htools was enabled,
-the default iallocator will be **hail**(1) (assuming it can be found
+the default iallocator will be **hail**\(1) (assuming it can be found
on disk). The default iallocator can be changed later using the
**modify** command.
and the cluster name.
The ``--node-parameters`` option allows you to set default node
-parameters for the cluster. Please see **ganeti**(7) for more
+parameters for the cluster. Please see **ganeti**\(7) for more
information about supported key=value pairs.
The ``-C (--candidate-pool-size)`` option specifies the
``candidate_pool_size`` cluster parameter. This is the number of nodes
that the master will try to keep as master\_candidates. For more
-details about this role and other node roles, see the ganeti(7).
+details about this role and other node roles, see the **ganeti**\(7).
The ``--specs-...`` and ``--ipolicy-disk-templates`` options specify
instance policy on the cluster. For the ``--specs-...`` options, each
- ``--ipolicy-disk-templates`` limits the allowed disk templates
For details about how to use ``--hypervisor-state`` and ``--disk-state``
-have a look at **ganeti**(7).
+have a look at **ganeti**\(7).
MASTER-FAILOVER
~~~~~~~~~~~~~~~
command.
The ``--hypervisor-state`` and ``--disk-state`` options are described in
-detail in **ganeti(7)**.
+detail in **ganeti**\(7).
The ``--add-uids`` and ``--remove-uids`` options can be used to
modify the user-id pool by adding/removing a list of user-ids or
The ``--specs-...`` and ``--ipolicy-disk-templates`` options are
described in the **init** command.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
QUEUE
needed, but can be run if the **verify** complains about
configuration mismatches.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
RENAME
them again once the new certificates and keys are replicated. The
options ``--new-cluster-certificate`` and ``--new-confd-hmac-key``
can be used to regenerate the cluster-internal SSL certificate
-respective the HMAC key used by ganeti-confd(8).
+respective the HMAC key used by **ganeti-confd**\(8).
To generate a new self-signed RAPI certificate (used by
-ganeti-rapi(8)) specify ``--new-rapi-certificate``. If you want to
+**ganeti-rapi**\(8)) specify ``--new-rapi-certificate``. If you want to
use your own certificate, e.g. one signed by a certificate
authority (CA), pass its filename to ``--rapi-certificate``.
scripting.
The ``-v`` option activates verbose mode, which changes the display of
-special field states (see **ganeti(7)**).
+special field states (see **ganeti**\(7)).
The ``-o`` option takes a comma-separated list of output fields.
The available fields and their meaning are:
initially empty; to add nodes to it, use ``gnt-group assign-nodes``.
The ``--node-parameters`` option allows you to set default node
-parameters for nodes in the group. Please see **ganeti**(7) for more
+parameters for nodes in the group. Please see **ganeti**\(7) for more
information about supported key=value pairs and their corresponding
options.
The ``-D (--disk-parameters)`` option allows you to set the disk
parameters for the node group; please see the section about
-**gnt-cluster add** in **gnt-cluster**(8) for more information about
+**gnt-cluster add** in **gnt-cluster**\(8) for more information about
disk parameters
The ``--specs-...`` and ``--ipol-disk-templates`` options specify
instance policies on the node group, and are documented in the
-**gnt-cluster**(8) man page.
+**gnt-cluster**\(8) man page.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
ASSIGN-NODES
has the primary and secondary nodes in different node groups). You can
force the operation with ``--force``.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
MODIFY
The ``--node-parameters`` and ``--alloc-policy`` options are documented
in the **add** command above. ``--hypervisor-state`` as well as
-``--disk-state`` are documented in detail in **ganeti**(7).
+``--disk-state`` are documented in detail in **ganeti**\(7).
The ``--node-parameters``, ``--alloc-policy``, ``-D
(--disk-parameters)`` options are documented in the **add** command
The ``--specs-...`` and ``--ipol-disk-templates`` options specify
instance policies on the node group, and are documented in the
-**gnt-cluster**(8) man page.
+**gnt-cluster**\(8) man page.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
REMOVE
Deletes the indicated node group, which must be empty. There must always be at
least one group, so the last group cannot be removed.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
LIST
scripting.
The ``-v`` option activates verbose mode, which changes the display of
-special field states (see **ganeti(7)**).
+special field states (see **ganeti**\(7)).
The ``-o`` option takes a comma-separated list of output fields.
If the value of the option starts with the character ``+``, the new
@QUERY_FIELDS_GROUP@
If exactly one argument is given and it appears to be a query filter
-(see **ganeti(7)**), the query result is filtered accordingly. For
+(see **ganeti**\(7)), the query result is filtered accordingly. For
ambiguous cases (e.g. a single field name as a filter) the ``--filter``
(``-F``) option forces the argument to be treated as a filter.
Renames a given group from *oldname* to *newname*.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
If no specific destination groups are specified using ``--to``, all
groups except the evacuated group are considered.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
in bridged or openvswitch mode specifies the interface to attach
this NIC to, in routed mode it's intended to differentiate between
different routing tables/instance groups (but the meaning is
- dependent on the network script, see gnt-cluster(8) for more
+ dependent on the network script, see **gnt-cluster**\(8) for more
details). Note that openvswitch support is also hypervisor
dependent.
Valid for the KVM hypervisor.
Specifies a list of comma-separated ciphers that SPICE should use
- for TLS connections. For the format, see man cipher(1).
+ for TLS connections. For the format, see man **cipher**\(1).
spice\_use\_vdagent
Valid for the KVM hypervisor.
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
The ``--force`` option is used to skip the interactive confirmation.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
a given output unit.
The ``-v`` option activates verbose mode, which changes the display of
-special field states (see **ganeti(7)**).
+special field states (see **ganeti**\(7)).
The ``-o (--output)`` option takes a comma-separated list of output
fields. The available fields and their meaning are:
output fields.
If exactly one argument is given and it appears to be a query filter
-(see **ganeti(7)**), the query result is filtered accordingly. For
+(see **ganeti**\(7)), the query result is filtered accordingly. For
ambiguous cases (e.g. a single field name as a filter) the ``--filter``
(``-F``) option forces the argument to be treated as a filter (e.g.
``gnt-instance list -F admin_state``).
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Most of the changes take effect at the next restart. If the instance is
or ``--all`` options), the user must pass the ``--force-multiple``
options to skip the interactive confirmation.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
RENAME
is used to compute the IP address, if you pass this option you must also
pass the ``--no-ip-check`` option.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Starting/stopping/connecting to console
console`` to unpause it, allowing the entire boot process to be
monitored for debugging.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
``--no-remember``, and when the watcher is activated again it will
restore the correct runtime state for all instances.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
The ``--force-multiple`` will skip the interactive confirmation in the
case the more than one instance will be affected.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
violations if replace-disks changes groups and the instance would
violate the new groups instance policy.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
ACTIVATE-DISKS
Note that it is safe to run this command while the instance is already
running.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
DEACTIVATE-DISKS
the disks. This can still fail due to the instance actually running or
other issues.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
GROW-DISK
#. reboot the instance (later, at a convenient time)
-#. use a filesystem resizer, such as ext2online(8) or
- xfs\_growfs(8) to resize the filesystem, or use fdisk(8) to change
- the partition table on the disk
+#. use a filesystem resizer, such as **ext2online**\(8) or
+ **xfs\_growfs**\(8) to resize the filesystem, or use **fdisk**\(8) to
+ change the partition table on the disk
The *disk* argument is the index of the instance disk to grow. The
*amount* argument is given as a number which can have a suffix (like the
If you do not want gnt-instance to wait for the new disk region to be
synced, use the ``--no-wait-for-sync`` option.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example (increase the first disk for instance1 by 16GiB)::
The primary and secondary nodes will be chosen by the specified
iallocator plugin, or by the default allocator if ``.`` is specified.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Recovery/moving
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
If an instance has the backend parameter ``always_failover`` set to
true, then the migration is automatically converted into a failover.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example (and expected output)::
If ``--ignore-ipolicy`` is given any instance policy violations occuring
during this operation are ignored.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
If no specific destination groups are specified using ``--to``, all
groups except the one containing the instance are considered.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
Show finished jobs only.
If exactly one argument is given and it appears to be a query filter
-(see **ganeti(7)**), the query result is filtered accordingly. For
+(see **ganeti**\(7)), the query result is filtered accordingly. For
ambiguous cases (e.g. a single field name as a filter) the ``--filter``
(``-F``) option forces the argument to be treated as a filter.
``--gateway6`` options. IP pool is meaningless for IPV6 so those two
values can be used for EUI64 generation from a NIC's MAC address.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
MODIFY
want to do so. All other options are documented in the **add** command
above.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
REMOVE
Deletes the indicated network, which must be not connected to any node group.
-See **ganeti(7)** for a description of ``--submit`` and other common options.
+See **ganeti**\(7) for a description of ``--submit`` and other common options.
LIST
~~~~
between the output fields. Both these options are to help scripting.
The ``-v`` option activates verbose mode, which changes the display of
-special field states (see **ganeti(7)**).
+special field states (see **ganeti**\(7)).
The ``-o`` option takes a comma-separated list of output fields. If the
value of the option starts with the character ``+``, the new fields will
The ``-s (--secondary-ip)`` is used in dual-home clusters and
specifies the new node's IP in the secondary network. See the
-discussion in **gnt-cluster**(8) for more information.
+discussion in **gnt-cluster**\(8) for more information.
In case you're readding a node after hardware failure, you can use
the ``--readd`` parameter. In this case, you don't need to pass the
exists you can skip this option, otherwise it's mandatory.
The ``vm_capable``, ``master_capable``, ``ndparams``, ``diskstate`` and
-``hvstate`` options are described in **ganeti**(7), and are used to set
+``hvstate`` options are described in **ganeti**\(7), and are used to set
the properties of the new node.
The command performs some operations that change the state of the master
in the secondary node change mode (only valid for DRBD instances)
- when neither of the above is done a combination of the two cases is run
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
give inconsistent results for the free disk/memory.
The ``-v`` option activates verbose mode, which changes the display of
-special field states (see **ganeti(7)**).
+special field states (see **ganeti**\(7)).
The ``-o (--output)`` option takes a comma-separated list of output
fields. The available fields and their meaning are:
memory for the node and for the instances (Xen).
If exactly one argument is given and it appears to be a query filter
-(see **ganeti(7)**), the query result is filtered accordingly. For
+(see **ganeti**\(7)), the query result is filtered accordingly. For
ambiguous cases (e.g. a single field name as a filter) the ``--filter``
(``-F``) option forces the argument to be treated as a filter (e.g.
``gnt-node list -F master_candidate``).
This command can be used as a reverse lookup (from node and minor) to a
given instance, which can be useful when debugging DRBD issues.
-Note that this command queries Ganeti via :manpage:`ganeti-confd(8)`, so
+Note that this command queries Ganeti via **ganeti-confd**\(8), so
it won't be available if support for ``confd`` has not been enabled at
build time; furthermore, in Ganeti 2.6 this is only available via the
Haskell version of confd (again selected at build time).
If ``--ignore-ipolicy`` is given any instance policy violations
occurring during this operation are ignored.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example::
This command changes the role of the node. Each options takes
either a literal yes or no, and only one option should be given as
yes. The meaning of the roles and flags are described in the
-manpage **ganeti(7)**.
+manpage **ganeti**\(7).
The option ``--node-powered`` can be used to modify state-of-record if
it doesn't reflect the reality anymore.
``--force`` is needed as well, and the target node for the first change
must be the master.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
Example (setting the node back to online and master candidate)::
``--force`` option is needed if the target node is the master
node.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
POWER
preseeding the settings for operating systems not yet known to
**gnt-os**.
-See **ganeti(7)** for a description of ``--submit`` and other common
+See **ganeti**\(7) for a description of ``--submit`` and other common
options.
.. vim: set textwidth=72 :
-----------
hail is a Ganeti IAllocator plugin that implements the instance
-placement and movement using the same algorithm as **hbal**(1).
+placement and movement using the same algorithm as **hbal**\(1).
The program takes input via a JSON-file containing current cluster
state and the request details, and output (on stdout) a JSON-formatted
-p, \--print-nodes
Prints the before and after node status, in a format designed to allow
the user to understand the node's most important parameters. See the
- man page **htools**(1) for more details about this option.
+ man page **htools**\(1) for more details about this option.
-t *datafile*, \--text-data=*datafile*
The name of the file holding cluster information, to override the data
in the JSON request itself. This is mostly used for debugging. The
- format of the file is described in the man page **htools**(1).
+ format of the file is described in the man page **htools**\(1).
\--simulate *description*
Backend specification: similar to the **-t** option, this allows
overriding the cluster data with a simulated cluster. For details
- about the description, see the man page **htools**(1).
+ about the description, see the man page **htools**\(1).
-S *filename*, \--save-cluster=*filename*
If given, the state of the cluster before and the iallocator run is
-p, \--print-nodes
Prints the before and after node status, in a format designed to allow
the user to understand the node's most important parameters. See the
- man page **htools**(1) for more details about this option.
+ man page **htools**\(1) for more details about this option.
\--print-instances
Prints the before and after instance map. This is less useful as the
Backend specification: the name of the file holding node and instance
information (if not collecting via RAPI or LUXI). This or one of the
other backends must be selected. The option is described in the man
- page **htools**(1).
+ page **htools**\(1).
-m *cluster*
Backend specification: collect data directly from the *cluster* given
as an argument via RAPI. The option is described in the man page
- **htools**(1).
+ **htools**\(1).
-L [*path*]
Backend specification: collect data directly from the master daemon,
which is to be contacted via LUXI (an internal Ganeti protocol). The
- option is described in the man page **htools**(1).
+ option is described in the man page **htools**\(1).
-X
When using the Luxi backend, hbal can also execute the given
Note that it does not take any action, only performs a rebalance
simulation if necessary.
-For more information about the algorithm details check **hbal(1)**.
+For more information about the algorithm details check **hbal**\(1).
OPTIONS
-------
to simulate rebalancing.
For a detailed description about the options listed above have a look at
-**htools(7)**, **hspace(1)** and **hbal(1)**.
+**htools**\(7), **hspace**\(1) and **hbal**\(1).
.. vim: set textwidth=72 :
.. Local Variables:
-------
For a detailed description about the options listed above have a look at
-**htools(7)** and **hbal(1)**.
+**htools**\(7) and **hbal**\(1).
.. vim: set textwidth=72 :
.. Local Variables:
-------
Currently only standard htools options are supported. For a description of them
-check **htools(7)** and **hbal(1)**.
+check **htools**\(7) and **hbal**\(1).
BUGS
----
-----------
hscan is a tool for scanning clusters via RAPI and saving their data
-in the input format used by **hbal**(1) and **hspace**(1). It will
+in the input format used by **hbal**\(1) and **hspace**\(1). It will
also show a one-line score for each cluster scanned or, if desired,
the cluster state as show by the **-p** option to the other tools.
For each cluster, one file named *cluster***.data** will be generated
holding the node and instance data. This file can then be used in
-**hbal**(1) or **hspace**(1) via the *-t* option. In case the
+**hbal**\(1) or **hspace**\(1) via the *-t* option. In case the
cluster name contains slashes (as it can happen when the cluster is a
fully-specified URL), these will be replaced with underscores.
Free disk space in the cluster
Score
- The score of the cluster, as would be reported by **hbal**(1) if run
+ The score of the cluster, as would be reported by **hbal**\(1) if run
on the generated data files.
In case of errors while collecting data, all fields after the name of
Prints the node status for each cluster after the cluster's one-line
status display, in a format designed to allow the user to understand
the node's most important parameters. For details, see the man page
- for **htools**(1).
+ for **htools**\(1).
-d *path*
Save the node and instance data for each cluster under *path*,
-p, \--print-nodes
Prints the before and after node status, in a format designed to allow
the user to understand the node's most important parameters. See the
- man page **htools**(1) for more details about this option.
+ man page **htools**\(1) for more details about this option.
-O *name*
This option (which can be given multiple times) will mark nodes as
Backend specification: the name of the file holding node and instance
information (if not collecting via RAPI or LUXI). This or one of the
other backends must be selected. The option is described in the man
- page **htools**(1).
+ page **htools**\(1).
-m *cluster*
Backend specification: collect data directly from the *cluster* given
as an argument via RAPI. The option is described in the man page
- **htools**(1).
+ **htools**\(1).
-L [*path*]
Backend specification: collect data directly from the master daemon,
which is to be contacted via LUXI (an internal Ganeti protocol). The
- option is described in the man page **htools**(1).
+ option is described in the man page **htools**\(1).
\--simulate *description*
Backend specification: similar to the **-t** option, this allows
overriding the cluster data with a simulated cluster. For details
- about the description, see the man page **htools**(1).
+ about the description, see the man page **htools**\(1).
\--standard-alloc *disk,ram,cpu*
This option overrides the instance size read from the cluster for the
*MB*, *GB*, *TB*, for which case doesn't matter).
More details about the difference between the SI and binary systems can
-be read in the *units(7)* man page.
+be read in the **units**\(7) man page.
EXIT STATUS
-----------
Backend specification: the name of the file holding node and instance
information (if not collecting via RAPI or LUXI). This or one of the
other backends must be selected. The option is described in the man
- page **htools**(1).
+ page **htools**\(1).
The file should contain text data, line-based, with two empty lines
separating sections. The lines themselves are column-based, with the
matter).
More details about the difference between the SI and binary systems can
-be read in the *units(7)* man page.
+be read in the **units**\(7) man page.
ENVIRONMENT
-----------
projects / ganeti-github.git / commitdiff