libnm-core: improve documentation for ipv4.dhcp-client-id property

https://bugzilla.redhat.com/show_bug.cgi?id=1468358
(cherry picked from commit 4b51f5b1a8)
This commit is contained in:
Beniamino Galvani 2017-07-19 15:03:09 +02:00
parent 44c412d524
commit 8dc198d586

View file

@ -696,12 +696,20 @@ nm_setting_ip4_config_class_init (NMSettingIP4ConfigClass *ip4_class)
*
* A string sent to the DHCP server to identify the local machine which the
* DHCP server may use to customize the DHCP lease and options.
* When the property is a hex string ('aa:bb:cc') it is interpreted as a
* binary client ID, in which case the first byte is assumed to be the
* 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be
* an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet
* ARP type and the rest is a MAC address).
* If the property is not a hex string it is considered as a
* non-hardware-address client ID and the 'type' field is set to 0.
**/
/* ---ifcfg-rh---
* property: dhcp-client-id
* variable: DHCP_CLIENT_ID(+)
* description: A string sent to the DHCP server to identify the local machine.
* example: DHCP_CLIENT_ID=ax-srv-1
* A binary value can be specified using hex notation ('aa:bb:cc').
* example: DHCP_CLIENT_ID=ax-srv-1; DHCP_CLIENT_ID=01:44:44:44:44:44:44"
* ---end---
*/
g_object_class_install_property