101. Lan

Network card data

101.1. Summary of Module Globals

List of Global Functions

Add - Add a new device
AnyDHCPDevice - Check if any device except the current one is configured with DHCP. The current one is checked separately because there may be uncommitted changes. (#17391)
AutoPackages -
Autoinstall - Create a configuration for autoyast
Commit - Commit pending operation
Delete - Delete the given device
DriverType - For s390 hwinfo gives us a multitude of types but some are handled the same, mostly acording to the driver which is used. So let's group them under the name Driver Type.
Edit - Edit the given device
Export - Export data
FreeAliases - Return 10 free aliases
FreeDevices - Return 10 free devices
GetModified - Function which returns if the settings were modified
HasAliases - Check if the given device has any virtual alias.
HaveXenBridge - Xen bridging confuses us (#178848)
Import - Import data
Modified - Data was modified?
Overview - Create an overview table with all configured devices
Packages -
Propose - Propose a configuration
ProposeInterfaces - Propose interface configuration
ProposeRoutesAndResolver - Propose configuration for routing and resolver
Read - Read all network settings from the SCR
ReadWithCache - (a specialization used when a parameterless function is needed)
Select - Select the given device
SelectHW - Select the hardware component
SetDefaultsForHW - must be in sync with @ref GetDefaultsForHW
SetModified - Function sets internal variable, which indicates, that any settings were modified, to "true"
Summary - Create a textual summary and a list of unconfigured devices
SummaryIPv6 - Create a textual summary for the ipv6 proposal
SummaryNM - Create a textual summary for the NetworkManager proposal
UnsetModified - Function sets internal variable, which indicates, that any settings were modified, to "false"
Write - Update the SCR according to network settings
WriteOnly - Only write configuration without starting any init scripts and SuSEconfig

List of Global Variables

AbortFunction - Abort function return boolean return true if abort
hotplug - Hotplug type ("" if not hot pluggable)
operation - Which operation is pending?
wl_wpa_eap - wl_wpa_eap aggregates the settings in a map for easier CWM access.

101.2. Global Functions

101.2.1. Add

Add a new device

Return value

boolean - true if success

101.2.2. AnyDHCPDevice

Check if any device except the current one is configured with DHCP. The current one is checked separately because there may be uncommitted changes. (#17391)

Return value

boolean - true if any DHCP device except the current one is configured

101.2.3. AutoPackages

Return value

map - of packages needed when writing the config in autoinst mode

101.2.4. Autoinstall

Create a configuration for autoyast

Return value

boolean - true if something was proposed

101.2.5. Commit

Commit pending operation

Return value

boolean - true if success

101.2.6. Delete

Delete the given device

Function parameters

string name

Return value

boolean - true if success

101.2.7. DriverType

For s390 hwinfo gives us a multitude of types but some are handled the same, mostly acording to the driver which is used. So let's group them under the name Driver Type.

Function parameters

string type

Return value

string - driver type, like formerly type2 for s390

101.2.8. Edit

Edit the given device

Function parameters

string name

Return value

boolean - true if success

101.2.9. Export

Export data

Return value

map - dumped settings (later acceptable by Import())

101.2.10. FreeAliases

Return 10 free aliases

Function parameters

string type
integer num

Return value

list - of 10 free devices

101.2.11. FreeDevices

Return 10 free devices

Function parameters

string type

Return value

list - of 10 free devices

101.2.12. GetModified

Function which returns if the settings were modified

Return value

boolean - settings were modified

101.2.13. HasAliases

Check if the given device has any virtual alias.

Function parameters

string dev

Return value

boolean - true if there are some aliases

101.2.14. HaveXenBridge

Xen bridging confuses us (#178848)

Return value

boolean - whether xenbr* exists

101.2.15. Import

Import data

Function parameters

map settings

Return value

boolean - true on success

101.2.16. Modified

Data was modified?

Return value

boolean - true if modified

101.2.17. Overview

Create an overview table with all configured devices

Return value

list - table items

101.2.18. Packages

Return value

list<string> - of packages needed when writing the config

101.2.19. Propose

Propose a configuration

Return value

boolean - true if something was proposed

101.2.20. ProposeInterfaces

Propose interface configuration

Return value

boolean - true if something was proposed

101.2.21. ProposeRoutesAndResolver

Propose configuration for routing and resolver

Return value

boolean - true if something was proposed

101.2.22. Read

Read all network settings from the SCR

Function parameters

symbol cache

Return value

boolean - true on success

101.2.23. ReadWithCache

(a specialization used when a parameterless function is needed)

Return value

boolean - Read(`cache)

101.2.24. Select

Select the given device

Function parameters

string dev

Return value

boolean - true if success

101.2.25. SelectHW

Select the hardware component

Function parameters

integer which

Return value

void

101.2.26. SetDefaultsForHW

must be in sync with @ref GetDefaultsForHW

Return value

void

101.2.27. SetModified

Function sets internal variable, which indicates, that any settings were modified, to "true"

Return value

void

101.2.28. Summary

Create a textual summary and a list of unconfigured devices

Function parameters

string mode

Return value

list - summary of the current configuration

101.2.29. SummaryIPv6

Create a textual summary for the ipv6 proposal

Return value

list - [rich text, links]

101.2.30. SummaryNM

Create a textual summary for the NetworkManager proposal

Return value

list - [rich text, links]

101.2.31. UnsetModified

Function sets internal variable, which indicates, that any settings were modified, to "false"

Return value

void

101.2.32. Write

Update the SCR according to network settings

Return value

boolean - true on success

101.2.33. WriteOnly

Only write configuration without starting any init scripts and SuSEconfig

Return value

boolean - true on success

101.3. Global Variables

101.3.1. AbortFunction

Abort function return boolean return true if abort

101.3.2. hotplug

Hotplug type ("" if not hot pluggable)

101.3.3. operation

Which operation is pending?

101.3.4. wl_wpa_eap

wl_wpa_eap aggregates the settings in a map for easier CWM access.

wpa_eap
 WPA_EAP_MODE: string ("TTLS" "PEAP" or "TLS")
 WPA_EAP_IDENTITY: string
 WPA_EAP_PASSWORD: string (for TTLS and PEAP)
 WPA_EAP_ANONID: string (for TTLS and PEAP)
 WPA_EAP_CLIENT_CERT: string (for TLS, file name)
 WPA_EAP_CLIENT_KEY: string (for TLS, file name)
 WPA_EAP_CLIENT_KEY_PASSWORD: string (for TLS)
 WPA_EAP_CA_CERT: string (file name)
 WPA_EAP_AUTH: string ("", "MD5", "GTC", "CHAP"*, "PAP"*, "MSCHAP"*, "MSCHAPV2") (*: TTLS only)
 WPA_EAP_PEAP_VERSION: string ("", "0", "1")

101.4. Module Requirements

101.4.1. Module Imports

Arch
DNS
Detection
FileUtils
Host
Hostname
IP
Map
Mode
NetworkConfig
NetworkDevices
NetworkModules
NetworkService
NetworkStorage
Package
ProductFeatures
Progress
Routing
Service
String
SuSEFirewall4Network
Summary

101.4.2. Module Includes

network/complex.ycp
network/hardware.ycp
network/install.ycp
network/routines.ycp
network/runtime.ycp
network/runtime.ycp


100. Label		102. Language