code.grnet.gr Git - ganeti-local/blob - man/gnt-os.rst

   1 gnt-os(8) Ganeti | Version @GANETI_VERSION@
   2 ===========================================
   3
   4 Name
   5 ----
   6
   7 gnt-os - Instance operating system administration
   8
   9 Synopsis
  10 --------
  11
  12 **gnt-os** {command} [arguments...]
  13
  14 DESCRIPTION
  15 -----------
  16
  17 The **gnt-os** is used for managing the list of available operating
  18 system flavours for the instances in the Ganeti cluster.
  19
  20 COMMANDS
  21 --------
  22
  23 LIST
  24 ~~~~
  25
  26 **list** [\--no-headers]
  27
  28 Gives the list of available/supported OS to use in the instances.
  29 When creating the instance you can give the OS-name as an option.
  30
  31 Note that hidden or blacklisted OSes are not displayed by this
  32 command, use **diagnose** for showing those.
  33
  34 DIAGNOSE
  35 ~~~~~~~~
  36
  37 **diagnose**
  38
  39 This command will help you see why an installed OS is not available
  40 in the cluster. The **list** command shows only the OS-es that the
  41 cluster sees available on all nodes. It could be that some OS is
  42 missing from a node, or is only partially installed, and this
  43 command will show the details of all the OSes and the reasons they
  44 are or are not valid.
  45
  46 INFO
  47 ~~~~
  48
  49 **info**
  50
  51 This command will list detailed information about each OS available
  52 in the cluster, including its validity status, the supported API
  53 versions, the supported parameters (if any) and their
  54 documentations, etc.
  55
  56 MODIFY
  57 ~~~~~~
  58
  59 | **modify** [\--submit] [\--print-job-id]
  60 | [-H *HYPERVISOR*:option=*value*[,...]]
  61 | [\--hidden=*yes|no*] [\--blacklisted=*yes|no*]
  62 | {*OS*}
  63
  64 This command will allow you to modify OS parameters.
  65
  66 To modify the per-OS hypervisor parameters (which override the
  67 global hypervisor parameters), you can run modify ``-H`` with the
  68 same syntax as in **gnt-cluster init** to override default
  69 hypervisor parameters of the cluster for specified *OS* argument.
  70
  71 To modify the hidden and blacklisted states of an OS, pass the options
  72 ``--hidden ``*yes|no*, or respectively ``--blacklisted ...``. The
  73 'hidden' state means that an OS won't be listed by default in the OS
  74 list, but is available for installation. The 'blacklisted' state means
  75 that the OS is not listed and is also not allowed for new instance
  76 creations (but can be used for reinstalling old instances).
  77
  78 Note: The given operating system doesn't have to exist. This allows
  79 preseeding the settings for operating systems not yet known to
  80 **gnt-os**.
  81
  82 See **ganeti**\(7) for a description of ``--submit`` and other common
  83 options.
  84
  85 .. vim: set textwidth=72 :
  86 .. Local Variables:
  87 .. mode: rst
  88 .. fill-column: 72
  89 .. End: