NAME
netconfig - modular tool to modify network configuration
SYNOPSIS
netconfig modify
< -s | --service <service name> >
[ -i | --interface <interface name> ]
[ -l | --lease-file <file name> ]
[ -F | --input-format <lease/input file format> ]
[ -f | --force-replace ]
[ -v | --verbose ]
netconfig remove
< -i | --interface <interface name> >
< -s | --service <service name> >
[ -f | --force-replace ]
[ -v | --verbose ]
netconfig update
[ -f | --force-replace ]
[ -v | --verbose ]
netconfig < -h | --help >
DESCRIPTION
Netconfig is a modular tool to manage additional network configuration settings. It merges statically defined settings with settings provided by autoconfiguration mechanisms as dhcp or ppp according to a predefined policy and applies the required changes to the system by calling netconfig modules.
Each netconfig module is responsible to apply a set of changes for instance by writing of a configuration file and restarting a service or similar.
The netconfig tool knows three main actions:
| modify | Modify the current interface and service specific dynamic settings
and update the network configuration.
Netconfig reads these settings on its standard input or from the file specified by the --lease-file option and stores them internally until a system reboot or the next modify or remove action. Already existing settings for the same interface and service combination will be overwritten. See the MODIFY INPUT FORMAT section for input format description.
|
| remove | Removes the dynamic settings provided by a
modify action for the specified
interface and
service combination and update the network configuration.
|
| update | Update the network configuration using current settings. This is useful when
the policy or the static configuration changed.
|
The netconfig policy and the static configuration settings are defined in /etc/sysconfig/network/config variables by the administrator using YaST2, NetworkManager or manually as defined in NETCONFIG VARIABLES section.
The dynamic configuration settings provided by autoconfiguration tools as dhcp or ppp are delivered to netconfig directly by these tools with the modify and remove netconfig actions.
NETCONFIG VARIABLES
| NETCONFIG_MODULES_ORDER | |||||||||||||||
| This variable defines the start order of netconfig modules installed
in the /etc/netconfig.d/ directory.
To disable the execution of a module, don’t remove it from the list but prepend it with a minus sign, -ntp-runtime. | |||||||||||||||
| NETCONFIG_<set>_POLICY | |||||||||||||||
| Netconfig defines a merge policy variable for each set of network settings.
An empty policy variable disables any modifications in netconfig.
This variable lists the network interfaces, that netconfig has to consider as a valid source for this set of settings and in which order. Except of complete interface names, also basic wildcards to match multiple interfaces are allowed. For example, "eth* ppp?" will target first all eth and then all ppp0-\FIppp9 interfaces. There are two special predefined policy values which indicate how to apply the static settings defined in the corresponding NETCONFIG_<set>_STATIC_* variables:
By default, the policy is set to the special value auto. This special policy value is resolved by netconfig depending on the NETWORKMANAGER ("yes"/"no") variable:
| |||||||||||||||
DNS
| NETCONFIG_DNS_POLICY | |
| Defines the DNS merge policy. | |
| NETCONFIG_DNS_FORWARDER | |
| The type of the forwarder type to configure. Valid settings are "resolver", "bind" and "dnsmasq". The default setting is "resolver" activating the "dns-resolver" module. | |
| NETCONFIG_DNS_STATIC_SEARCHLIST | |
| List of DNS domain names used for host-name lookup. | |
| NETCONFIG_DNS_STATIC_SERVERS | |
| List of namserver IP addresses used for host-name lookup.
| |
NTP
| NETCONFIG_NTP_POLICY | |
| Defines the NTP merge policy. | |
| NETCONFIG_NTP_STATIC_SERVERS | |
| List of NTP server IP addresses.
| |
NIS
NETCONFIG_NIS_POLICY Defines the NIS / YP merge policy.
| NETCONFIG_NIS_STATIC_DOMAIN [ _<number> ] | |||||||||
| A NIS domain name. | |||||||||
| NETCONFIG_NIS_STATIC_SERVERS [ _<number> ] | |||||||||
| A list of NIS servers for the domain with same suffix number. | |||||||||
| NETCONFIG_NIS_SETDOMAINNAME | |||||||||
Defines whether to set the NIS domain using a setdomainname(2) call.
When enabled and the NIS domain is not provided dynamically or defined
in the static netconfig variables, the domain from /etc/defaultdomain
is used as fallback. Valid values are:
| |||||||||
NETCONFIG MODULES
| dns-resolver | |
| This module writes the DNS settings into the /etc/resolv.conf file.
When the NETCONFIG_DNS_FORWARDER variable is empty or set to "resolver", both, the domain search list and the nameserver list is written. Otherwise, only the domain search list is written - the nameservers has to be handled by the forwarder specific module, e.g. bind. | |
| dns-bind | |
| This module writes the DNS nameservers as forwarders for the bind nameserver into the /etc/named.d/forwarders.conf file. Please verify that this file is included in the options section of /etc/named.conf, like: options { #forward first; include "/etc/named.d/forwarders.conf"; # [...] You can use the yast2 dns-server module to configure bind as forwarder. | |
| dns-dnsmasq | |
| This module writes the DNS nameservers as forwarders for the dnsmasq nameserver into the /var/run/dnsmasq-forwarders.conf file. Please verify, that this file is set in the resolv-file keyword in the /etc/dnsmasq.conf. | |
| ntp-runtime | |
| The netconfig ntp-runtime module does not alter the /etc/ntp.conf file,
but makes use of NTP "runtime configuration".
The list of the NTP servers is written to the /var/run/ntp/servers-netconfig file and if the configuration changed meanwhile, the ntp service will be restarted using "rcntp try-restart". The ntp init script provides the functionality to apply the server list at runtime to the ntpd(1) daemon. | |
| nis | This module writes the NIS configuration into the /etc/ypconf file and
reloads the "ypbind" service when the configuration changed.
|
MODIFY INPUT FORMAT
The netconfig modify command expects a simple, single quoted, key-value parameter list in a dhcpcd info file compatible format. The keywords have to be usable as variable name in a shell (identifier). The keyword INTERFACE is mandatory. The currently considered key-value pairs are:
INTERFACE=’<interface name>’
IPADDR=’<IP address> [/<prefix length>]’
NETMASK=’<network mask>’
NETWORK=’<network address>’
BROADCAST=’<broadcast address>’
ROUTES=’<spaceseparatedlistofclasslessrouteentries>’ Each route entry consists of "network,netmask,router" addresses.
GATEWAYS=’<space separated list of gateway IP addresses>’
DNSSEARCH=’<space separated list of DNS domain names>’
DNSDOMAIN=’<DNS domain name>’
DNSSERVERS=’<space separated list of DNS nameserver addresses>’
NTPSERVERS=’<space separated list of ntp server addresses>’
NISDOMAIN=’<NIS domain name>’
NISSERVERS=’<list of server addresses for the NIS domain>’
NETBIOSNAMESERVER=’<list of netbios nameserver addresses>’
MODIFY VARIABLE EXAMPLES
See also the output of the dhcpcd-test <interface name> command. Following variables are used by the current netconfig modules:
DNS
DNSSEARCH=’example.net example.com’ DNSDOMAIN=’example.com’ DNSSERVERS=’192.168.0.10 192.168.0.20’
NTP
NTPSERVERS=’192.168.0.10 192.168.0.20’
NIS
NISDOMAIN=’example.com’ NISSERVERS=’192.168.0.20 192.168.0.10’
BUGS
Please report bugs at <http://www.suse.de/feedback>
AUTHORS
Michael Calmer <mc@suse.de>, Marius Tomaschewski <mt@suse.de>
SEE ALSO
ifcfg(5), /etc/sysconfig/network/config, /usr/share/doc/packages/sysconfig/README.netconfig
