YaST2 Developers Documentation: Unknown YCP Module

Unknown YCP Module

This module has an unstable interface.

Imports

  • NetworkConfig
  • NetworkInterfaces
  • NetworkStorage
  • ProductFeatures

Includes

  • network/complex.ycp
  • network/hardware.ycp
  • network/lan/s390.ycp
  • network/lan/udev.ycp
  • network/routines.ycp

Structures

Global Variables

Global Functions

Local Functions

global Items -> map<integer, any>

Hardware information

See
ReadHardware
global modified -> boolean

Data was modified?

global operation -> symbol

Which operation is pending?

global wl_wpa_eap -> map<string, any>

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

Structure 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")
global GetLanItem (integer itemId) -> map

Returns configuration of item (see LanItems::Items) with given id.

Parameters:
itemId
global getCurrentItem () -> map

Returns configuration for currently modified item.

global IsItemConfigured (integer itemId) -> boolean

Returns true if the item (see LanItems::Items) has netconfig configuration.

Parameters:
itemId
global IsCurrentConfigured () -> boolean

Returns true if current (see LanItems::current) has configuration

global GetDeviceName (integer itemId) -> string

Returns device name for given lan item.

Parameters:
itemId
global GetCurrentName () -> string

Returns device name for current lan item (see LanItems::current)

global GetDeviceType (integer itemId) -> string

Returns device type for particular lan item

Parameters:
itemId
global GetDeviceMap (integer itemId) -> map< string, any>

Returns ifcfg configuration for particular item

Parameters:
itemId
global GetItemUdevRule (integer itemId) -> list< string>

Returns udev rule known for particular item

Parameters:
itemId
global GetModified () -> boolean

Function which returns if the settings were modified

Return value:
settings were modified
global SetModified () -> void

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

global UnsetModified () -> void

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

Info:

Searches map of known devices and decides if referenced lan item can be enslaved in a bond device

Parameters:
bondMaster name of master device
itemId index into LanItems::Items
Info:

Decides if given lan item can be enslaved in a bridge.

Parameters:
bridgeMaster name of master device
itemId index into LanItems::Items
global GetSlaveCandidates (string master) -> list< integer>

Iterates over all items and lists those for which given validator returns true.

Parameters:
master
Return value:
of lan item ids (see LanItems::Items)
global GetBondableInterfaces (string bondMaster) -> list< integer>

Creates list of items (interfaces) which can be used as a bond slave.

Parameters:
bondMaster bond device name
global GetBridgeableInterfaces (string bridgeMaster) -> list< integer>

Creates list of items (interfaces) which can be used as a bridge slave.

Parameters:
bridgeMaster bridge device name
global FindDeviceIndex (string device) -> integer

search all known devices to find it's index in Items array

Parameters:
device matched with item[ "hwinfo", "dev_name"]
Return value:
index in Items or -1 if not found
global GetBondSlaves (string bond_master) -> list<string>

Creates list of devices enslaved in any bond device.

Parameters:
bond_master
global Overview () -> list

Create an overview table with all configured devices

Return value:
table items
global isCurrentDHCP () -> boolean

Check if currently edited device gets its IP address from DHCP (v4, v6 or both)

Return value:
true if it is
global InterfaceHasAliases () -> boolean

Check if the given device has any virtual alias.

Return value:
true if there are some aliases
global SelectHWMap (map hardware) -> void

Select the hardware component

Parameters:
hardware
global SelectHW (integer which) -> void

Select the hardware component

Parameters:
which index of the component
global FreeDevices (string type) -> list

Return 10 free devices

Parameters:
type device type
Return value:
of 10 free devices
global FreeAliases (string type, integer num) -> list

Return 10 free aliases

Parameters:
type device type
num device number
Return value:
of 10 free devices
global GetDefaultsForHW () -> map

must be in sync with SetDefaultsForHW

global SetDefaultsForHW () -> void

must be in sync with GetDefaultsForHW

global SetDeviceVars (map devmap, map defaults) -> void

Set various device variables

Parameters:
devmap map with variables
defaults
local SetS390Vars (map devmap, map defaults) -> void

Initializes s390 specific device variables.

Parameters:
devmap map with s390 specific attributes and its values
defaults map with default values for attributes not found in devmap
global SysconfigDefaults -> map<string, string>

the defaults here are what sysconfig defaults to (as opposed to what a new interface gets, in Select)

Info:

Default values used when creating an emulated NIC for physical s390 hardware.

global Select (string dev) -> boolean

Select the given device

Parameters:
dev device to select ("" for new device, default values)
Return value:
true if success
global Commit () -> boolean

Commit pending operation

Return value:
true if success
global GetModuleForInterface (string ay_device, list<map> ay_modules) -> map

Get the module configuration for the modules configured in the interface section

Parameters:
ay_device Device, for example eth0
ay_modules list of modules from the AY profile
Return value:
the module map with module name and options
global FindMatchingDevice (map interface) -> map

Find matching device Find a device, optionally with some predefined values

Parameters:
interface interface map
Return value:
The map of the matching device.