2015-11-05 04:06:09 +03:00
|
|
|
# VMWare Guestinfo Interface
|
2015-09-22 14:30:30 +03:00
|
|
|
|
2015-11-05 04:06:09 +03:00
|
|
|
## Cloud-Config VMWare Guestinfo Variables
|
2015-05-19 01:22:50 +03:00
|
|
|
|
2015-11-05 04:06:09 +03:00
|
|
|
coreos-cloudinit accepts configuration from the VMware RPC API's *guestinfo*
|
|
|
|
facility. This datasource can be enabled with the `-from-vmware-guestinfo`
|
|
|
|
flag to coreos-cloudinit.
|
2015-05-19 01:22:50 +03:00
|
|
|
|
2015-11-05 04:06:09 +03:00
|
|
|
The following guestinfo variables are recognized and processed by cloudinit
|
|
|
|
when passed from the hypervisor to the virtual machine at boot time. Note that
|
|
|
|
property names are prefixed with `guestinfo.` in the VMX, e.g., `guestinfo.hostname`.
|
|
|
|
|
|
|
|
| guestinfo variable | type |
|
2015-05-19 01:22:50 +03:00
|
|
|
|:--------------------------------------|:--------------------------------|
|
|
|
|
| `hostname` | `hostname` |
|
|
|
|
| `interface.<n>.name` | `string` |
|
|
|
|
| `interface.<n>.mac` | `MAC address` |
|
|
|
|
| `interface.<n>.dhcp` | `{"yes", "no"}` |
|
|
|
|
| `interface.<n>.role` | `{"public", "private"}` |
|
|
|
|
| `interface.<n>.ip.<m>.address` | `CIDR IP address` |
|
|
|
|
| `interface.<n>.route.<l>.gateway` | `IP address` |
|
|
|
|
| `interface.<n>.route.<l>.destination` | `CIDR IP address` |
|
|
|
|
| `dns.server.<x>` | `IP address` |
|
|
|
|
| `coreos.config.data` | `string` |
|
|
|
|
| `coreos.config.data.encoding` | `{"", "base64", "gzip+base64"}` |
|
2015-09-04 04:05:22 +03:00
|
|
|
| `coreos.config.url` | `URL` |
|
2015-05-19 01:22:50 +03:00
|
|
|
|
|
|
|
Note: "n", "m", "l", and "x" are 0-indexed, incrementing integers. The
|
2015-11-05 04:06:09 +03:00
|
|
|
identifier for an `interface` does not correspond to anything outside of this
|
|
|
|
configuration; it serves only to distinguish between multiple `interface`s.
|
2015-09-22 14:30:30 +03:00
|
|
|
|
2015-11-05 04:06:09 +03:00
|
|
|
The guide to [booting on VMWare][bootvmware] is the starting point for more
|
|
|
|
information about configuring and running CoreOS on VMWare.
|
2015-09-22 14:30:30 +03:00
|
|
|
|
2015-11-05 04:06:09 +03:00
|
|
|
[bootvmware]: https://github.com/coreos/docs/blob/master/os/booting-on-vmware.md
|