YaST2 Developers Documentation: Unknown YCP Module
YaST

functions
files
intro

Unknown YCP Module

This module has an unstable interface.

Imports

  • Arch
  • Call
  • Confirm
  • IP
  • Map
  • Mode
  • Mode
  • Netmask
  • Netmask
  • NetworkInterfaces
  • NetworkService
  • Package
  • PackageSystem
  • Popup
  • Progress
  • String

Local Functions

Info:

File: include/network/routines.ycp Package: Network configuration Summary: Miscellaneous routines Authors: Michal Svec

local Abort () -> boolean

Abort function

Return value:
blah blah lahjk
local PollAbort () -> boolean

Check for pending Abort press

Return value:
true if pending abort
local ReallyAbort () -> boolean

If modified, ask for confirmation

Return value:
true if abort is confirmed
local ReallyAbortCond (boolean modified) -> boolean

If modified, ask for confirmation

Parameters:
modified true if modified
Return value:
true if abort is confirmed
local ProgressNextStage (string title) -> void

Progress::NextStage and Progress::Title combined into one function

Parameters:
title progressbar title
local ChangeWidgetIfExists (term id, symbol param, any value) -> void

Change UI widget only if it exists

Parameters:
id widget id
param widget parameter
value widget parameter value
local QueryWidgetIfExists (term id, symbol param, any value) -> any

Query UI widget only if it exists

Parameters:
id widget id
param widget parameter
value previous parameter value
Return value:
widget value if exists, previous value otherwise
local PackagesInstall (list<string> packages) -> symbol

Check if required packages are installed and install them if they're not

Parameters:
packages list of required packages (["rpm", "bash"])
Return value:
`next if packages installation is successfull, `abort otherwise
local ChangedComment (string modul) -> string

Create comment for changed file

Parameters:
modul YaST2 module changing the file
Return value:
comment
Example 
 ChangedComment("lan") -> # Changed by YaST2 module lan 1.1.2000"
local BusyPopup (string message) -> void

Show busy popup (for proposal)

Parameters:
message label to be shown
local BusyPopupClose () -> void

Close busy popup

See
BusyPopup
local list2items (list l, integer selected) -> list

Create a list of items for UI from the given list

Parameters:
l given list for conversion
selected selected item (0 for the first)
Return value:
a list of items
Example 
 [ "x", "y" ] -> [ `item(`id(0), "x"), `item(`id(1), "y") ]
local hwlist2items (list<map> l, integer selected) -> list

Create a list of items for UI from the given hardware list.

Parameters:
l given list for conversion
selected selected item (0 for the first)
Return value:
a list of items
local FinishPopup (boolean modified, string head, string text, string run, list params) -> symbol

Display the finished popup and possibly run another module. If not modified, don't do anything.

Parameters:
modified true if there are any modified data
head headline to be shown
text text to be shown
run module to be run
params parameters to pass to the module
Return value:
always `next
local DriverType (string type) -> string

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.

Parameters:
type a type, as in Lan::type
Return value:
driver type, like formerly type2 for s390
local DeviceName (map hwdevice) -> string

Extract the device 'name'

Parameters:
hwdevice hardware device
Return value:
name consisting of vendor and device name
local ValidNicName (string name) -> boolean

Validates given name for use as a nic name in sysconfig. See bnc#784952

Parameters:
name
local UsedNicName (string name) -> boolean

Checks if given nic name is used already.

Parameters:
name
local ControllerType (map hwdevice) -> string

Simple convertor from subclass to controller type.

Parameters:
hwdevice map with card info containing "subclass"
Return value:
short device name
Example 
 ControllerType() -> "eth"
local ReadHardware (string hwtype) -> list<map>

Read HW information

Parameters:
hwtype type of devices to read (netcard|modem|isdn)
Return value:
true if success
local RunAndRead (string command) -> map< string, any>

Parameters:
command
Return value:
Hash in form $[ "exit": , "output": [ <1st line>, <2nd line>, ... ] ]
local Run (string command) -> boolean

Parameters:
command
Return value:
whether command execution succeeds
local GetAllInterfaces () -> list<string>

Return list of all interfaces present in the system (not only configured ones as NetworkInterfaces::List does).

Return value:
of interface names.
local disableItemsIfNM (list<any> items, boolean show_popup) -> boolean

Check if we're running in "normal" stage with NM see bnc#433084 if listed any items, disable them, if show_popup, show warning popup

Parameters:
items
show_popup
YaST2 Developers Documentation