..
    Warning: Do not edit this file. It is automatically generated from the
    software project's code and your changes will be overwritten.

    The tool to generate this file lives in openstack-doc-tools repository.

    Please make any changes needed in the code, then run the
    autogenerate-config-doc tool from the openstack-doc-tools repository, or
    ask for help on the documentation mailing list, IRC channel or meeting.

.. _ironic-pxe:

.. list-table:: Description of PXE configuration options
   :header-rows: 1
   :class: config-ref-table

   * - Configuration option = Default value
     - Description
   * - **[pxe]**
     -
   * - ``default_ephemeral_format`` = ``ext4``
     - (String) Default file system format for ephemeral partition, if one is created.
   * - ``image_cache_size`` = ``20480``
     - (Integer) Maximum size (in MiB) of cache for master images, including those in use.
   * - ``image_cache_ttl`` = ``10080``
     - (Integer) Maximum TTL (in minutes) for old master images in cache.
   * - ``images_path`` = ``/var/lib/ironic/images/``
     - (String) On the ironic-conductor node, directory where images are stored on disk.
   * - ``instance_master_path`` = ``/var/lib/ironic/master_images``
     - (String) On the ironic-conductor node, directory where master instance images are stored on disk. Setting to <None> disables image caching.
   * - ``ip_version`` = ``4``
     - (String) The IP version that will be used for PXE booting. Defaults to 4. EXPERIMENTAL
   * - ``ipxe_boot_script`` = ``$pybasedir/drivers/modules/boot.ipxe``
     - (String) On ironic-conductor node, the path to the main iPXE script file.
   * - ``ipxe_enabled`` = ``False``
     - (Boolean) Enable iPXE boot.
   * - ``ipxe_timeout`` = ``0``
     - (Integer) Timeout value (in seconds) for downloading an image via iPXE. Defaults to 0 (no timeout)
   * - ``ipxe_use_swift`` = ``False``
     - (Boolean) Download deploy images directly from swift using temporary URLs. If set to false (default), images are downloaded to the ironic-conductor node and served over its local HTTP server. Applicable only when 'ipxe_enabled' option is set to true.
   * - ``pxe_append_params`` = ``nofb nomodeset vga=normal``
     - (String) Additional append parameters for baremetal PXE boot.
   * - ``pxe_bootfile_name`` = ``pxelinux.0``
     - (String) Bootfile DHCP parameter.
   * - ``pxe_config_template`` = ``$pybasedir/drivers/modules/pxe_config.template``
     - (String) On ironic-conductor node, template file for PXE configuration.
   * - ``tftp_master_path`` = ``/tftpboot/master_images``
     - (String) On ironic-conductor node, directory where master TFTP images are stored on disk. Setting to <None> disables image caching.
   * - ``tftp_root`` = ``/tftpboot``
     - (String) ironic-conductor node's TFTP root path. The ironic-conductor must have read/write access to this path.
   * - ``tftp_server`` = ``$my_ip``
     - (String) IP address of ironic-conductor node's TFTP server.
   * - ``uefi_pxe_bootfile_name`` = ``bootx64.efi``
     - (String) Bootfile DHCP parameter for UEFI boot mode.
   * - ``uefi_pxe_config_template`` = ``$pybasedir/drivers/modules/pxe_grub_config.template``
     - (String) On ironic-conductor node, template file for PXE configuration for UEFI boot loader.