====== Add request parameter ======

===== Synopsis =====

    param [--params <params>] [--header] <key> <value>

===== Examples =====

=== Issue an HTTP POST request ===

    params
    param mac ${net0/mac}
    param uuid ${uuid}
    param asset ${asset}
    chain http://boot.ipxe.org/demo/boot.php##params

=== Use a custom HTTP header ===

    params
    param --header Referer http://www.example.com
    chain http://boot.ipxe.org/demo/boot.php##params

===== Description =====

Add a request parameter with the specified key/value pair.  If no request parameter list is specified, the default (unnamed) request parameter list will be used.  If the ''--header'' option is specified then the parameter will be treated as a header parameter, otherwise the parameter will be treated as a form parameter.

===== Command status =====

^ Success   | The request parameter was successfully added          |
^ Failure   | The request parameter was not successfully added      |

===== See also =====

  * ''[[:cmd:params]]''
  * iPXE [[:scripting|scripting]] guide
  * [[:cmd|List of all iPXE commands]]

===== Build options =====

This command is available only when the build option ''[[:buildcfg:PARAM_CMD]]'' is enabled.

===== Notes =====

The most common use for request parameter lists is to generate HTTP POST requests.  You can generate a POST request by appending ''##params'' to the HTTP URI.  For example, to send a complete PCI device listing:

    #!ipxe
    
    params
    :pciscan pciscan addr || goto pciscan_done
      param pcidev ${pci/${addr}.0.2}:${pci/${addr}.2.2}
      goto pciscan
    :pciscan_done
    chain http://192.168.0.1/boot/pcilist.php##params

You must create the request parameter list using the ''[[:cmd:params]]'' command before attempting to create a request parameter using the ''param'' command.