..
    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.

.. _nova-pci:

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

   * - Configuration option = Default value
     - Description

   * - ``alias`` = ``[]``

     - (Multi-valued) An alias for a PCI passthrough device requirement.

       This allows users to specify the alias in the extra_spec for a flavor, without needing to repeat all the PCI property requirements.

       Possible Values:

       * A list of JSON values which describe the aliases. For example:

        alias = { "name": "QuickAssist", "product_id": "0443", "vendor_id": "8086", "device_type": "type-PCI" }

        defines an alias for the Intel QuickAssist card. (multi valued). Valid key values are :

       * "name": Name of the PCI alias.

       * "product_id": Product ID of the device in hexadecimal.

       * "vendor_id": Vendor ID of the device in hexadecimal.

       * "device_type": Type of PCI device. Valid values are: "type-PCI", "type-PF" and "type-VF".

   * - ``passthrough_whitelist`` = ``[]``

     - (Multi-valued) White list of PCI devices available to VMs.

       Possible values:

       * A JSON dictionary which describe a whitelisted PCI device. It should take the following format:

        ["vendor_id": "<id>",] ["product_id": "<id>",] ["address": "[[[[<domain>]:]<bus>]:][<slot>][.[<function>]]" | "devname": "<name>",] {"<tag>": "<tag_value>",}

        Where '[' indicates zero or one occurrences, '{' indicates zero or multiple occurrences, and '|' mutually exclusive options. Note that any missing fields are automatically wildcarded.

        Valid key values are :

       * "vendor_id": Vendor ID of the device in hexadecimal.

       * "product_id": Product ID of the device in hexadecimal.

       * "address": PCI address of the device.

       * "devname": Device name of the device (for e.g. interface name). Not all PCI devices have a name.

       * "<tag>": Additional <tag> and <tag_value> used for matching PCI devices. Supported <tag>: "physical_network".

        The address key supports traditional glob style and regular expression syntax. Valid examples are:

        passthrough_whitelist = {"devname":"eth0", "physical_network":"physnet"} passthrough_whitelist = {"address":"*:0a:00.*"} passthrough_whitelist = {"address":":0a:00.", "physical_network":"physnet1"} passthrough_whitelist = {"vendor_id":"1137", "product_id":"0071"} passthrough_whitelist = {"vendor_id":"1137", "product_id":"0071", "address": "0000:0a:00.1", "physical_network":"physnet1"} passthrough_whitelist = {"address":{"domain": ".*", "bus": "02", "slot": "01", "function": "[2-7]"}, "physical_network":"physnet1"} passthrough_whitelist = {"address":{"domain": ".*", "bus": "02", "slot": "0[1-2]", "function": ".*"}, "physical_network":"physnet1"}

        The following are invalid, as they specify mutually exclusive options:

        passthrough_whitelist = {"devname":"eth0", "physical_network":"physnet", "address":"*:0a:00.*"}

       * A JSON list of JSON dictionaries corresponding to the above format. For example:

        passthrough_whitelist = [{"product_id":"0001", "vendor_id":"8086"}, {"product_id":"0002", "vendor_id":"8086"}]