diff options
| author | dermotbradley <dermot_bradley@yahoo.com> | 2020-10-27 20:54:30 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-27 16:54:30 -0400 |
| commit | f50f635afe5da4e8971ec36719bdc9249cda2d0e (patch) | |
| tree | 97312df148ac47885485697075ef040188ef2513 /doc/rtd/topics/network-config-format-v2.rst | |
| parent | b8bd08194192035a13083539b31cbcaebfe4c577 (diff) | |
| download | vyos-cloud-init-f50f635afe5da4e8971ec36719bdc9249cda2d0e.tar.gz vyos-cloud-init-f50f635afe5da4e8971ec36719bdc9249cda2d0e.zip | |
Update network config docs to clarify MAC address quoting (#623)
Also update MAC addresses used in testcases to remove quotes where not
required and add single quotes where quotes are required.
Diffstat (limited to 'doc/rtd/topics/network-config-format-v2.rst')
| -rw-r--r-- | doc/rtd/topics/network-config-format-v2.rst | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/rtd/topics/network-config-format-v2.rst b/doc/rtd/topics/network-config-format-v2.rst index c93e29be..aa17bef5 100644 --- a/doc/rtd/topics/network-config-format-v2.rst +++ b/doc/rtd/topics/network-config-format-v2.rst @@ -94,7 +94,16 @@ NetworkManager does not. **macaddress**: *<(scalar)>* -Device's MAC address in the form "XX:XX:XX:XX:XX:XX". Globs are not allowed. +Device's MAC address in the form XX:XX:XX:XX:XX:XX. Globs are not allowed. + +.. note:: + + MAC addresses must be strings. As MAC addresses which consist of only the + digits 0-9 (i.e. no hex a-f) can be interpreted as a base 60 integer per + the `YAML 1.1 spec`_ it is best practice to quote all MAC addresses to ensure + they are parsed as strings regardless of value. + +.. _YAML 1.1 spec: https://yaml.org/type/int.html **driver**: *<(scalar)>* @@ -458,7 +467,7 @@ This is a complex example which shows most available features: :: # opaque ID for physical interfaces, only referred to by other stanzas id0: match: - macaddress: 00:11:22:33:44:55 + macaddress: '00:11:22:33:44:55' wakeonlan: true dhcp4: true addresses: |