Skip to end of metadata
Go to start of metadata


Just a list of available configuration options that can be used inside /usbkey/config

This page is a work-in-progress, and the information here should probably be refactored onto other pages.  Examples here aren't guaranteed to be accurate with current builds of SmartOS.

Additional NICs

The nic_tag can be any short alpha string to name the newly added NIC. The _mac line is optional. If not used, a randomly-generated mac address will be assigned to the instance on each boot.

There two predefined nic_tag's:

  • admin - is used for the private admin only network or as default NIC if only one interface is available
  • external - is used for connecting to the outer world


Key Value Description
headnode_default_gateway aaa.bbb.ccc.ddd The default gateway's IP-address
If this value is not set the admin_gateway is used
dns_resolvers aaa.bbb.ccc.ddd,aaa.bbb.ccc.ddd List of one or more nameservers separated by comma
dns_domain The default search domain
Can be any valid domain name
ntp_hosts List of one or more NTP servers separated by comma
This setting is only used if ntp_conf_file is not set
coal true Set up the GZ to NAT for Coal
This setting depends on two defined nic_tags admin and external and will use the configured networks to set up NAT for zones on the external NIC

Console / Login / SSH keys

Key Value Description
root_shadow <password-hash> Can be set to a password hash for the root user
This setting is only used if the boot parameter root_shadow is not set and the file /usbkey/shadow does not exist
default_keymap us This sets the default keycap for all local logins
Valid values/filenames can be found here: /usr/share/lib/keytables/type_6/
The list for lazy people: albania, arabia, belarus, belgium, brazil, bulgaria, canadian_bilingual, canadian_french, croatia, czech, denmark, dvorak, estonia, finnish, france, germany, greece, hungary, iceland, italy, japan, kbd_layouts, korea, latinamerica, latvia, lithuania, macedonia, maltauk, maltaus, netherlands, norway, poland, portugal, reset, romania, russia, serbiaandmontenegro, slovakia, slovenia, spain, sweden, swiss_french, swiss_german, traditional_chinese, turkeyf, turkeyq, uk, us

Including files

Files saved under /usbkey/ can be included. Key-value pairs in /usbkey/config are set to the path to the file relative to /usbkey/, and do not have default values. (See source code.)

Key Example Value Description
root_authorized_keys_file authorized_keys This file is copied to /root/.ssh/authorized_keys for public key authentication on login. The exact commands to set this up can be found on the SmartOS global zone tweaks blog post.
ntp_conf_file ntp.conf This file is copied to /etc/inet/ntp.conf and overrides the ntp_hosts variable


SDC only - I guess


These are not proved to work everywhere - they "work for me"

Single NIC with auto configured NAT

The used MAC addresses for admin_nic and external_nic can match. So this one physical NIC gets tagged as admin and external.

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Apr 28, 2012

    In the spirit of the first section "what the hell" is admin_network=...  ?

    It doesn't seem to have any info.

    1. Apr 29, 2012


      It's set during the initial configuration ... and used for nothing as it seems.

      1. Dec 27, 2012

        It is currently not used.

        Have a look at github

  2. Jun 04, 2012

    Is it possible to change the hostname and timezone?

  3. May 23, 2013

    I'm also perplexed about how to change the timezone in what we would consider the "global zone"  The only ways I can find on google don't persist across reboots so I figure the magic is either in /usbkey/config or maybe there is a way to do it with the PXE method.  Can someone shed some light please?

    1. Jan 28, 2014

      Use configuration managment (i.e. Chef) and have your cookbooks push out an updated .bash_profile for root including the TZ= line: