This patch adds some more consistency in the parameter names
displayed in various ganeti man pages and their helper text
in gnt commands.
Signed-off-by: Federico Morg Pareschi <m...@google.com>
---
lib/client/gnt_backup.py | 6 +++---
lib/client/gnt_cluster.py | 21 +++++++++---------
lib/client/gnt_debug.py | 6 +++---
lib/client/gnt_filter.py | 10 ++++-----
lib/client/gnt_group.py | 24 ++++++++++-----------
lib/client/gnt_instance.py | 40 ++++++++++++++++++----------------
lib/client/gnt_job.py | 12 +++++------
lib/client/gnt_network.py | 22 +++++++++----------
lib/client/gnt_node.py | 35 +++++++++++++++---------------
man/gnt-backup.rst | 10 ++++-----
man/gnt-cluster.rst | 12 +++++------
man/gnt-debug.rst | 28 ++++++++++++------------
man/gnt-filter.rst | 24 ++++++++++-----------
man/gnt-group.rst | 14 ++++++------
man/gnt-instance.rst | 54 ++++++++++++++++++++++++----------------------
man/gnt-job.rst | 15 ++++++-------
man/gnt-network.rst | 36 +++++++++++++++----------------
man/gnt-node.rst | 38 ++++++++++++++++----------------
man/gnt-os.rst | 5 +++--
19 files changed, 209 insertions(+), 203 deletions(-)
diff --git a/lib/client/gnt_backup.py b/lib/client/gnt_backup.py
index 89b0e9370..1a0fd8d37 100644
--- a/lib/client/gnt_backup.py
+++ b/lib/client/gnt_backup.py
@@ -171,16 +171,16 @@ commands = {
SHUTDOWN_TIMEOUT_OPT, REMOVE_INSTANCE_OPT, IGNORE_REMOVE_FAILURES_OPT,
DRY_RUN_OPT, PRIORITY_OPT, ZERO_FREE_SPACE_OPT, ZEROING_TIMEOUT_FIXED_OPT,
ZEROING_TIMEOUT_PER_MIB_OPT, LONG_SLEEP_OPT] + SUBMIT_OPTS,
- "-n <target_node> [opts...] <name>",
+ "-n <node-name> [opts...] <instance-name>",
"Exports an instance to an image"),
"import": (
ImportInstance, ARGS_ONE_INSTANCE, COMMON_CREATE_OPTS + import_opts,
- "[...] -t disk-type -n node[:secondary-node] <name>",
+ "[...] -t disk-type -n node[:secondary-node] <instance-name>",
"Imports an instance from an exported image"),
"remove": (
RemoveExport, [ArgUnknown(min=1, max=1)],
[DRY_RUN_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<name>", "Remove exports of named instance from the filesystem."),
+ "<instance-name>", "Remove exports of named instance from the
filesystem."),
}
diff --git a/lib/client/gnt_cluster.py b/lib/client/gnt_cluster.py
index e23fb5039..72ee20d11 100644
--- a/lib/client/gnt_cluster.py
+++ b/lib/client/gnt_cluster.py
@@ -2418,14 +2418,14 @@ commands = {
ENABLED_USER_SHUTDOWN_OPT,
]
+ INSTANCE_POLICY_OPTS + SPLIT_ISPECS_OPTS,
- "[opts...] <cluster_name>", "Initialises a new cluster configuration"),
+ "[<opts>...] <cluster-name>", "Initialises a new cluster configuration"),
"destroy": (
DestroyCluster, ARGS_NONE, [YES_DOIT_OPT],
"", "Destroy cluster"),
"rename": (
RenameCluster, [ArgHost(min=1, max=1)],
[FORCE_OPT, DRY_RUN_OPT],
- "<new_name>",
+ "<new-name>",
"Renames the cluster"),
"redist-conf": (
RedistributeConfig, ARGS_NONE, SUBMIT_OPTS +
@@ -2443,7 +2443,7 @@ commands = {
"", "Does a check on the cluster disk status"),
"repair-disk-sizes": (
RepairDiskSizes, ARGS_MANY_INSTANCES, [DRY_RUN_OPT, PRIORITY_OPT],
- "[instance...]", "Updates mismatches in recorded disk sizes"),
+ "[<instance-name>...]", "Updates mismatches in recorded disk sizes"),
"master-failover": (
MasterFailover, ARGS_NONE, [NOVOTING_OPT, FORCE_FAILOVER],
"", "Makes the current node the master"),
@@ -2459,11 +2459,12 @@ commands = {
"copyfile": (
ClusterCopyFile, [ArgFile(min=1, max=1)],
[NODE_LIST_OPT, USE_REPL_NET_OPT, NODEGROUP_OPT],
- "[-n node...] <filename>", "Copies a file to all (or only some) nodes"),
+ "[-n <node-name>...] <filename>",
+ "Copies a file to all (or only some) nodes"),
"command": (
RunClusterCommand, [ArgCommand(min=1)],
[NODE_LIST_OPT, NODEGROUP_OPT, SHOW_MACHINE_OPT, FAILURE_ONLY_OPT],
- "[-n node...] <command>", "Runs a command on all (or only some) nodes"),
+ "[-n <node-name>...] <command>", "Runs a command on all (or only some)
nodes"),
"info": (
ShowClusterConfig, ARGS_NONE, [ROMAN_OPT],
"[--roman]", "Show cluster configuration"),
@@ -2471,10 +2472,10 @@ commands = {
ListTags, ARGS_NONE, [], "", "List the tags of the cluster"),
"add-tags": (
AddTags, [ArgUnknown()], [TAG_SRC_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "tag...", "Add tags to the cluster"),
+ "<tag>...", "Add tags to the cluster"),
"remove-tags": (
RemoveTags, [ArgUnknown()], [TAG_SRC_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "tag...", "Remove tags from the cluster"),
+ "<tag>...", "Remove tags from the cluster"),
"search-tags": (
SearchTags, [ArgUnknown(min=1, max=1)], [PRIORITY_OPT], "",
"Searches the tags on all objects on"
@@ -2506,7 +2507,7 @@ commands = {
[GLOBAL_FILEDIR_OPT, GLOBAL_SHARED_FILEDIR_OPT, ZEROING_IMAGE_OPT,
COMPRESSION_TOOLS_OPT] +
[ENABLED_DATA_COLLECTORS_OPT, DATA_COLLECTOR_INTERVAL_OPT],
- "[opts...]",
+ "[<opts>...]",
"Alters the parameters of the cluster"),
"renew-crypto": (
RenewCrypto, ARGS_NONE,
@@ -2516,13 +2517,13 @@ commands = {
NEW_SPICE_CERT_OPT, SPICE_CERT_OPT, SPICE_CACERT_OPT,
NEW_NODE_CERT_OPT, NEW_SSH_KEY_OPT, NOSSH_KEYCHECK_OPT,
VERBOSE_OPT],
- "[opts...]",
+ "[<opts>...]",
"Renews cluster certificates, keys and secrets"),
"epo": (
Epo, [ArgUnknown()],
[FORCE_OPT, ON_OPT, GROUPS_OPT, ALL_OPT, OOB_TIMEOUT_OPT,
SHUTDOWN_TIMEOUT_OPT, POWER_DELAY_OPT],
- "[opts...] [args]",
+ "[<opts>...] [args]",
"Performs an emergency power-off on given args"),
"activate-master-ip": (
ActivateMasterIp, ARGS_NONE, [], "", "Activates the master IP"),
diff --git a/lib/client/gnt_debug.py b/lib/client/gnt_debug.py
index 2393691bf..bf687e001 100644
--- a/lib/client/gnt_debug.py
+++ b/lib/client/gnt_debug.py
@@ -728,7 +728,7 @@ commands = {
action="store_true",
help="Don't take locks while performing the delay"),
DRY_RUN_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "[opts...] <duration>", "Executes a TestDelay OpCode"),
+ "[<opts>...] <duration>", "Executes a TestDelay OpCode"),
"submit-job": (
GenericOpCodes, [ArgFile(min=1)],
[VERBOSE_OPT,
@@ -742,7 +742,7 @@ commands = {
help="Submit each job separately"),
DRY_RUN_OPT, PRIORITY_OPT,
],
- "<op_list_file...>", "Submits jobs built from json files"
+ "<op-list-file>...", "Submits jobs built from json files"
" containing a list of serialized opcodes"),
"iallocator": (
TestAllocator, [ArgUnknown(min=1)],
@@ -781,7 +781,7 @@ commands = {
default=2, type="int"),
DRY_RUN_OPT, PRIORITY_OPT,
],
- "{opts...} <instance>", "Executes a TestAllocator OpCode"),
+ "{<opts>...} <instance-name>", "Executes a TestAllocator OpCode"),
"test-jobqueue": (
TestJobqueue, ARGS_NONE, [PRIORITY_OPT],
"", "Test a few aspects of the job queue"),
diff --git a/lib/client/gnt_filter.py b/lib/client/gnt_filter.py
index 9b1f63f2d..36a40feef 100644
--- a/lib/client/gnt_filter.py
+++ b/lib/client/gnt_filter.py
@@ -203,29 +203,29 @@ commands = {
"list": (
ListFilters, ARGS_MANY_FILTERS,
[NOHDR_OPT, SEP_OPT, FIELDS_OPT, VERBOSE_OPT],
- "[<filter_uuid>...]",
+ "[<filter-uuid>...]",
"Lists the job filter rules. The available fields can be shown"
" using the \"list-fields\" command (see the man page for details)."
" The default list is (in order): %s." %
utils.CommaJoin(_LIST_DEF_FIELDS)),
"list-fields": (
ListFilterFields, [ArgUnknown()],
[NOHDR_OPT, SEP_OPT],
- "[fields...]",
+ "[<fields>...]",
"Lists all available fields for filters"),
"info": (
ShowFilter, ARGS_MANY_FILTERS,
[],
- "[<filter_uuid>...]",
+ "[<filter-uuid>...]",
"Shows information about the filter(s)"),
"replace": (
ReplaceFilter, ARGS_ONE_FILTER,
[FILTER_PRIORITY_OPT, FILTER_PREDICATES_OPT, FILTER_ACTION_OPT],
- "<filter_uuid>",
+ "<filter-uuid>",
"Replaces a filter"),
"delete": (
DeleteFilter, ARGS_ONE_FILTER,
[],
- "<filter_uuid>",
+ "<filter-uuid>",
"Removes a filter"),
}
diff --git a/lib/client/gnt_group.py b/lib/client/gnt_group.py
index 5f4400121..60eed15f2 100644
--- a/lib/client/gnt_group.py
+++ b/lib/client/gnt_group.py
@@ -338,15 +338,15 @@ commands = {
[DRY_RUN_OPT, ALLOC_POLICY_OPT, NODE_PARAMS_OPT, DISK_PARAMS_OPT,
HV_STATE_OPT, DISK_STATE_OPT, PRIORITY_OPT]
+ SUBMIT_OPTS + INSTANCE_POLICY_OPTS,
- "<group_name>", "Add a new node group to the cluster"),
+ "<group-name>", "Add a new node group to the cluster"),
"assign-nodes": (
AssignNodes, ARGS_ONE_GROUP + ARGS_MANY_NODES,
[DRY_RUN_OPT, FORCE_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<group_name> <node>...", "Assign nodes to a group"),
+ "<group-name> <node-name>...", "Assign nodes to a group"),
"list": (
ListGroups, ARGS_MANY_GROUPS,
[NOHDR_OPT, SEP_OPT, FIELDS_OPT, VERBOSE_OPT, FORCE_FILTER_OPT],
- "[<group_name>...]",
+ "[<group-name>...]",
"Lists the node groups in the cluster. The available fields can be shown"
" using the \"list-fields\" command (see the man page for details)."
" The default list is (in order): %s." %
utils.CommaJoin(_LIST_DEF_FIELDS)),
@@ -359,39 +359,39 @@ commands = {
[ALLOC_POLICY_OPT, NODE_PARAMS_OPT, HV_STATE_OPT, DISK_STATE_OPT,
DISK_PARAMS_OPT, PRIORITY_OPT]
+ INSTANCE_POLICY_OPTS,
- "<group_name>", "Alters the parameters of a node group"),
+ "<group>", "Alters the parameters of a node group"),
"remove": (
RemoveGroup, ARGS_ONE_GROUP, [DRY_RUN_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "[--dry-run] <group-name>",
+ "[--dry-run] <group>",
"Remove an (empty) node group from the cluster"),
"rename": (
RenameGroup, [ArgGroup(min=2, max=2)],
[DRY_RUN_OPT] + SUBMIT_OPTS + [PRIORITY_OPT],
- "[--dry-run] <group-name> <new-name>", "Rename a node group"),
+ "[--dry-run] <old-name> <new-name>", "Rename a node group"),
"evacuate": (
EvacuateGroup, [ArgGroup(min=1, max=1)],
[TO_GROUP_OPT, IALLOCATOR_OPT, EARLY_RELEASE_OPT, SEQUENTIAL_OPT,
FORCE_FAILOVER_OPT]
+ SUBMIT_OPTS,
- "[-I <iallocator>] [--to <group>]",
+ "[-I <iallocator>] [--to <group>] <source-group>",
"Evacuate all instances within a group"),
"list-tags": (
ListTags, ARGS_ONE_GROUP, [],
- "<group_name>", "List the tags of the given group"),
+ "<group>", "List the tags of the given group"),
"add-tags": (
AddTags, [ArgGroup(min=1, max=1), ArgUnknown()],
[TAG_SRC_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<group_name> tag...", "Add tags to the given group"),
+ "<group> <tag>...", "Add tags to the given group"),
"remove-tags": (
RemoveTags, [ArgGroup(min=1, max=1), ArgUnknown()],
[TAG_SRC_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<group_name> tag...", "Remove tags from the given group"),
+ "<group> <tag>...", "Remove tags from the given group"),
"info": (
- GroupInfo, ARGS_MANY_GROUPS, [], "[<group_name>...]",
+ GroupInfo, ARGS_MANY_GROUPS, [], "[<group>...]",
"Show group information"),
"show-ispecs-cmd": (
ShowCreateCommand, ARGS_MANY_GROUPS, [INCLUDEDEFAULTS_OPT],
- "[--include-defaults] [<group_name>...]",
+ "[--include-defaults] [<group>...]",
"Show the command line to re-create a group"),
}
diff --git a/lib/client/gnt_instance.py b/lib/client/gnt_instance.py
index 1804c39ff..d51c775bd 100644
--- a/lib/client/gnt_instance.py
+++ b/lib/client/gnt_instance.py
@@ -1572,7 +1572,7 @@ commands = {
"add": (
AddInstance, [ArgHost(min=1, max=1)],
COMMON_CREATE_OPTS + add_opts,
- "[...] -t disk-type -n node[:secondary-node] -o os-type <name>",
+ "[...] -t disk-type -n node[:secondary-node] -o os-type <instance-name>",
"Creates and adds a new instance to the cluster"),
"batch-create": (
BatchCreate, [ArgFile(min=1, max=1)],
@@ -1582,14 +1582,15 @@ commands = {
"console": (
ConnectToInstanceConsole, ARGS_ONE_INSTANCE,
[SHOWCMD_OPT, PRIORITY_OPT],
- "[--show-cmd] <instance>", "Opens a console on the specified instance"),
+ "[--show-cmd] <instance-name>",
+ "Opens a console on the specified instance"),
"failover": (
FailoverInstance, ARGS_ONE_INSTANCE,
[FORCE_OPT, IGNORE_CONSIST_OPT] + SUBMIT_OPTS +
[SHUTDOWN_TIMEOUT_OPT,
DRY_RUN_OPT, PRIORITY_OPT, DST_NODE_OPT, IALLOCATOR_OPT,
IGNORE_IPOLICY_OPT, CLEANUP_OPT],
- "[-f] <instance>", "Stops the instance, changes its primary node and"
+ "[-f] <instance-name>", "Stops the instance, changes its primary node and"
" (if it was originally running) starts it on the new node"
" (the secondary for mirrored instances or any node"
" for shared storage)."),
@@ -1599,7 +1600,7 @@ commands = {
PRIORITY_OPT, DST_NODE_OPT, IALLOCATOR_OPT, ALLOW_FAILOVER_OPT,
IGNORE_IPOLICY_OPT, IGNORE_HVVERSIONS_OPT, NORUNTIME_CHGS_OPT]
+ SUBMIT_OPTS,
- "[-f] <instance>", "Migrate instance to its secondary node"
+ "[-f] <instance-name>", "Migrate instance to its secondary node"
" (only for mirrored instances)"),
"move": (
MoveInstance, ARGS_ONE_INSTANCE,
@@ -1607,18 +1608,18 @@ commands = {
[SINGLE_NODE_OPT, COMPRESS_OPT,
SHUTDOWN_TIMEOUT_OPT, DRY_RUN_OPT, PRIORITY_OPT, IGNORE_CONSIST_OPT,
IGNORE_IPOLICY_OPT],
- "[-f] <instance>", "Move instance to an arbitrary node"
+ "[-f] <instance-name>", "Move instance to an arbitrary node"
" (only for instances of type file and lv)"),
"info": (
ShowInstanceConfig, ARGS_MANY_INSTANCES,
[STATIC_OPT, ALL_OPT, ROMAN_OPT, PRIORITY_OPT],
- "[-s] {--all | <instance>...}",
+ "[-s] {--all | <instance-name>...}",
"Show information on the specified instance(s)"),
"list": (
ListInstances, ARGS_MANY_INSTANCES,
[NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, VERBOSE_OPT,
FORCE_FILTER_OPT],
- "[<instance>...]",
+ "[<instance-name>...]",
"Lists the instances and their status. The available fields can be shown"
" using the \"list-fields\" command (see the man page for details)."
" The default field list is (in order): %s." %
@@ -1641,19 +1642,19 @@ commands = {
RemoveInstance, ARGS_ONE_INSTANCE,
[FORCE_OPT, SHUTDOWN_TIMEOUT_OPT, IGNORE_FAILURES_OPT] + SUBMIT_OPTS
+ [DRY_RUN_OPT, PRIORITY_OPT],
- "[-f] <instance>", "Shuts down the instance and removes it"),
+ "[-f] <instance-name>", "Shuts down the instance and removes it"),
"rename": (
RenameInstance,
[ArgInstance(min=1, max=1), ArgHost(min=1, max=1)],
[NOIPCHECK_OPT, NONAMECHECK_OPT] + SUBMIT_OPTS
+ [DRY_RUN_OPT, PRIORITY_OPT],
- "<instance> <new_name>", "Rename the instance"),
+ "<old-name> <new-name>", "Rename the instance"),
"replace-disks": (
ReplaceDisks, ARGS_ONE_INSTANCE,
[AUTO_REPLACE_OPT, DISKIDX_OPT, IALLOCATOR_OPT, EARLY_RELEASE_OPT,
NEW_SECONDARY_OPT, ON_PRIMARY_OPT, ON_SECONDARY_OPT] + SUBMIT_OPTS
+ [DRY_RUN_OPT, PRIORITY_OPT, IGNORE_IPOLICY_OPT],
- "[-s|-p|-a|-n NODE|-I NAME] <instance>",
+ "[-s|-p|-a|-n NODE|-I NAME] <instance-name>",
"Replaces disks for the instance"),
"modify": (
SetInstanceParams, ARGS_ONE_INSTANCE,
@@ -1664,7 +1665,7 @@ commands = {
NOCONFLICTSCHECK_OPT, NEW_PRIMARY_OPT, HOTPLUG_OPT,
HOTPLUG_IF_POSSIBLE_OPT, INSTANCE_COMMUNICATION_OPT,
EXT_PARAMS_OPT, FILESTORE_DRIVER_OPT, FILESTORE_DIR_OPT],
- "<instance>", "Alters the parameters of an instance"),
+ "<instance-name>", "Alters the parameters of an instance"),
"shutdown": (
GenericManyOps("shutdown", _ShutdownInstance), [ArgInstance()],
[FORCE_OPT, m_node_opt, m_pri_node_opt, m_sec_node_opt, m_clust_opt,
@@ -1691,40 +1692,41 @@ commands = {
"activate-disks": (
ActivateDisks, ARGS_ONE_INSTANCE,
SUBMIT_OPTS + [IGNORE_SIZE_OPT, PRIORITY_OPT, WFSYNC_OPT],
- "<instance>", "Activate an instance's disks"),
+ "<instance-name>", "Activate an instance's disks"),
"deactivate-disks": (
DeactivateDisks, ARGS_ONE_INSTANCE,
[FORCE_OPT] + SUBMIT_OPTS + [DRY_RUN_OPT, PRIORITY_OPT],
- "[-f] <instance>", "Deactivate an instance's disks"),
+ "[-f] <instance-name>", "Deactivate an instance's disks"),
"recreate-disks": (
RecreateDisks, ARGS_ONE_INSTANCE,
SUBMIT_OPTS +
[DISK_OPT, NODE_PLACEMENT_OPT, DRY_RUN_OPT, PRIORITY_OPT,
IALLOCATOR_OPT],
- "<instance>", "Recreate an instance's disks"),
+ "<instance-name>", "Recreate an instance's disks"),
"grow-disk": (
GrowDisk,
[ArgInstance(min=1, max=1), ArgUnknown(min=1, max=1),
ArgUnknown(min=1, max=1)],
SUBMIT_OPTS +
[NWSYNC_OPT, DRY_RUN_OPT, PRIORITY_OPT, ABSOLUTE_OPT, IGNORE_IPOLICY_OPT],
- "<instance> <disk> <size>", "Grow an instance's disk"),
+ "<instance-name> <disk> <size>", "Grow an instance's disk"),
"change-group": (
ChangeGroup, ARGS_ONE_INSTANCE,
[TO_GROUP_OPT, IALLOCATOR_OPT, EARLY_RELEASE_OPT, PRIORITY_OPT]
+ SUBMIT_OPTS,
- "[-I <iallocator>] [--to <group>]", "Change group of instance"),
+ "[-I <iallocator>] [--to <group>] <instance-name>",
+ "Change group of instance"),
"list-tags": (
ListTags, ARGS_ONE_INSTANCE, [],
- "<instance_name>", "List the tags of the given instance"),
+ "<instance-name>", "List the tags of the given instance"),
"add-tags": (
AddTags, [ArgInstance(min=1, max=1), ArgUnknown()],
[TAG_SRC_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<instance_name> tag...", "Add tags to the given instance"),
+ "<instance-name> <tag>...", "Add tags to the given instance"),
"remove-tags": (
RemoveTags, [ArgInstance(min=1, max=1), ArgUnknown()],
[TAG_SRC_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<instance_name> tag...", "Remove tags from given instance"),
+ "<instance-name> <tag>...", "Remove tags from given instance"),
}
#: dictionary with aliases for commands
diff --git a/lib/client/gnt_job.py b/lib/client/gnt_job.py
index 3dd4eff0d..f95528135 100644
--- a/lib/client/gnt_job.py
+++ b/lib/client/gnt_job.py
@@ -527,7 +527,7 @@ commands = {
ListJobs, [ArgJobId()],
[NOHDR_OPT, SEP_OPT, FIELDS_OPT, VERBOSE_OPT, FORCE_FILTER_OPT,
_PENDING_OPT, _RUNNING_OPT, _ERROR_OPT, _FINISHED_OPT, _ARCHIVED_OPT],
- "[job_id ...]",
+ "[<job-id>...]",
"Lists the jobs and their status. The available fields can be shown"
" using the \"list-fields\" command (see the man page for details)."
" The default field list is (in order): %s." %
@@ -535,11 +535,11 @@ commands = {
"list-fields": (
ListJobFields, [ArgUnknown()],
[NOHDR_OPT, SEP_OPT],
- "[fields...]",
+ "[<fields>...]",
"Lists all available fields for jobs"),
"archive": (
ArchiveJobs, [ArgJobId(min=1)], [],
- "<job-id> [<job-id> ...]", "Archive specified jobs"),
+ "<job-id> [<job-id>...]", "Archive specified jobs"),
"autoarchive": (
AutoArchiveJobs,
[ArgSuggest(min=1, max=1, choices=["1d", "1w", "4w", "all"])],
@@ -550,11 +550,11 @@ commands = {
[FORCE_OPT, _KILL_OPT, _PENDING_OPT, _QUEUED_OPT, _WAITING_OPT,
_YES_DOIT_OPT],
"{[--force] [--kill --yes-do-it] {--pending | --queued | --waiting} |"
- " <job-id> [<job-id> ...]}",
+ " <job-id> [<job-id>...]}",
"Cancel jobs"),
"info": (
ShowJobs, [ArgJobId(min=1)], [],
- "<job-id> [<job-id> ...]",
+ "<job-id> [<job-id>...]",
"Show detailed information about the specified jobs"),
"wait": (
WaitJob, [ArgJobId(min=1, max=1)], [],
@@ -566,7 +566,7 @@ commands = {
ChangePriority, [ArgJobId()],
[PRIORITY_OPT, FORCE_OPT, _PENDING_OPT, _QUEUED_OPT, _WAITING_OPT],
"--priority <priority> {[--force] {--pending | --queued | --waiting} |"
- " <job-id> [<job-id> ...]}",
+ " <job-id> [<job-id>...]}",
"Change the priority of jobs"),
}
diff --git a/lib/client/gnt_network.py b/lib/client/gnt_network.py
index 41348c436..6255b039f 100644
--- a/lib/client/gnt_network.py
+++ b/lib/client/gnt_network.py
@@ -330,57 +330,57 @@ commands = {
[DRY_RUN_OPT, NETWORK_OPT, GATEWAY_OPT, ADD_RESERVED_IPS_OPT,
MAC_PREFIX_OPT, NETWORK6_OPT, GATEWAY6_OPT,
NOCONFLICTSCHECK_OPT, TAG_ADD_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<network_name>", "Add a new IP network to the cluster"),
+ "<network-name>", "Add a new IP network to the cluster"),
"list": (
ListNetworks, ARGS_MANY_NETWORKS,
[NOHDR_OPT, SEP_OPT, FIELDS_OPT, VERBOSE_OPT],
- "[<network_id>...]",
+ "[<network-name>...]",
"Lists the IP networks in the cluster. The available fields can be shown"
" using the \"list-fields\" command (see the man page for details)."
" The default list is (in order): %s." %
utils.CommaJoin(_LIST_DEF_FIELDS)),
"list-fields": (
- ListNetworkFields, [ArgUnknown()], [NOHDR_OPT, SEP_OPT], "[fields...]",
+ ListNetworkFields, [ArgUnknown()], [NOHDR_OPT, SEP_OPT], "[<fields>...]",
"Lists all available fields for networks"),
"info": (
ShowNetworkConfig, ARGS_MANY_NETWORKS, [],
- "[<network_name>...]", "Show information about the network(s)"),
+ "[<network>...]", "Show information about the network(s)"),
"modify": (
SetNetworkParams, ARGS_ONE_NETWORK,
[DRY_RUN_OPT] + SUBMIT_OPTS +
[ADD_RESERVED_IPS_OPT,
REMOVE_RESERVED_IPS_OPT, GATEWAY_OPT, MAC_PREFIX_OPT, NETWORK6_OPT,
GATEWAY6_OPT, PRIORITY_OPT],
- "<network_name>", "Alters the parameters of a network"),
+ "<network>", "Alters the parameters of a network"),
"connect": (
ConnectNetwork,
[ArgNetwork(min=1, max=1),
ArgGroup()],
[NOCONFLICTSCHECK_OPT, PRIORITY_OPT, NIC_PARAMS_OPT],
- "<network_name> [<node_group>...]",
+ "<network> [<group>...]",
"Map a given network to the specified node group"
" with given mode and link (netparams)"),
"disconnect": (
DisconnectNetwork,
[ArgNetwork(min=1, max=1), ArgGroup()],
[PRIORITY_OPT],
- "<network_name> [<node_group>...]",
+ "<network> [<group>...]",
"Unmap a given network from a specified node group"),
"remove": (
RemoveNetwork, ARGS_ONE_NETWORK,
[FORCE_OPT, DRY_RUN_OPT] + SUBMIT_OPTS + [PRIORITY_OPT],
- "[--dry-run] <network_id>",
+ "[--dry-run] <network>",
"Remove an (empty) network from the cluster"),
"list-tags": (
ListTags, ARGS_ONE_NETWORK, [],
- "<network_name>", "List the tags of the given network"),
+ "<network>", "List the tags of the given network"),
"add-tags": (
AddTags, [ArgNetwork(min=1, max=1), ArgUnknown()],
[TAG_SRC_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<network_name> tag...", "Add tags to the given network"),
+ "<network> <tag>...", "Add tags to the given network"),
"remove-tags": (
RemoveTags, [ArgNetwork(min=1, max=1), ArgUnknown()],
[TAG_SRC_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<network_name> tag...", "Remove tags from given network"),
+ "<network> <tag>...", "Remove tags from given network"),
}
diff --git a/lib/client/gnt_node.py b/lib/client/gnt_node.py
index 87f3d19e1..02436f5d6 100644
--- a/lib/client/gnt_node.py
+++ b/lib/client/gnt_node.py
@@ -1133,7 +1133,7 @@ commands = {
CAPAB_MASTER_OPT, CAPAB_VM_OPT, NODE_PARAMS_OPT, HV_STATE_OPT,
DISK_STATE_OPT],
"[-s ip] [--readd] [--no-ssh-key-check] [--force-join]"
- " [--no-node-setup] [--verbose] [--network] <node_name>",
+ " [--no-node-setup] [--verbose] [--network] <node-name>",
"Add a node to the cluster"),
"evacuate": (
EvacuateNode, ARGS_ONE_NODE,
@@ -1158,12 +1158,12 @@ commands = {
" (only for instances of type drbd)"),
"info": (
ShowNodeConfig, ARGS_MANY_NODES, [],
- "[<node_name>...]", "Show information about the node(s)"),
+ "[<node>...]", "Show information about the node(s)"),
"list": (
ListNodes, ARGS_MANY_NODES,
[NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, VERBOSE_OPT,
FORCE_FILTER_OPT],
- "[nodes...]",
+ "[<node-name>...]",
"Lists the nodes in the cluster. The available fields can be shown using"
" the \"list-fields\" command (see the man page for details)."
" The default field list is (in order): %s." %
@@ -1180,11 +1180,11 @@ commands = {
CAPAB_MASTER_OPT, CAPAB_VM_OPT, SECONDARY_IP_OPT,
AUTO_PROMOTE_OPT, DRY_RUN_OPT, PRIORITY_OPT, NODE_PARAMS_OPT,
NODE_POWERED_OPT, HV_STATE_OPT, DISK_STATE_OPT],
- "<node_name>", "Alters the parameters of a node"),
+ "<node-name>", "Alters the parameters of a node"),
"powercycle": (
PowercycleNode, ARGS_ONE_NODE,
[FORCE_OPT, CONFIRM_OPT, DRY_RUN_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<node_name>", "Tries to forcefully powercycle a node"),
+ "<node-name>", "Tries to forcefully powercycle a node"),
"power": (
PowerNode,
[ArgChoice(min=1, max=1, choices=_LIST_POWER_COMMANDS),
@@ -1193,20 +1193,20 @@ commands = {
[AUTO_PROMOTE_OPT, PRIORITY_OPT,
IGNORE_STATUS_OPT, FORCE_OPT, NOHDR_OPT, SEP_OPT, OOB_TIMEOUT_OPT,
POWER_DELAY_OPT],
- "on|off|cycle|status [nodes...]",
+ "on|off|cycle|status [<node-name>...]",
"Change power state of node by calling out-of-band helper."),
"remove": (
RemoveNode, ARGS_ONE_NODE, [DRY_RUN_OPT, PRIORITY_OPT],
- "<node_name>", "Removes a node from the cluster"),
+ "<node-name>", "Removes a node from the cluster"),
"volumes": (
ListVolumes, [ArgNode()],
[NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, PRIORITY_OPT],
- "[<node_name>...]", "List logical volumes on node(s)"),
+ "[<node-name>...]", "List logical volumes on node(s)"),
"list-storage": (
ListStorage, ARGS_MANY_NODES,
[NOHDR_OPT, SEP_OPT, USEUNITS_OPT, FIELDS_OPT, _STORAGE_TYPE_OPT,
PRIORITY_OPT],
- "[<node_name>...]", "List physical volumes on node(s). The available"
+ "[<node-name>...]", "List physical volumes on node(s). The available"
" fields are (see the man page for details): %s." %
(utils.CommaJoin(_LIST_STOR_HEADERS))),
"modify-storage": (
@@ -1215,38 +1215,39 @@ commands = {
ArgChoice(min=1, max=1, choices=_MODIFIABLE_STORAGE_TYPES),
ArgFile(min=1, max=1)],
[ALLOCATABLE_OPT, DRY_RUN_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<node_name> <storage_type> <name>", "Modify storage volume on a node"),
+ "<node-name> <storage-type> <volume-name>",
+ "Modify storage volume on a node"),
"repair-storage": (
RepairStorage,
[ArgNode(min=1, max=1),
ArgChoice(min=1, max=1, choices=_REPAIRABLE_STORAGE_TYPES),
ArgFile(min=1, max=1)],
[IGNORE_CONSIST_OPT, DRY_RUN_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<node_name> <storage_type> <name>",
+ "<node-name> <storage-type> <volume-name>",
"Repairs a storage volume on a node"),
"list-tags": (
ListTags, ARGS_ONE_NODE, [],
- "<node_name>", "List the tags of the given node"),
+ "<node-name>", "List the tags of the given node"),
"add-tags": (
AddTags, [ArgNode(min=1, max=1), ArgUnknown()],
[TAG_SRC_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<node_name> tag...", "Add tags to the given node"),
+ "<node-name> <tag>...", "Add tags to the given node"),
"remove-tags": (
RemoveTags, [ArgNode(min=1, max=1), ArgUnknown()],
[TAG_SRC_OPT, PRIORITY_OPT] + SUBMIT_OPTS,
- "<node_name> tag...", "Remove tags from the given node"),
+ "<node-name> <tag>...", "Remove tags from the given node"),
"health": (
Health, ARGS_MANY_NODES,
[NOHDR_OPT, SEP_OPT, PRIORITY_OPT, OOB_TIMEOUT_OPT],
- "[<node_name>...]", "List health of node(s) using out-of-band"),
+ "[<node-name>...]", "List health of node(s) using out-of-band"),
"list-drbd": (
ListDrbd, ARGS_ONE_NODE,
[NOHDR_OPT, SEP_OPT],
- "[<node_name>]", "Query the list of used DRBD minors on the given node"),
+ "<node>", "Query the list of used DRBD minors on the given node"),
"restricted-command": (
RestrictedCommand, [ArgUnknown(min=1, max=1)] + ARGS_MANY_NODES,
[SYNC_OPT, PRIORITY_OPT] + SUBMIT_OPTS + [SHOW_MACHINE_OPT, NODEGROUP_OPT],
- "<command> <node_name> [<node_name>...]",
+ "<command> <node-name>...",
"Executes a restricted command on node(s)"),
}
diff --git a/man/gnt-backup.rst b/man/gnt-backup.rst
index ecb092339..7074df2c0 100644
--- a/man/gnt-backup.rst
+++ b/man/gnt-backup.rst
@@ -24,13 +24,13 @@ COMMANDS
EXPORT
~~~~~~
-| **export** {-n *node*}
+| **export** {-n *node-name*}
| [\--shutdown-timeout=*N*] [\--noshutdown] [\--remove-instance]
| [\--ignore-remove-failures] [\--submit] [\--print-jobid]
| [\--transport-compression=*compression-mode*]
| [\--zero-free-space] [\--zeroing-timeout-fixed]
| [\--zeroing-timeout-per-mib] [\--long-sleep]
-| {*instance*}
+| {*instance-name*}
Exports an instance to the target node. All the instance data and
its configuration will be exported under the
@@ -98,10 +98,10 @@ IMPORT
| [\--identify-defaults]
| [\--ignore-ipolicy]
| [\--submit] [\--print-jobid]
-| {*instance*}
+| {*instance-name*}
Imports a new instance from an export residing on *source-node* in
-*source-dir*. *instance* must be in DNS and resolve to a IP in the
+*source-dir*. *instance-name* must be in DNS and resolve to a IP in the
same network as the nodes in the cluster. If the source node and
directory are not passed, the last backup in the cluster is used,
as visible with the **list** command.
@@ -292,7 +292,7 @@ Lists available fields for exports.
REMOVE
~~~~~~
-**remove** {instance_name}
+**remove** {*instance-name*}
Removes the backup for the given instance name, if any. If the backup
was for a deleted instance, it is needed to pass the FQDN of the
diff --git a/man/gnt-cluster.rst b/man/gnt-cluster.rst
index f34677a12..000be0eed 100644
--- a/man/gnt-cluster.rst
+++ b/man/gnt-cluster.rst
@@ -30,7 +30,7 @@ Activates the master IP on the master node.
COMMAND
~~~~~~~
-**command** [-n *node*] [-g *group*] [-M] {*command*}
+**command** [-n *node-name*] [-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)
@@ -72,7 +72,7 @@ and the command which will be executed will be ``ls -l /etc``.
COPYFILE
~~~~~~~~
-| **copyfile** [\--use-replication-network] [-n *node*] [-g *group*]
+| **copyfile** [\--use-replication-network] [-n *node-name*] [-g *group*]
| {*file*}
Copies a file to all or to some nodes. The argument specifies the
@@ -206,14 +206,14 @@ INIT
| [\--zeroing-image *image*]
| [\--compression-tools [*tool*, [*tool*]]]
| [\--user-shutdown {yes \| no}]
-| {*clustername*}
+| {*cluster-name*}
This commands is only run once initially on the first node of the
cluster. It will initialize the cluster configuration, setup the
ssh-keys, start the daemons on the master node, etc. in order to have
a working one-node cluster.
-Note that the *clustername* is not any random name. It has to be
+Note that the *cluster-name* is not any random name. It has to be
resolvable to an IP address using DNS, and it is best if you give the
fully-qualified domain name. This hostname must resolve to an IP
address reserved exclusively for this purpose, i.e. not already in
@@ -842,7 +842,7 @@ options.
RENAME
~~~~~~
-**rename** [-f] {*name*}
+**rename** [-f] {*new-name*}
Renames the cluster and in the process updates the master IP
address to the one the new name resolves to. At least one of either
@@ -908,7 +908,7 @@ information exchanged between separate clusters via a third
party.
REPAIR-DISK-SIZES
~~~~~~~~~~~~~~~~~
-**repair-disk-sizes** [instance...]
+**repair-disk-sizes** [instance-name...]
This command checks that the recorded size of the given instance's
disks matches the actual size and updates any mismatches found.
diff --git a/man/gnt-debug.rst b/man/gnt-debug.rst
index 6614c12fd..81e256235 100644
--- a/man/gnt-debug.rst
+++ b/man/gnt-debug.rst
@@ -22,20 +22,20 @@ COMMANDS
IALLOCATOR
~~~~~~~~~~
-**iallocator** [\--debug] [\--dir *DIRECTION*] {\--algorithm
-*ALLOCATOR* } [\--mode *MODE*] [\--mem *MEMORY*] [\--disks *DISKS*]
-[\--disk-template *TEMPLATE*] [\--nics *NICS*] [\--os-type *OS*]
-[\--vcpus *VCPUS*] [\--tags *TAGS*] {*instance*}
+**iallocator** [\--debug] [\--dir *direction*] {\--algorithm
+*allocator* } [\--mode *mode*] [\--mem *memory*] [\--disks *diskS*]
+[\--disk-template *template*] [\--nics *nics*] [\--os-type *OS*]
+[\--vcpus *vcpus*] [\--tags *tags*] {*instance-name*}
Executes a test run of the *iallocator* framework.
The command will build input for a given iallocator script (named
with the ``--algorithm`` option), and either show this input data
-(if *DIRECTION* is ``in``) or run the iallocator script and show its
-output (if *DIRECTION* is ``out``).
+(if *direction* is ``in``) or run the iallocator script and show its
+output (if *direction* is ``out``).
-If the *MODE* is ``allocate``, then an instance definition is built
-from the other arguments and sent to the script, otherwise (*MODE* is
+If the *mode* is ``allocate``, then an instance definition is built
+from the other arguments and sent to the script, otherwise (*mode* is
``relocate``) an existing instance name must be passed as the first
argument.
@@ -46,7 +46,7 @@ this framework, see the HTML or PDF documentation.
DELAY
~~~~~
-**delay** [\--debug] [\--no-master] [\--interruptible] [-n *NODE*...]
+**delay** [\--debug] [\--no-master] [\--interruptible] [-n *node-name*...]
{*duration*}
Run a test opcode (a sleep) on the master and on selected nodes
@@ -68,8 +68,8 @@ number.
SUBMIT-JOB
~~~~~~~~~~
-**submit-job** [\--verbose] [\--timing-stats] [\--job-repeat *N*]
-[\--op-repeat *N*] [\--each] {opcodes_file...}
+**submit-job** [\--verbose] [\--timing-stats] [\--job-repeat *n*]
+[\--op-repeat *n*] [\--each] {opcodes_file...}
This command builds a list of opcodes from files in JSON format and
submits a job per file to the master daemon. It can be used to test
@@ -102,8 +102,8 @@ failed jobs deliberately.
LOCKS
~~~~~
-| **locks** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
-| [-o *[+]FIELD,...*] [\--interval=*SECONDS*]
+| **locks** [\--no-headers] [\--separator=*separator*] [-v]
+| [-o *[+]field,...*] [\--interval=*seconds*]
Shows a list of locks in the master daemon.
@@ -152,7 +152,7 @@ printed to the console.
A request to clean up all stale locks is sent to WConfd.
-| **wconfd** listlocks *jid*
+| **wconfd** listlocks *job-id*
A request to list the locks owned by the given job id is
sent to WConfd and the answer is displayed.
diff --git a/man/gnt-filter.rst b/man/gnt-filter.rst
index 1a5bbab12..fec6dd491 100644
--- a/man/gnt-filter.rst
+++ b/man/gnt-filter.rst
@@ -91,9 +91,9 @@ ADD
~~~
| **add**
-| [\--priority=*PRIORITY*]
-| [\--predicates=*PREDICATES*]
-| [\--action=*ACTION*]
+| [\--priority=*priority*]
+| [\--predicates=*predicates*]
+| [\--action=*action*]
Creates a new filter rule. A UUID is automatically assigned.
@@ -118,11 +118,11 @@ REPLACE
~~~~~~~
| **replace**
-| [\--priority=*PRIORITY*]
-| [\--predicates=*PREDICATES*]
-| [\--action=*ACTION*]
-| [\--reason=*REASON*]
-| {*filter_uuid*}
+| [\--priority=*priority*]
+| [\--predicates=*predicates*]
+| [\--action=*action*]
+| [\--reason=*reason*]
+| {*filter-uuid*}
Replaces a filter rule, or creates one if it doesn't already exist.
@@ -136,15 +136,15 @@ options.
DELETE
~~~~~~
-| **delete** {*filter_uuid*}
+| **delete** {*filter-uuid*}
Deletes the indicated filter rule.
LIST
~~~~
-| **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
-| [-o *[+]FIELD,...*] [filter_uuid...]
+| **list** [\--no-headers] [\--separator=*separator*] [-v]
+| [-o *[+]field,...*] [filter-uuid...]
Lists all existing filters in the cluster. If no filter UUIDs are given,
then all filters are included. Otherwise, only the given filters will be
@@ -177,7 +177,7 @@ List available fields for filters.
INFO
~~~~
-| **info** [filter_uuid...]
+| **info** [filter-uuid...]
Displays information about a given filter.
diff --git a/man/gnt-group.rst b/man/gnt-group.rst
index 1c313b2a7..b03f1d95f 100644
--- a/man/gnt-group.rst
+++ b/man/gnt-group.rst
@@ -33,7 +33,7 @@ ADD
| [\--ipolicy-vcpu-ratio *ratio*]
| [\--disk-state *diskstate*]
| [\--hypervisor-state *hvstate*]
-| {*group*}
+| {*group-name*}
Creates a new group with the given name. The node group will be
initially empty; to add nodes to it, use ``gnt-group assign-nodes``.
@@ -76,7 +76,7 @@ ASSIGN-NODES
| **assign-nodes**
| [\--force] [\--submit] [\--print-jobid]
-| {*group*} {*node*...}
+| {*group-name*} {*node-name*...}
Assigns one or more nodes to the specified group, moving them from their
original group (or groups).
@@ -136,7 +136,7 @@ LIST
~~~~
| **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
-| [-o *[+]FIELD,...*] [\--filter] [group...]
+| [-o *[+]FIELD,...*] [\--filter] [*group-name*...]
Lists all existing node groups in the cluster.
@@ -188,7 +188,7 @@ EVACUATE
~~~~~~~~
| **evacuate** [\--submit] [\--print-jobid] [\--sequential] [\--force-failover]
-| [\--iallocator *NAME*] [\--to *GROUP*...] {*group*}
+| [\--iallocator *name*] [\--to *group*...] {*source-group*}
This command will move all instances out of the given node group.
Instances are placed in a new group by an iallocator, either given on
@@ -219,7 +219,7 @@ Tags
ADD-TAGS
^^^^^^^^
-**add-tags** [\--from *file*] {*groupname*} {*tag*...}
+**add-tags** [\--from *file*] {*group*} {*tag*...}
Add tags to the given node group. If any of the tags contains invalid
characters, the entire operation will abort.
@@ -233,14 +233,14 @@ stdin.
LIST-TAGS
^^^^^^^^^
-**list-tags** {*groupname*}
+**list-tags** {*group*}
List the tags of the given node group.
REMOVE-TAGS
^^^^^^^^^^^
-**remove-tags** [\--from *file*] {*groupname*} {*tag*...}
+**remove-tags** [\--from *file*] {*group*} {*tag*...}
Remove tags from the given node group. If any of the tags are not
existing on the node, the entire operation will abort.
diff --git a/man/gnt-instance.rst b/man/gnt-instance.rst
index a29fd7972..e9dbfabd4 100644
--- a/man/gnt-instance.rst
+++ b/man/gnt-instance.rst
@@ -47,9 +47,9 @@ ADD
| [\--ignore-ipolicy]
| [\--no-wait-for-sync]
| [{-c|\--communication=yes|no}]
-| {*instance*}
+| {*instance-name*}
-Creates a new instance on the specified host. The *instance* argument
+Creates a new instance on the specified host. The *instance-name* argument
must be in DNS, but depending on the bridge/routing setup, need not be
in the same network as the nodes in the cluster.
@@ -1223,7 +1223,7 @@ REMOVE
^^^^^^
| **remove** [\--ignore-failures] [\--shutdown-timeout=*N*] [\--submit]
-| [\--print-jobid] [\--force] {*instance*}
+| [\--print-jobid] [\--force] {*instance-name*}
Remove an instance. This will remove all data from the instance and
there is *no way back*. If you are not sure if you use an instance
@@ -1255,7 +1255,7 @@ LIST
| **list**
| [\--no-headers] [\--separator=*SEPARATOR*] [\--units=*UNITS*] [-v]
-| [{-o|\--output} *[+]FIELD,...*] [\--filter] [instance...]
+| [{-o|\--output} *[+]FIELD,...*] [\--filter] [*instance-name*...]
Shows the currently configured instances with memory usage, disk
usage, the node they are running on, and their run status.
@@ -1315,7 +1315,7 @@ Lists available fields for instances.
INFO
^^^^
-**info** [-s \| \--static] [\--roman] {\--all \| *instance*}
+**info** [-s \| \--static] [\--roman] {\--all \| *instance-name*}
Show detailed information about the given instance(s). This is
different from **list** as it shows detailed data about the instance's
@@ -1364,7 +1364,7 @@ MODIFY
| [\--ignore-ipolicy]
| [\--hotplug]
| [\--hotplug-if-possible]
-| {*instance*}
+| {*instance-name*}
Modifies the memory size, number of vcpus, ip address, MAC address
and/or NIC parameters for an instance. It can also add and remove
@@ -1523,7 +1523,7 @@ RENAME
^^^^^^
| **rename** [\--no-ip-check] [\--no-name-check] [\--submit] [\--print-jobid]
-| {*instance*} {*new\_name*}
+| {*old-name*} {*new-name*}
Renames the given instance. The instance must be stopped when running
this command. The requirements for the new name are the same as for
@@ -1559,7 +1559,7 @@ STARTUP
| [{-H|\--hypervisor-parameters} ``key=value...``]
| [{-B|\--backend-parameters} ``key=value...``]
| [\--submit] [\--print-jobid] [\--paused]
-| {*name*...}
+| {*instance*...}
Starts one or more instances, depending on the following options. The
four available modes are:
@@ -1657,7 +1657,7 @@ SHUTDOWN
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
| [\--submit] [\--print-jobid]
-| {*name*...}
+| {*instance*...}
Stops one or more instances. If the instance cannot be cleanly stopped
during a hardcoded interval (currently 2 minutes), it will forcibly
@@ -1711,7 +1711,7 @@ REBOOT
| [\--instance \| \--node \| \--primary \| \--secondary \| \--all \|
| \--tags \| \--node-tags \| \--pri-node-tags \| \--sec-node-tags]
| [\--submit] [\--print-jobid]
-| [*name*...]
+| [*instance*...]
Reboots one or more instances. The type of reboot depends on the value
of ``-t (--type)``. A soft reboot does a hypervisor reboot, a hard reboot
@@ -1775,17 +1775,18 @@ REPLACE-DISKS
^^^^^^^^^^^^^
| **replace-disks** [\--submit] [\--print-jobid] [\--early-release]
-| [\--ignore-ipolicy] {-p} [\--disks *idx*] {*instance*}
+| [\--ignore-ipolicy] {-p} [\--disks *idx*] {*instance-name*}
| **replace-disks** [\--submit] [\--print-jobid] [\--early-release]
-| [\--ignore-ipolicy] {-s} [\--disks *idx*] {*instance*}
+| [\--ignore-ipolicy] {-s} [\--disks *idx*] {*instance-name*}
| **replace-disks** [\--submit] [\--print-jobid] [\--early-release]
| [\--ignore-ipolicy]
-| {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* } {*instance*}
+| {{-I\|\--iallocator} *name* \| {{-n|\--new-secondary} *node* }
+| {*instance-name*}
| **replace-disks** [\--submit] [\--print-jobid] [\--early-release]
-| [\--ignore-ipolicy] {-a\|\--auto} {*instance*}
+| [\--ignore-ipolicy] {-a\|\--auto} {*instance-name*}
This command is a generalized form for replacing disks. It is
currently only valid for the mirrored (DRBD) disk template.
@@ -1834,7 +1835,7 @@ ACTIVATE-DISKS
^^^^^^^^^^^^^^
| **activate-disks** [\--submit] [\--print-jobid] [\--ignore-size]
-| [\--wait-for-sync] {*instance*}
+| [\--wait-for-sync] {*instance-name*}
Activates the block devices of the given instance. If successful, the
command will show the location and name of the block devices::
@@ -1872,7 +1873,7 @@ options.
DEACTIVATE-DISKS
^^^^^^^^^^^^^^^^
-**deactivate-disks** [-f] [\--submit] [\--print-jobid] {*instance*}
+**deactivate-disks** [-f] [\--submit] [\--print-jobid] {*instance-name*}
De-activates the block devices of the given instance. Note that if you
run this command for an instance with a drbd disk template, while it
@@ -1895,7 +1896,7 @@ GROW-DISK
| **grow-disk** [\--no-wait-for-sync] [\--submit] [\--print-jobid]
| [\--absolute]
-| {*instance*} {*disk*} {*amount*}
+| {*instance-name*} {*disk*} {*amount*}
Grows an instance's disk. This is only possible for instances having a
plain, drbd, file, sharedfile, rbd or ext disk template. For the ext
@@ -1954,7 +1955,8 @@ RECREATE-DISKS
| **recreate-disks** [\--submit] [\--print-jobid]
| [{-n node1:[node2] \| {-I\|\--iallocator *name*}}]
-| [\--disk=*N*[:[size=*VAL*][,spindles=*VAL*][,mode=*ro\|rw*]]] {*instance*}
+| [\--disk=*N*[:[size=*VAL*][,spindles=*VAL*][,mode=*ro\|rw*]]]
+| {*instance-name*}
Recreates all or a subset of disks of the given instance.
@@ -1998,7 +2000,7 @@ FAILOVER
| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*]
| [\--cleanup]
| [\--submit] [\--print-jobid]
-| {*instance*}
+| {*instance-name*}
Failover will stop the instance (if running), change its primary node,
and if it was originally running it will start it again (on the new
@@ -2058,9 +2060,9 @@ MIGRATE
| **migrate** [-f] [\--allow-failover] [\--non-live]
| [\--migration-mode=live\|non-live] [\--ignore-ipolicy] [\--ignore-hvversions]
| [\--no-runtime-changes] [\--submit] [\--print-jobid]
-| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance*}
+| [{-n|\--target-node} *node* \| {-I|\--iallocator} *name*] {*instance-name*}
-| **migrate** [-f] \--cleanup [\--submit] [\--print-jobid] {*instance*}
+| **migrate** [-f] \--cleanup [\--submit] [\--print-jobid] {*instance-name*}
Migrate will move the instance to its secondary node without shutdown.
As with failover, it works for instances having the drbd disk template
@@ -2156,7 +2158,7 @@ MOVE
| **move** [-f] [\--ignore-consistency]
| [-n *node*] [\--compress=*compression-mode*] [\--shutdown-timeout=*N*]
| [\--submit] [\--print-jobid] [\--ignore-ipolicy]
-| {*instance*}
+| {*instance-name*}
Move will move the instance to an arbitrary node in the cluster. This
works only for instances having a plain or file disk template.
@@ -2193,7 +2195,7 @@ CHANGE-GROUP
^^^^^^^^^^^^
| **change-group** [\--submit] [\--print-jobid]
-| [\--iallocator *NAME*] [\--to *GROUP*...] {*instance*}
+| [\--iallocator *name*] [\--to *group*...] {*instance-name*}
This command moves an instance to another node group. The move is
calculated by an iallocator, either given on the command line or as a
@@ -2218,7 +2220,7 @@ Tags
ADD-TAGS
^^^^^^^^
-**add-tags** [\--from *file*] {*instancename*} {*tag*...}
+**add-tags** [\--from *file*] {*instance-name*} {*tag*...}
Add tags to the given instance. If any of the tags contains invalid
characters, the entire operation will abort.
@@ -2232,14 +2234,14 @@ as stdin.
LIST-TAGS
^^^^^^^^^
-**list-tags** {*instancename*}
+**list-tags** {*instance-name*}
List the tags of the given instance.
REMOVE-TAGS
^^^^^^^^^^^
-**remove-tags** [\--from *file*] {*instancename*} {*tag*...}
+**remove-tags** [\--from *file*] {*instance-name*} {*tag*...}
Remove tags from the given instance. If any of the tags are not
existing on the node, the entire operation will abort.
diff --git a/man/gnt-job.rst b/man/gnt-job.rst
index ceb945325..7146dfc4f 100644
--- a/man/gnt-job.rst
+++ b/man/gnt-job.rst
@@ -23,7 +23,7 @@ COMMANDS
ARCHIVE
~~~~~~~
-**archive** {id...}
+**archive** {job-id...}
This command can be used to archive job by their IDs. Only jobs
that have finished execution (i.e either *success*, *error* or
@@ -60,8 +60,7 @@ CHANGE-PRIORITY
~~~~~~~~~~~~~~~
| **change-priority** \--priority {low | normal | high}
-| {[\--force] {\--pending | \--queued | \--waiting} |
-| *job-id* ...}
+| {[\--force] {\--pending | \--queued | \--waiting} | *job-id*...}
Changes the priority of one or multiple pending jobs. Jobs currently
running have only the priority of remaining opcodes changed.
@@ -72,7 +71,7 @@ includes both. To skip a confirmation, pass ``--force``.
INFO
~~~~
-**info** {*id*...}
+**info** {*job-id*...}
Show detailed information about the given job id(s). If no job id
is given, all jobs are examined (warning, this is a lot of
@@ -134,17 +133,17 @@ Lists available fields for jobs.
WAIT
~~~~~
-**wait** {id}
+**wait** {*job-id*}
-Wait for the job by the given *id* to finish; do not produce
+Wait for the job by the given *job-id* to finish; do not produce
any output.
WATCH
~~~~~
-**watch** {id}
+**watch** {(*job-id*}
-This command follows the output of the job by the given *id* and
+This command follows the output of the job by the given *job-id* and
prints it.
.. vim: set textwidth=72 :
diff --git a/man/gnt-network.rst b/man/gnt-network.rst
index bfac86ee8..36ee35087 100644
--- a/man/gnt-network.rst
+++ b/man/gnt-network.rst
@@ -34,15 +34,15 @@ ADD
~~~
| **add**
-| --network=*NETWORK*
-| [\--gateway=*GATEWAY*]
-| [\--add-reserved-ips=*RESERVEDIPS*]
-| [\--network6=*NETWORK6*]
-| [\--gateway6=*GATEWAY6*]
-| [\--mac-prefix=*MACPREFIX*]
+| --network=*network*
+| [\--gateway=*gateway*]
+| [\--add-reserved-ips=*reserved-ips*]
+| [\--network6=*network6*]
+| [\--gateway6=*gateway6*]
+| [\--mac-prefix=*macprefix*]
| [\--submit] [\--print-jobid]
| [\--no-conflicts-check]
-| {*network*}
+| {*network-name*}
Creates a new network with the given name. The network will be unused
initially. To connect it to a node group, use ``gnt-network connect``.
@@ -74,12 +74,12 @@ MODIFY
~~~~~~
| **modify**
-| [\--gateway=*GATEWAY*]
-| [\--add-reserved-ips=*RESERVEDIPS*]
-| [\--remove-reserved-ips=*RESERVEDIPS*]
-| [\--network6=*NETWORK6*]
-| [\--gateway6=*GATEWAY6*]
-| [\--mac-prefix=*MACPREFIX*]
+| [\--gateway=*gateway*]
+| [\--add-reserved-ips=*reserved-ips*]
+| [\--remove-reserved-ips=*reserved-ips*]
+| [\--network6=*network6*]
+| [\--gateway6=*gateway6*]
+| [\--mac-prefix=*macprefix*]
| [\--submit] [\--print-jobid]
| {*network*}
@@ -104,8 +104,8 @@ See **ganeti**\(7) for a description of ``--submit`` and
other common options.
LIST
~~~~
-| **list** [\--no-headers] [\--separator=*SEPARATOR*] [-v]
-| [-o *[+]FIELD,...*] [network...]
+| **list** [\--no-headers] [\--separator=*separator*] [-v]
+| [-o *[+]field,...*] [network-name...]
Lists all existing networks in the cluster. If no group names are given,
then all groups are included. Otherwise, only the named groups will be
@@ -175,7 +175,7 @@ Tags
ADD-TAGS
^^^^^^^^
-**add-tags** [\--from *file*] {*networkname*} {*tag*...}
+**add-tags** [\--from *file*] {*network*} {*tag*...}
Add tags to the given network. If any of the tags contains invalid
characters, the entire operation will abort.
@@ -189,14 +189,14 @@ stdin.
LIST-TAGS
^^^^^^^^^
-**list-tags** {*networkname*}
+**list-tags** {*network*}
List the tags of the given network.
REMOVE-TAGS
^^^^^^^^^^^
-**remove-tags** [\--from *file*] {*networkname*} {*tag*...}
+**remove-tags** [\--from *file*] {*network*} {*tag*...}
Remove tags from the given network. If any of the tags are not existing
on the network, the entire operation will abort.
diff --git a/man/gnt-node.rst b/man/gnt-node.rst
index 0940d7f8c..c6c4a336c 100644
--- a/man/gnt-node.rst
+++ b/man/gnt-node.rst
@@ -30,7 +30,7 @@ ADD
| [\--disk-state *diskstate*]
| [\--hypervisor-state *hvstate*]
| [\--no-node-setup]
-| {*nodename*}
+| {*node-name*}
Adds the given node to the cluster.
@@ -96,7 +96,7 @@ EVACUATE
~~~~~~~~
| **evacuate** [-f] [\--early-release] [\--submit] [\--print-jobid]
-| [{-I|\--iallocator} *NAME* \| {-n|\--new-secondary} *destination\_node*]
+| [{-I|\--iallocator} *name* \| {-n|\--new-secondary} *destination\_node*]
| [--ignore-soft-errors]
| [{-p|\--primary-only} \| {-s|\--secondary-only} ]
| {*node*}
@@ -200,7 +200,7 @@ LIST
| [\--no-headers] [\--separator=*SEPARATOR*]
| [\--units=*UNITS*] [-v] [{-o|\--output} *[+]FIELD,...*]
| [\--filter]
-| [node...]
+| [*node-name*...]
Lists the nodes in the cluster.
@@ -264,7 +264,7 @@ only the given nodes will be listed.
LIST-DRBD
~~~~~~~~~
-**list-drbd** [\--no-headers] [\--separator=*SEPARATOR*] node
+**list-drbd** [\--no-headers] [\--separator=*SEPARATOR*] *node*
Lists the mapping of DRBD minors for a given node. This outputs a static
list of fields (it doesn't accept the ``--output`` option), as follows:
@@ -337,7 +337,7 @@ MODIFY
| [\--node-powered=``yes|no``]
| [\--hypervisor-state *hvstate*]
| [\--disk-state *diskstate*]
-| {*node*}
+| {*node-name*}
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
@@ -381,7 +381,7 @@ Example (setting the node back to online and master
candidate)::
REMOVE
~~~~~~
-**remove** {*nodename*}
+**remove** {*node-name*}
Removes a node from the cluster. Instances must be removed or
migrated to another cluster before.
@@ -396,7 +396,7 @@ VOLUMES
| **volumes** [\--no-headers] [\--human-readable]
| [\--separator=*SEPARATOR*] [{-o|\--output} *FIELDS*]
-| [*node*...]
+| [*node-name*...]
Lists all logical volumes and their physical disks from the node(s)
provided.
@@ -450,7 +450,7 @@ LIST-STORAGE
| **list-storage** [\--no-headers] [\--human-readable]
| [\--separator=*SEPARATOR*] [\--storage-type=*STORAGE\_TYPE*]
| [{-o|\--output} *FIELDS*]
-| [*node*...]
+| [*node-name*...]
Lists the available storage units and their details for the given
node(s).
@@ -519,7 +519,7 @@ MODIFY-STORAGE
~~~~~~~~~~~~~~
| **modify-storage** [\--allocatable={yes|no}] [\--submit] [\--print-jobid]
-| {*node*} {*storage-type*} {*volume-name*}
+| {*node-name*} {*storage-type*} {*volume-name*}
Modifies storage volumes on a node. Only LVM physical volumes can
be modified at the moment. They have a storage type of "lvm-pv".
@@ -533,7 +533,7 @@ REPAIR-STORAGE
~~~~~~~~~~~~~~
| **repair-storage** [\--ignore-consistency] ]\--submit]
-| {*node*} {*storage-type*} {*volume-name*}
+| {*node-name*} {*storage-type*} {*volume-name*}
Repairs a storage volume on a node. Only LVM volume groups can be
repaired at this time. They have the storage type "lvm-vg".
@@ -558,7 +558,7 @@ Example::
POWERCYCLE
~~~~~~~~~~
-**powercycle** [\--yes] [\--force] [\--submit] [\--print-jobid] {*node*}
+**powercycle** [\--yes] [\--force] [\--submit] [\--print-jobid] {*node-name*}
This command (tries to) forcefully reboot a node. It is a command
that can be used if the node environment is broken, such that the
@@ -581,7 +581,7 @@ POWER
~~~~~
**power** [``--force``] [``--ignore-status``] [``--all``]
-[``--power-delay``] on|off|cycle|status [*nodes*]
+[``--power-delay``] on|off|cycle|status [*node-name*...]
This command calls out to out-of-band management to change the power
state of given node. With ``status`` you get the power status as reported
@@ -604,15 +604,15 @@ and continue with power off.
waited between powering on the next node. This is by default 2 seconds
but can increased if needed with this option.
-*nodes* are optional. If not provided it will call out for every node in
-the cluster. Except for the ``off`` and ``cycle`` command where you've
+The list of node names is optional. If not provided it will call out for every
+node in the cluster. Except for the ``off`` and ``cycle`` command where you've
to explicit use ``--all`` to select all.
HEALTH
~~~~~~
-**health** [*nodes*]
+**health** [*node-name*...]
This command calls out to out-of-band management to ask for the health status
of all or given nodes. The health contains the node name and then the items
@@ -626,7 +626,7 @@ RESTRICTED-COMMAND
~~~~~~~~~~~~~~~~~~
| **restricted-command** [-M] [\--sync]
-| { -g *group* *command* | *command* *nodes*... }
+| { -g *group* *command* | *command* *node-name*... }
Executes a restricted command on the specified nodes. Restricted commands are
not arbitrary, but must reside in
@@ -656,7 +656,7 @@ Tags
ADD-TAGS
^^^^^^^^
-**add-tags** [\--from *file*] {*nodename*} {*tag*...}
+**add-tags** [\--from *file*] {*node-name*} {*tag*...}
Add tags to the given node. If any of the tags contains invalid
characters, the entire operation will abort.
@@ -670,14 +670,14 @@ interpreted as stdin.
LIST-TAGS
^^^^^^^^^
-**list-tags** {*nodename*}
+**list-tags** {*node-name*}
List the tags of the given node.
REMOVE-TAGS
^^^^^^^^^^^
-**remove-tags** [\--from *file*] {*nodename*} {*tag*...}
+**remove-tags** [\--from *file*] {*node-name*} {*tag*...}
Remove tags from the given node. If any of the tags are not
existing on the node, the entire operation will abort.
diff --git a/man/gnt-os.rst b/man/gnt-os.rst
index 6ee82bd72..65c6df36c 100644
--- a/man/gnt-os.rst
+++ b/man/gnt-os.rst
@@ -46,12 +46,13 @@ are or are not valid.
INFO
~~~~
-**info**
+**info** {*OS*}
This command will list detailed information about each OS available
in the cluster, including its validity status, the supported API
versions, the supported parameters and variants (if any), and their
-documentation, etc.
+documentation, etc. If an *OS* name is given, then only the specified
+OS details will be shown.
Note that this command besides the information about the given OS(es),
shows detailed information about the given available/supported OS
--
2.11.0.390.gc69c2f50cf-goog
