cpu-models.conf.adoc

   1 ifdef::manvolnum[]
   2 cpu-models.conf(5)
   3 ==================
   4 :pve-toplevel:
   5
   6 NAME
   7 ----
   8
   9 cpu-models.conf - Custom CPU model configuration file
  10
  11
  12 SYNOPSIS
  13 --------
  14
  15 '/etc/pve/virtual-guest/cpu-models.conf'
  16
  17
  18 DESCRIPTION
  19 -----------
  20 endif::manvolnum[]
  21
  22 ifndef::manvolnum[]
  23 Custom CPU Model Configuration
  24 ==============================
  25 endif::manvolnum[]
  26 ifdef::wiki[]
  27 :pve-toplevel:
  28 :title: Manual: cpu-models.conf
  29 endif::wiki[]
  30
  31 The `/etc/pve/virtual-guest/cpu-models.conf` file stores custom CPU
  32 models, which can be used by VMs to get access to advanced CPU
  33 features (for example custom CPU flags).
  34
  35
  36 File Format
  37 -----------
  38
  39 CPU models each have their own section in the file, beginning with
  40 the header:
  41
  42  cpu-model: <name>
  43
  44 Note that <name> does not include the 'custom-' prefix, which is
  45 required in VM configs to denote custom CPU models.
  46
  47 For example, if the <name> is 'foobar', the CPU for a VM would need to be
  48 configured as 'custom-foobar'.
  49
  50 Each section can specify several options. They are indented by either one TAB
  51 character or multiple spaces. Every option and its value is separated by one
  52 space, for example:
  53
  54  reported-model qemu64
  55
  56 See below for all available options.
  57
  58 Blank lines and those starting with a `#` are ignored.
  59
  60
  61 Options
  62 -------
  63
  64 include::cpu-models.conf.5-opts.adoc[]
  65
  66
  67 Example File
  68 ------------
  69
  70 ----
  71 cpu-model: avx
  72     flags +avx;+avx2
  73     phys-bits host
  74     hidden 0
  75     hv-vendor-id proxmox
  76     reported-model kvm64
  77 ----
  78
  79
  80 ifdef::manvolnum[]
  81 include::pve-copyright.adoc[]
  82 endif::manvolnum[]