====== Settings reference ======

{{ :screenshots:config_ui.png?180x100|Interactive configuration tool}}

The following [[:settings]] are used by iPXE.  Settings may be displayed and modified using the [[:cmd:config|interactive configuration tool]], or using the ''[[:cmd:show]]'' and ''[[:cmd:set]]'' commands.

^ Network device settings                                                                |||
^ ''[[:cfg:mac]]''             | ([[:cfgtype:hex]])     | MAC address                      |
^ ''[[:cfg:bustype]]''         | ([[:cfgtype:string]])  | Bus type                         |
^ ''[[:cfg:busloc]]''          | ([[:cfgtype:uint32]])  | Bus location                     |
^ ''[[:cfg:busid]]''           | ([[:cfgtype:hex]])     | Bus ID                           |
^ ''[[:cfg:chip]]''            | ([[:cfgtype:string]])  | Chip type                        |
^ ''[[:cfg:ssid]]''            | ([[:cfgtype:string]])  | Wireless SSID                    |
^ ''[[:cfg:active-scan]]''     | ([[:cfgtype:int8]])    | Actively scan for wireless orks  |
^ ''[[:cfg:key]]''             | ([[:cfgtype:string]])  | Wireless encryption key          |
^                                                                                        |||
^ IPv4 settings                                                                          |||
^ ''[[:cfg:ip]]''              | ([[:cfgtype:ipv4]])    | IP address                       |
^ ''[[:cfg:netmask]]''         | ([[:cfgtype:ipv4]])    | Subnet mask                      |
^ ''[[:cfg:gateway]]''         | ([[:cfgtype:ipv4]])    | Default gateway                  |
^ ''[[:cfg:dns]]''             | ([[:cfgtype:ipv4]])    | DNS server                       |
^ ''[[:cfg:domain]]''          | ([[:cfgtype:string]])  | DNS domain                       |
^                                                                                        |||
^ Boot settings                                                                          |||
^ ''[[:cfg:filename]]''        | ([[:cfgtype:string]])  | Boot filename                    |
^ ''[[:cfg:next-server]]''     | ([[:cfgtype:ipv4]])    | TFTP server                      |
^ ''[[:cfg:root-path]]''       | ([[:cfgtype:string]])  | SAN root path                    |
^ ''[[:cfg:san-filename]]''    | ([[:cfgtype:string]])  | SAN filename                     |
^ ''[[:cfg:initiator-iqn]]''   | ([[:cfgtype:string]])  | iSCSI initiator name             |
^ ''[[:cfg:keep-san]]''        | ([[:cfgtype:int8]])    | Preserve SAN connection          |
^ ''[[:cfg:skip-san-boot]]''   | ([[:cfgtype:int8]])    | Do not boot from SAN device      |
^                                                                                        |||
^ Host settings                                                                          |||
^ ''[[:cfg:hostname]]''        | ([[:cfgtype:string]])  | Host name                        |
^ ''[[:cfg:uuid]]''            | ([[:cfgtype:uuid]])    | UUID                             |
^ ''[[:cfg:user-class]]''      | ([[:cfgtype:string]])  | DHCP user class                  |
^ ''[[:cfg:manufacturer]]''    | ([[:cfgtype:string]])  | Manufacturer                     |
^ ''[[:cfg:product]]''         | ([[:cfgtype:string]])  | Product name                     |
^ ''[[:cfg:serial]]''          | ([[:cfgtype:string]])  | Serial number                    |
^ ''[[:cfg:asset]]''           | ([[:cfgtype:string]])  | Asset tag                        |
^                                                                                        |||
^ Authentication settings                                                                |||
^ ''[[:cfg:username]]''        | ([[:cfgtype:string]])  | User name                        |
^ ''[[:cfg:password]]''        | ([[:cfgtype:string]])  | Password                         |
^ ''[[:cfg:reverse-username]]''  | ([[:cfgtype:string]])  | Reverse user name              |
^ ''[[:cfg:reverse-password]]''  | ([[:cfgtype:string]])  | Reverse password               |
^                                                                                        |||
^ Cryptography settings                                                                  |||
^ ''[[:cfg:crosscert]]''       | ([[:cfgtype:string]])  | Cross-signed certificate source  |
^ ''[[:cfg:trust]]''           | ([[:cfgtype:hex]])     | Trusted root certificate fingerprints  |
^ ''[[:cfg:cert]]''            | ([[:cfgtype:hex]])     | Client certificate               |
^ ''[[:cfg:privkey]]''         | ([[:cfgtype:hex]])     | Client private key               |
^                                                                                        |||
^ Miscellaneous settings                                                                 |||
^ ''[[:cfg:buildarch]]''       | ([[:cfgtype:string]])  | Build architecture               |
^ ''[[:cfg:cpumodel]]''        | ([[:cfgtype:string]])  | CPU model                        |
^ ''[[:cfg:cpuvendor]]''       | ([[:cfgtype:string]])  | CPU vendor                       |
^ ''[[:cfg:cwduri]]''          | ([[:cfgtype:string]])  | Current working directory URI    |
^ ''[[:cfg:cwuri]]''           | ([[:cfgtype:string]])  | Current working URI              |
^ ''[[:cfg:dhcp-server]]''     | ([[:cfgtype:ipv4]])    | DHCP server                      |
^ ''[[:cfg:keymap]]''          | ([[:cfgtype:string]])  | Keyboard layout                  |
^ ''[[:cfg:memsize]]''         | ([[:cfgtype:int32]])   | Memory size                      |
^ ''[[:cfg:platform]]''        | ([[:cfgtype:string]])  | Firmware platform                |
^ ''[[:cfg:priority]]''        | ([[:cfgtype:int8]])    | Settings priority                |
^ ''[[:cfg:scriptlet]]''       | ([[:cfgtype:string]])  | Boot scriptlet                   |
^ ''[[:cfg:syslog]]''          | ([[:cfgtype:ipv4]])    | Syslog server                    |
^ ''[[:cfg:syslogs]]''         | ([[:cfgtype:string]])  | Encrypted syslog server          |
^ ''[[:cfg:sysmac]]''          | ([[:cfgtype:hex]])     | System MAC address               |
^ ''[[:cfg:unixtime]]''        | ([[:cfgtype:uint32]])  | Seconds since the Epoch          |
^ ''[[:cfg:use-cached]]''      | ([[:cfgtype:uint8]])   | Use cached settings              |
^ ''[[:cfg:version]]''         | ([[:cfgtype:string]])  | iPXE version                     |
^ ''[[:cfg:vram]]''            | ([[:cfgtype:base64]])  | Video RAM contents               |